org.nd4j.linalg.api.ops

Class BaseScalarOp

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseScalarOp

All Implemented Interfaces:

Op, ScalarOp

Direct Known Subclasses:

LeakyReLU, LeakyReLUDerivative, LogX, Pow, PowDerivative, RectifiedLinear, Relu6, ReplaceNans, ScalarAdd, ScalarDivision, ScalarFMod, ScalarMax, ScalarMin, ScalarMultiplication, ScalarRemainder, ScalarReverseDivision, ScalarReverseSubtraction, ScalarSet, ScalarSetValue, ScalarSubtraction, Step

public abstract class BaseScalarOp
extends BaseOp
implements ScalarOp

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.ops.Op

Op.Type

Field Summary

Fields inherited from class org.nd4j.linalg.api.ops.BaseOp

dimensionz, extraArgz, x, xVertexId, y, yVertexId, z, zVertexId

Fields inherited from class org.nd4j.autodiff.functions.DifferentialFunction

dimensions, extraArgs, inPlace, ownName, ownNameSetWithDefault, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor and Description
BaseScalarOp()
BaseScalarOp(INDArray x, INDArray y, INDArray z, Number num)
BaseScalarOp(INDArray x, INDArray z, Number set)
BaseScalarOp(INDArray x, Number num)
BaseScalarOp(SameDiff sameDiff, SDVariable i_v, Number scalar)
BaseScalarOp(SameDiff sameDiff, SDVariable i_v, Number scalar, boolean inPlace)
BaseScalarOp(SameDiff sameDiff, @NonNull SDVariable i_v, Number scalar, boolean inPlace, Object[] extraArgs)
BaseScalarOp(SameDiff sameDiff, SDVariable i_v, Number scalar, Object[] extraArgs)

Method Summary

Modifier and Type	Method and Description
List<DataType>	calculateOutputDataTypes(List<DataType> dataTypes) Calculate the data types for the output arrays.
List<LongShapeDescriptor>	calculateOutputShape() Calculate the output shape for this op
List<LongShapeDescriptor>	calculateOutputShape(OpContext oc)
int[]	getDimension()
Op.Type	getOpType()
Op.Type	opType() The type of the op
INDArray	scalar() The normal scalar
void	setDimension(int... dimension)
void	setScalar(INDArray scalar)
void	setScalar(Number scalar) This method allows to set scalar
boolean	validateDataTypes(boolean experimentalMode)
INDArray	z() The resulting ndarray

Methods inherited from class org.nd4j.linalg.api.ops.BaseOp

clearArrays, defineDimensions, dimensions, equals, extraArgs, extraArgsBuff, extraArgsDataBuff, getFinalResult, getInputArgument, getNumOutputs, getOpType, hashCode, initFromOnnx, initFromTensorFlow, onnxName, outputVariables, setX, setY, setZ, tensorflowName, toCustomOp, toString, x, y

Methods inherited from class org.nd4j.autodiff.functions.DifferentialFunction

arg, arg, argNames, args, attributeAdaptersForFunction, configFieldName, diff, doDiff, dup, getValue, isConfigProperties, larg, mappingsForFunction, onnxNames, opName, opNum, outputs, outputVariable, outputVariables, outputVariablesNames, propertiesForFunction, rarg, replaceArg, setInstanceId, setPropertiesForFunction, setValueFor, tensorflowNames

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nd4j.linalg.api.ops.ScalarOp

dimensions

Methods inherited from interface org.nd4j.linalg.api.ops.Op

clearArrays, extraArgs, extraArgsBuff, extraArgsDataBuff, opName, opNum, setExtraArgs, setX, setY, setZ, toCustomOp, x, y

Constructor Detail

BaseScalarOp

public BaseScalarOp()

BaseScalarOp

public BaseScalarOp(INDArray x,
                    INDArray y,
                    INDArray z,
                    Number num)

BaseScalarOp

public BaseScalarOp(INDArray x,
                    Number num)

BaseScalarOp

public BaseScalarOp(INDArray x,
                    INDArray z,
                    Number set)

BaseScalarOp

public BaseScalarOp(SameDiff sameDiff,
                    SDVariable i_v,
                    Number scalar)

BaseScalarOp

public BaseScalarOp(SameDiff sameDiff,
                    SDVariable i_v,
                    Number scalar,
                    boolean inPlace)

BaseScalarOp

public BaseScalarOp(SameDiff sameDiff,
                    @NonNull
                    @NonNull SDVariable i_v,
                    Number scalar,
                    boolean inPlace,
                    Object[] extraArgs)

BaseScalarOp

public BaseScalarOp(SameDiff sameDiff,
                    SDVariable i_v,
                    Number scalar,
                    Object[] extraArgs)

Method Detail

z

public INDArray z()

Description copied from interface: Op

The resulting ndarray

Specified by:

z in interface Op

Overrides:

z in class BaseOp

Returns:

the resulting ndarray

calculateOutputShape

public List<LongShapeDescriptor> calculateOutputShape()

Description copied from class: DifferentialFunction

Calculate the output shape for this op

Overrides:

calculateOutputShape in class DifferentialFunction

Returns:

List of output shape descriptors

calculateOutputShape

public List<LongShapeDescriptor> calculateOutputShape(OpContext oc)

Overrides:

calculateOutputShape in class DifferentialFunction

opType

public Op.Type opType()

Description copied from class: DifferentialFunction

The type of the op

Overrides:

opType in class DifferentialFunction

Returns:

setScalar

public void setScalar(Number scalar)

Description copied from interface: ScalarOp

This method allows to set scalar

Specified by:

setScalar in interface ScalarOp

setScalar

public void setScalar(INDArray scalar)

Specified by:

setScalar in interface ScalarOp

scalar

public INDArray scalar()

Description copied from interface: ScalarOp

The normal scalar

Specified by:

scalar in interface ScalarOp

Returns:

the scalar

getDimension

public int[] getDimension()

Specified by:

getDimension in interface ScalarOp

setDimension

public void setDimension(int... dimension)

Specified by:

setDimension in interface ScalarOp

validateDataTypes

public boolean validateDataTypes(boolean experimentalMode)

Specified by:

validateDataTypes in interface ScalarOp

getOpType

public Op.Type getOpType()

Specified by:

getOpType in interface ScalarOp

calculateOutputDataTypes

public List<DataType> calculateOutputDataTypes(List<DataType> dataTypes)

Description copied from class: DifferentialFunction

Calculate the data types for the output arrays. Though datatypes can also be inferred from DifferentialFunction.calculateOutputShape(), this method differs in that it does not require the input arrays to be populated. This is important as it allows us to do greedy datatype inference for the entire net - even if arrays are not available.

Overrides:

calculateOutputDataTypes in class DifferentialFunction

Parameters:

dataTypes - The data types of the inputs

Returns:

The data types of the outputs