org.apache.sysds.hops

Class NaryOp

java.lang.Object

org.apache.sysds.hops.Hop

org.apache.sysds.hops.NaryOp

All Implemented Interfaces:

ParseInfo

public class NaryOp
extends Hop

The NaryOp Hop allows for a variable number of operands. Functionality such as 'printf' (overloaded into the existing print function) is an example of an operation that potentially takes a variable number of operands.

Field Summary

Fields inherited from class org.apache.sysds.hops.Hop

_beginColumn, _beginLine, _endColumn, _endLine, _filename, _text, CPThreshold

Constructor Summary

Constructors

Constructor and Description
NaryOp(String name, Types.DataType dataType, Types.ValueType valueType, Types.OpOpN op, Hop... inputs) NaryOp constructor.

Method Summary

Modifier and Type	Method and Description
boolean	allowsAllExecTypes()
void	checkArity() MultipleOp may have any number of inputs.
Object	clone()
boolean	compare(Hop that)
void	computeMemEstimate(MemoTable memo) Computes the estimate of memory required to store the input/output of this hop in memory.
Lop	constructLops() Construct the corresponding Lops for this Hop
Types.OpOpN	getOp()
String	getOpString()
boolean	isGPUEnabled() In memory-based optimizer mode (see OptimizerUtils.isMemoryBasedOptLevel()), the exectype is determined by checking this method as well as memory budget of this Hop.
void	refreshSizeInformation() Update the output size information for this hop.

Methods inherited from class org.apache.sysds.hops.Hop

addAllInputs, addInput, checkAndSetForcedPlatform, checkAndSetInvalidCPDimsAndSize, clearMemEstimate, colsKnown, computeBoundsInformation, computeBoundsInformation, computeBoundsInformation, computeSizeInformation, computeSizeInformation, computeSizeInformation, constructAndSetLopsDataFlowProperties, createOffsetLop, dimsKnown, dimsKnown, dimsKnownAny, getBeginColumn, getBeginLine, getBlocksize, getDataCharacteristics, getDataType, getDim, getDim1, getDim2, getEndColumn, getEndLine, getExecType, getFilename, getForcedExecType, getHopID, getInput, getInputMemEstimate, getInputOutputSize, getIntermediateMemEstimate, getLength, getLops, getMemEstimate, getName, getNnz, getOutputMemEstimate, getParent, getPrivacy, getSparsity, getSpBroadcastSize, getText, getUpdateType, getValueType, hasMatrixInputWithDifferentBlocksizes, hasValidCPDimsAndSize, isMatrix, isMemEstimated, isOutputEmptyBlocks, isScalar, isTransposeSafe, isVisited, printErrorLocation, refreshColsParameterInformation, refreshColsParameterInformation, refreshMemEstimates, refreshRowsParameterInformation, refreshRowsParameterInformation, requiresCheckpoint, requiresCompression, requiresLineageCaching, requiresReblock, requiresRecompile, resetExecType, resetRecompilationFlag, resetRecompilationFlag, resetVisitStatus, resetVisitStatus, resetVisitStatus, resetVisitStatusForced, rowsKnown, setBeginColumn, setBeginLine, setBlocksize, setDataType, setDim, setDim1, setDim2, setEndColumn, setEndLine, setFilename, setForcedExecType, setLops, setMemEstimate, setName, setNnz, setOutputEmptyBlocks, setParseInfo, setPrivacy, setRequiresCheckpoint, setRequiresCompression, setRequiresLineageCaching, setRequiresReblock, setRequiresRecompile, setText, setUpdateType, setValueType, setVisited, setVisited

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sysds.parser.ParseInfo

ctxAndFilenameToParseInfo

Constructor Detail

NaryOp

public NaryOp(String name,
              Types.DataType dataType,
              Types.ValueType valueType,
              Types.OpOpN op,
              Hop... inputs)

NaryOp constructor.

Parameters:

name - the target name, typically set by the DMLTranslator when constructing Hops. (For example, 'parsertemp1'.)

dataType - the target data type (SCALAR for printf)

valueType - the target value type (STRING for printf)

op - the operation type (such as PRINTF)

inputs - a variable number of input Hops

Method Detail

checkArity

public void checkArity()

MultipleOp may have any number of inputs.

Specified by:

checkArity in class Hop

getOp

public Types.OpOpN getOp()

getOpString

public String getOpString()

Specified by:

getOpString in class Hop

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

Returns:

true if the Hop is eligible for GPU Exectype.

constructLops

public Lop constructLops()

Construct the corresponding Lops for this Hop

Specified by:

constructLops in class Hop

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.

Overrides:

computeMemEstimate in class Hop

Parameters:

memo - memory table

refreshSizeInformation

public void refreshSizeInformation()

Description copied from class: Hop

Update the output size information for this hop.

Specified by:

refreshSizeInformation in class Hop

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in class Hop

Throws:

CloneNotSupportedException

compare

public boolean compare(Hop that)

Specified by:

compare in class Hop