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 SummaryFields 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 SummaryConstructors 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 SummaryAll 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.MultiThreadedHopgetMaxNumThreads, setMaxNumThreads
 - 
Methods inherited from class org.apache.sysds.hops.HopactivatePrefetch, 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- 
ParameterizedBuiltinOppublic 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 type
- vt- value type
- op- the ParamBuiltinOp
- inputParameters- map of input parameters
 
 
- 
 - 
Method Detail- 
checkAritypublic 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 class- Hop
 
 - 
getOpStringpublic String getOpString() - Specified by:
- getOpStringin class- Hop
 
 - 
getOppublic Types.ParamBuiltinOp getOp() 
 - 
setOutputPermutationMatrixpublic void setOutputPermutationMatrix(boolean flag) 
 - 
getTargetHoppublic Hop getTargetHop() 
 - 
isGPUEnabledpublic 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 class- Hop
- Returns:
- true if the Hop is eligible for GPU Exectype.
 
 - 
isMultiThreadedOpTypepublic boolean isMultiThreadedOpType() - Specified by:
- isMultiThreadedOpTypein class- MultiThreadedHop
 
 - 
constructLopspublic Lop constructLops() - Specified by:
- constructLopsin class- Hop
 
 - 
allowsAllExecTypespublic boolean allowsAllExecTypes() - Specified by:
- allowsAllExecTypesin class- Hop
 
 - 
refreshSizeInformationpublic void refreshSizeInformation() Description copied from class:HopUpdate the output size information for this hop.- Specified by:
- refreshSizeInformationin class- Hop
 
 - 
clonepublic Object clone() throws CloneNotSupportedException - Specified by:
- clonein class- Hop
- Throws:
- CloneNotSupportedException
 
 - 
isTransposeSafepublic 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 class- Hop
- Returns:
- always returns false
 
 - 
isCountFunctionpublic boolean isCountFunction() 
 - 
isKnownNGroupspublic boolean isKnownNGroups() 
 - 
isTargetDiagInputpublic boolean isTargetDiagInput() 
 - 
getParamservPseudoFunctionCallspublic List<FunctionOp> getParamservPseudoFunctionCalls() 
 
- 
 
-