Function evaluate

numexpr3/ne3compiler.py:212–304

Evaluate a mutli-line expression element-wise, using NumPy broadcasting rules. This function is provided as a convience for porting code from `numexpr` 2.6 to the new release. In general new users are advised to use the :code:`NumExpr` class instead. Arguments ^^^^^^^^

(expr: str, name: str=None, lib: int=LIB_STD, 
             local_dict: Dict=None, global_dict: Dict=None, out: np.ndarray=None,
             order: str='K', casting: int=CAST_SAFE, optimization: int=OPT_MODERATE, 
             library: int=LIB_STD, checks: int=CHECK_ALL, stackDepth: int=1)

# TODO: implement non-default casting, optimization, library, checks
def evaluate(expr: str, name: str=None, lib: int=LIB_STD, 
             local_dict: Dict=None, global_dict: Dict=None, out: np.ndarray=None,
             order: str='K', casting: int=CAST_SAFE, optimization: int=OPT_MODERATE, 
             library: int=LIB_STD, checks: int=CHECK_ALL, stackDepth: int=1):
    '''
    Evaluate a mutli-line expression element-wise, using NumPy broadcasting 
    rules. This function is provided as a convience for porting code from 
    `numexpr` 2.6 to the new release. In general new users are advised to use 
    the :code:`NumExpr` class instead.  

    Arguments
    ^^^^^^^^^

    * :code:`expr`: expr is a string forming an expression, like :code:`c = 2*a + 3*b`.
        
      The values for :code:`a` and :code:`b` will by default be taken from the calling 
      function's frame (through use of :code:`sys._getframe()`). Alternatively, they 
      can be specifed using the :code:`local_dict` argument.
    
      Multi-line statements, or semi-colon seperated statements, are supported.

    Keyword Arguments
    ^^^^^^^^^^^^^^^^^

    :code:`name` : DEPRECATED
        use wisdom functions instead.
        
    :code:`local_dict` : dictionary, optional
        A dictionary that replaces the local operands in current frame. This is 
        generally required in Cython, as Cython does not populate the calling 
        frame variables according to Python standards.

    :code:`global_dict` : DEPRECATED
        A dictionary that replaces the global operands in current frame.
        Setting to {} can speed operations if you do not call globals.
        global_dict was deprecated as there is little reason for the 
        user to maintain two dictionaries of arrays.
        
    :code:`out` : DEPRECATED
        use assignment in expr (i.e. :code:`'out=a*b'`) instead.

    :code:`order:code:`: { :code:`'K'`}, optional
        Controls the iteration order for operands. Currently only :code:`'K'` 
        (default NumPy array ordering) is supported in NumExpr3.

    :code:`casting:code:` : {:code:`CAST_SAFE`|:code:`'safe'`}, optional 

        Controls what kind of data casting may occur when making a copy or
        buffering. Explicit cast functions are also supported, see the user guide.

    :code:`optimization`: {:code:`OPT_MODERATE`}, optional
        Controls what level of optimization the compiler will attempt to 
        perform on the expression to speed its execution. :code:`OPT_MODERATE` 
        performs simple optimizations, such as minimizing the number of temporary arrays
            
    :code:`library`: {:code:`LIB_STD`}, optional
        Indicates which library to use for calculations.  The library must 
        have been linked during the C-extension compilation, such that the