Function generate

code_generators/interp_generator.py:1364–1506

Called by `setup.py`, it produces the generated code required by the virual machine. Generated files are indicated by the ``*_GENERATED.cpp`` suffix. Parameters ---------- body_stub The stub C++ source that the operation table is inserted into. header_stub

(body_stub: str='interp_body_stub.cpp', header_stub: str='interp_header_stub.hpp', 
             blocksize: Tuple[int]=(4096, 32), bounds_check: bool=True, 
             mkl: bool=False, C11: bool=True)

    
def generate(body_stub: str='interp_body_stub.cpp', header_stub: str='interp_header_stub.hpp', 
             blocksize: Tuple[int]=(4096, 32), bounds_check: bool=True, 
             mkl: bool=False, C11: bool=True) -> Tuple[OrderedDict, OrderedDict, List]:
    """
    Called by `setup.py`, it produces the generated code required by the 
    virual machine.  Generated files are indicated by the ``*_GENERATED.cpp`` 
    suffix.

    Parameters
    ----------
    body_stub
        The stub C++ source that the operation table is inserted into.
    header_stub
        The stub C++ header that contains build-time specific macros, such as 
        the desired block size for calculations.
    blocksize
        The tuple defines the number of elements (**not bytes**) each blocked 
        operation loops over. The second integer is for reductions which are 
        not currently implemented.
    bounds_check
        whether the C-code should conduct bounds checks on each blocked operation.
        The speed penalty for bounds checking is trivial.
    mkl
        Whether to link to the Intel MKL vector math library. **Presently not 
        implemented.**
    C11
        whether to include functions generally only found in `cmath.h` in 
        C++11 compatible compilers.

    Returns
    -------
    pythonTable: OrderedDict
        The hash table (dictionary) that ``necompiler3.py`` uses to map Python 
        functions to codes for the virtual machine. The keys of `pythonTable` 
        are tuples of the form `(id: Union[str,ast.AST], library: int, *dtypes: str)`
        `id` is either a `str`, such as ``'sin'`` or it can also be an ast node,
        such as ``ast.Add``. The library is one of the LIB enum values. Dtypes
        is ``numpy.dtype.chars`` that represent the (arg1, arg2, arg3) 
        data types. The values of `pythonTable` are also tuples of the form 
        `(opcode: bytes, return_dtype: str)`.  This dictionary is written into
        a pickle file, ``lookup.pkl`` which is then packaged with the build.
    cTable: OrderedDict
        The cases for the jump table that the virtual machine, that is written 
        into `body_stub`. e.g. ``(349, 'case 349: arcsin_ff( task_size, pc, params ); break;\n'),``
    cFuncs: list
        The actual C-code for each function referenced in `cTable`, in order by
        op-code. This code is presently written into ``functions_GENERATED.cpp``.
    """
    global INTERP_HEADER_DEFINES, BLOCKSIZE
    
    # Set globals for passing blocksize to variables.
    # Not sure what blocksize[1] is actually used for in NumExpr2
    BLOCKSIZE = blocksize[0]
    
    INTERP_HEADER_DEFINES= "".join([INTERP_HEADER_DEFINES,
                             '#define BLOCK_SIZE1 {}\n'.format(blocksize[0]), 
                             '#define BLOCK_SIZE2 {}\n'.format(blocksize[1])])