Package org.apache.sysds.hops
Class ParameterizedBuiltinOp
- java.lang.Object
-
- org.apache.sysds.hops.Hop
-
- org.apache.sysds.hops.MultiThreadedHop
-
- org.apache.sysds.hops.ParameterizedBuiltinOp
-
- All Implemented Interfaces:
ParseInfo
public class ParameterizedBuiltinOp extends MultiThreadedHop
Defines the HOP for calling an internal function (with custom parameters) from a DML script.
-
-
Field Summary
Fields Modifier and Type Field Description static booleanFORCE_DIST_RM_EMPTY-
Fields inherited from class org.apache.sysds.hops.Hop
_beginColumn, _beginLine, _endColumn, _endLine, _filename, _text, CPThreshold
-
-
Constructor Summary
Constructors Constructor Description ParameterizedBuiltinOp(String l, Types.DataType dt, Types.ValueType vt, Types.ParamBuiltinOp op, LinkedHashMap<String,Hop> inputParameters)Creates a new HOP for a function call
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallowsAllExecTypes()voidcheckArity()Check whether this Hop has a correct number of inputs.Objectclone()booleancompare(Hop that)LopconstructLops()Types.ParamBuiltinOpgetOp()StringgetOpString()HopgetParameterHop(String name)HashMap<String,Integer>getParamIndexMap()List<FunctionOp>getParamservPseudoFunctionCalls()HopgetTargetHop()booleanisCountFunction()booleanisGPUEnabled()In memory-based optimizer mode (see OptimizerUtils.isMemoryBasedOptLevel()), the exectype is determined by checking this method as well as memory budget of this Hop.booleanisKnownNGroups()booleanisMultiThreadedOpType()booleanisTargetDiagInput()booleanisTransposeSafe()Defines if this operation is transpose-safe, which means that the result of op(input) is equivalent to op(t(input)).voidrefreshSizeInformation()Update the output size information for this hop.voidsetOutputPermutationMatrix(boolean flag)-
Methods inherited from class org.apache.sysds.hops.MultiThreadedHop
getMaxNumThreads, setMaxNumThreads
-
Methods inherited from class org.apache.sysds.hops.Hop
activatePrefetch, addAllInputs, addInput, checkAndSetForcedPlatform, checkAndSetInvalidCPDimsAndSize, clearMemEstimate, colsKnown, compressedSize, computeBoundsInformation, computeBoundsInformation, computeBoundsInformation, computeMemEstimate, computeSizeInformation, computeSizeInformation, computeSizeInformation, constructAndSetLopsDataFlowProperties, createOffsetLop, deactivatePrefetch, dimsKnown, dimsKnown, dimsKnownAny, federatedCostInitialized, getBeginColumn, getBeginLine, getBlocksize, getCompressedSize, getDataCharacteristics, getDataType, getDim, getDim1, getDim2, getEndColumn, getEndLine, getExecType, getFederatedCost, getFederatedOutput, getFilename, getForcedExecType, getHopID, getInput, getInput, getInputMemEstimate, getInputMemEstimate, getInputOutputSize, getIntermediateMemEstimate, getLength, getLops, getMemEstimate, getName, getNnz, getOutputMemEstimate, getOutputMemEstimate, getParent, getPrivacy, getRepetitions, getSparsity, getSpBroadcastSize, getText, getUpdateType, getValueType, hasCompressedInput, hasFederatedOutput, hasLocalOutput, hasMatrixInputWithDifferentBlocksizes, hasValidCPDimsAndSize, isCompressedOutput, isFederated, isFederatedDataOp, isMatrix, isMemEstimated, isOutputEmptyBlocks, isRequiredDecompression, isScalar, isVisited, prefetchActivated, printErrorLocation, refreshColsParameterInformation, refreshColsParameterInformation, refreshMemEstimates, refreshRowsParameterInformation, refreshRowsParameterInformation, requiresCheckpoint, requiresCompression, requiresLineageCaching, requiresReblock, requiresRecompile, resetExecType, resetFederatedCost, resetRecompilationFlag, resetRecompilationFlag, resetVisitStatus, resetVisitStatus, resetVisitStatus, resetVisitStatusForced, rowsKnown, setBeginColumn, setBeginLine, setBlocksize, setCompressedOutput, setCompressedSize, setDataType, setDim, setDim1, setDim2, setEndColumn, setEndLine, setExecType, setFederatedCost, setFederatedOutput, setFilename, setForcedExecType, setLops, setMemEstimate, setName, setNnz, setOutputEmptyBlocks, setParseInfo, setPrivacy, setRequiresCheckpoint, setRequiresCompression, setRequiresCompression, setRequiresDeCompression, setRequiresLineageCaching, setRequiresReblock, setRequiresRecompile, setText, setUpdateType, setValueType, setVisited, setVisited, someInputFederated, toString, updateLopFedOut, updateLopFedOut, updateRepetitionEstimates
-
-
-
-
Constructor Detail
-
ParameterizedBuiltinOp
public ParameterizedBuiltinOp(String l, Types.DataType dt, Types.ValueType vt, Types.ParamBuiltinOp op, LinkedHashMap<String,Hop> inputParameters)
Creates a new HOP for a function call- Parameters:
l- ?dt- data typevt- value typeop- the ParamBuiltinOpinputParameters- map of input parameters
-
-
Method Detail
-
checkArity
public void checkArity()
Description copied from class:HopCheck whether this Hop has a correct number of inputs. (Some Hops can have a variable number of inputs, such as DataOp, DataGenOp, ParameterizedBuiltinOp, ReorgOp, TernaryOp, QuaternaryOp, MultipleOp, DnnOp, and SpoofFusedOp.) Parameterized Hops (such as DataOp) can check that the number of parameters matches the number of inputs.- Specified by:
checkArityin classHop
-
getOpString
public String getOpString()
- Specified by:
getOpStringin classHop
-
getOp
public Types.ParamBuiltinOp getOp()
-
setOutputPermutationMatrix
public void setOutputPermutationMatrix(boolean flag)
-
getTargetHop
public Hop getTargetHop()
-
isGPUEnabled
public boolean isGPUEnabled()
Description copied from class:HopIn 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:
isGPUEnabledin classHop- Returns:
- true if the Hop is eligible for GPU Exectype.
-
isMultiThreadedOpType
public boolean isMultiThreadedOpType()
- Specified by:
isMultiThreadedOpTypein classMultiThreadedHop
-
constructLops
public Lop constructLops()
- Specified by:
constructLopsin classHop
-
allowsAllExecTypes
public boolean allowsAllExecTypes()
- Specified by:
allowsAllExecTypesin classHop
-
refreshSizeInformation
public void refreshSizeInformation()
Description copied from class:HopUpdate the output size information for this hop.- Specified by:
refreshSizeInformationin classHop
-
clone
public Object clone() throws CloneNotSupportedException
- Specified by:
clonein classHop- Throws:
CloneNotSupportedException
-
isTransposeSafe
public boolean isTransposeSafe()
Description copied from class:HopDefines if this operation is transpose-safe, which means that the result of op(input) is equivalent to op(t(input)). Usually, this applies to aggregate operations with fixed output dimension. Finally, this information is very useful in order to safely optimize the plan for sparse vectors, which otherwise would be (currently) always represented dense.- Overrides:
isTransposeSafein classHop- Returns:
- always returns false
-
isCountFunction
public boolean isCountFunction()
-
isKnownNGroups
public boolean isKnownNGroups()
-
isTargetDiagInput
public boolean isTargetDiagInput()
-
getParamservPseudoFunctionCalls
public List<FunctionOp> getParamservPseudoFunctionCalls()
-
-