Class FunctionOp

  • All Implemented Interfaces:

    public class FunctionOp
    extends Hop
    This FunctionOp represents the call to a DML-bodied or external function. Note: Currently, we support expressions in function arguments along with function calls in expressions with single outputs, leaving multiple outputs handling as it is.
    • Method Detail

      • checkArity

        public void checkArity()
        FunctionOps may have any number of inputs.
        Specified by:
        checkArity in class Hop
      • getFunctionKey

        public String getFunctionKey()
      • getFunctionNamespace

        public String getFunctionNamespace()
      • getFunctionName

        public String getFunctionName()
      • setFunctionName

        public void setFunctionName​(String fname)
      • setFunctionNamespace

        public void setFunctionNamespace​(String fnamespace)
      • setInputVariableNames

        public void setInputVariableNames​(String[] names)
      • getInputVariableNames

        public String[] getInputVariableNames()
      • getOutputVariableNames

        public String[] getOutputVariableNames()
      • containsOutput

        public boolean containsOutput​(String varname)
      • setCallOptimized

        public void setCallOptimized​(boolean opt)
      • isPseudoFunctionCall

        public boolean isPseudoFunctionCall()
      • allowsAllExecTypes

        public boolean allowsAllExecTypes()
        Specified by:
        allowsAllExecTypes in class Hop
      • computeMemEstimate

        public void computeMemEstimate​(MemoTable memo)
        Description copied from class: Hop
        Computes the estimate of memory required to store the input/output of this hop in memory. This is the default implementation (orchestration of hop-specific implementation) that should suffice for most hops. If a hop requires more control, this method should be overwritten with awareness of (1) output estimates, and (2) propagation of worst-case matrix characteristics (dimensions, sparsity). TODO remove memo table and, on constructor refresh, inference in refresh, single compute mem, maybe general computeMemEstimate, flags to indicate if estimate or not.
        computeMemEstimate in class Hop
        memo - memory table
      • isGPUEnabled

        public boolean isGPUEnabled()
        Description copied from class: Hop
        In memory-based optimizer mode (see OptimizerUtils.isMemoryBasedOptLevel()), the exectype is determined by checking this method as well as memory budget of this Hop. Please see findExecTypeByMemEstimate for more detail. This method is necessary because not all operator are supported efficiently on GPU (for example: operations on frames and scalar as well as operations such as table).
        Specified by:
        isGPUEnabled in class Hop
        true if the Hop is eligible for GPU Exectype.
      • refreshSizeInformation

        public void refreshSizeInformation()
        Description copied from class: Hop
        Update the output size information for this hop.
        Specified by:
        refreshSizeInformation in class Hop
      • compare

        public boolean compare​(Hop that)
        Specified by:
        compare in class Hop