org.nd4j.linalg.api.ops

Class BaseOp

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.BaseOp

All Implemented Interfaces:

Op

Direct Known Subclasses:

BaseBroadcastBoolOp, BaseBroadcastOp, BaseGridOp, BaseIndexAccumulation, BaseRandomOp, BaseReduceOp, BaseScalarBoolOp, BaseScalarOp, BaseTransformOp

public abstract class BaseOp
extends DifferentialFunction
implements Op

Base op. An op involves iterating over 2 buffers (x,y) up to n elements and applying a transform or accumulating a result.

Author:

Adam Gibson

Nested Class Summary

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

Op.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected INDArray	dimensionz
protected DataBuffer	extraArgz
protected INDArray	x
protected String	xVertexId
protected INDArray	y
protected String	yVertexId
protected INDArray	z
protected String	zVertexId

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

dimensions, extraArgs, inPlace, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor and Description
BaseOp()
BaseOp(INDArray x) An op for one ndarray
BaseOp(INDArray x, INDArray z) Specify an alternative result array
BaseOp(INDArray x, INDArray y, INDArray z)
BaseOp(SameDiff sameDiff, boolean inPlace, Object[] extraArgs)
BaseOp(SameDiff sameDiff, Object[] extraArgs)

Method Summary

Modifier and Type	Method and Description
protected void	defineDimensions(int... dimensions)
INDArray	dimensions()
boolean	equals(Object o)
Object[]	extraArgs() Extra arguments
Buffer	extraArgsBuff() Returns a buffer of either float or double of the extra args for this buffer
DataBuffer	extraArgsDataBuff(DataType dtype) Returns the extra args as a data buffer
Number	getFinalResult()
int	getNumOutputs()
static Op.Type	getOpType(Op op)
int	hashCode()
void	initFromOnnx(Onnx.NodeProto node, SameDiff initWith, Map<String,Onnx.AttributeProto> attributesForNode, Onnx.GraphProto graph) Iniitialize the function from the given Onnx.NodeProto
void	initFromTensorFlow(NodeDef nodeDef, SameDiff initWith, Map<String,AttrValue> attributesForNode, GraphDef graph) Initialize the function from the given NodeDef
SDVariable[]	outputVariables(String baseName) Return the output functions for this differential function.
void	setX(INDArray x) set x (the input ndarray)
void	setY(INDArray y) set y(the pairwise ndarray)
void	setZ(INDArray z) set z (the solution ndarray)
CustomOp	toCustomOp() Converts this op to be a CustomOp A CustomOp is a more flexible op meant for multiple inputs and outputs.
String	toString()
INDArray	x() The origin ndarray
INDArray	y() The pairwise op ndarray
INDArray	z() The resulting ndarray

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

arg, arg, argNames, args, attributeAdaptersForFunction, calculateOutputDataTypes, calculateOutputShape, configFieldName, diff, doDiff, dup, f, getValue, isConfigProperties, larg, mappingsForFunction, onnxName, onnxNames, opName, opNum, opType, outputVariable, outputVariables, outputVariablesNames, propertiesForFunction, rarg, replaceArg, resolvePropertiesFromSameDiffBeforeExecution, setInstanceId, setPropertiesForFunction, setValueFor, tensorflowName, 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.Op

opName, opNum, setExtraArgs

Field Detail

x

protected INDArray x

y

protected INDArray y

z

protected INDArray z

xVertexId

protected String xVertexId

yVertexId

protected String yVertexId

zVertexId

protected String zVertexId

extraArgz

protected DataBuffer extraArgz

dimensionz

protected INDArray dimensionz

Constructor Detail

BaseOp

public BaseOp()

BaseOp

public BaseOp(SameDiff sameDiff,
              boolean inPlace,
              Object[] extraArgs)

BaseOp

public BaseOp(SameDiff sameDiff,
              Object[] extraArgs)

BaseOp

public BaseOp(INDArray x,
              INDArray z)

Specify an alternative result array

Parameters:

x - the input

z - the output array

BaseOp

public BaseOp(INDArray x,
              INDArray y,
              INDArray z)

BaseOp

public BaseOp(INDArray x)

An op for one ndarray

Parameters:

x - the ndarray

Method Detail

getOpType

public static Op.Type getOpType(Op op)

initFromTensorFlow

public void initFromTensorFlow(NodeDef nodeDef,
                               SameDiff initWith,
                               Map<String,AttrValue> attributesForNode,
                               GraphDef graph)

Description copied from class: DifferentialFunction

Initialize the function from the given NodeDef

Specified by:

initFromTensorFlow in class DifferentialFunction

initFromOnnx

public void initFromOnnx(Onnx.NodeProto node,
                         SameDiff initWith,
                         Map<String,Onnx.AttributeProto> attributesForNode,
                         Onnx.GraphProto graph)

Description copied from class: DifferentialFunction

Iniitialize the function from the given Onnx.NodeProto

Specified by:

initFromOnnx in class DifferentialFunction

extraArgsDataBuff

public DataBuffer extraArgsDataBuff(DataType dtype)

Description copied from interface: Op

Returns the extra args as a data buffer

Specified by:

extraArgsDataBuff in interface Op

Returns:

extraArgsBuff

public Buffer extraArgsBuff()

Description copied from interface: Op

Returns a buffer of either float or double of the extra args for this buffer

Specified by:

extraArgsBuff in interface Op

Returns:

a buffer of either opType float or double representing the extra args for this op

setX

public void setX(INDArray x)

Description copied from interface: Op

set x (the input ndarray)

Specified by:

setX in interface Op

setZ

public void setZ(INDArray z)

Description copied from interface: Op

set z (the solution ndarray)

Specified by:

setZ in interface Op

setY

public void setY(INDArray y)

Description copied from interface: Op

set y(the pairwise ndarray)

Specified by:

setY in interface Op

extraArgs

public Object[] extraArgs()

Description copied from interface: Op

Extra arguments

Specified by:

extraArgs in interface Op

Returns:

the extra arguments

x

public INDArray x()

Description copied from interface: Op

The origin ndarray

Specified by:

x in interface Op

Returns:

the origin ndarray

y

public INDArray y()

Description copied from interface: Op

The pairwise op ndarray

Specified by:

y in interface Op

Returns:

the pairwise op ndarray

z

public INDArray z()

Description copied from interface: Op

The resulting ndarray

Specified by:

z in interface Op

Returns:

the resulting ndarray

outputVariables

public SDVariable[] outputVariables(String baseName)

Description copied from class: DifferentialFunction

Return the output functions for this differential function.

Specified by:

outputVariables in class DifferentialFunction

Returns:

toString

public String toString()

Overrides:

toString in class Object

toCustomOp

public CustomOp toCustomOp()

Description copied from interface: Op

Converts this op to be a CustomOp A CustomOp is a more flexible op meant for multiple inputs and outputs. The default implementation in BaseOp converts a simple op to a multi input/output operation by mapping the x and y on to inputs , the op opName and the z on to outputs.

Specified by:

toCustomOp in interface Op

Returns:

the equivalent CustomOp

equals

public boolean equals(Object o)

Overrides:

equals in class DifferentialFunction

hashCode

public int hashCode()

Overrides:

hashCode in class DifferentialFunction

defineDimensions

protected void defineDimensions(int... dimensions)

dimensions

public INDArray dimensions()

getFinalResult

public Number getFinalResult()

getNumOutputs

public int getNumOutputs()

Overrides:

getNumOutputs in class DifferentialFunction