org.nd4j.linalg.api.ops

Class BaseIndexAccumulation

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseIndexAccumulation

All Implemented Interfaces:

IndexAccumulation, Op

Direct Known Subclasses:

FirstIndex, IAMax, IAMin, IMax, IMin, LastIndex

public abstract class BaseIndexAccumulation
extends BaseOp
implements IndexAccumulation

Index based reduction algo

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 int	finalResult
protected boolean	keepDims
protected boolean	newFormat

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

extraArgs, extraArgz, n, numProcessed, passThrough, x, xVertexId, y, yVertexId, z, zVertexId

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

dimensions, inPlace, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor and Description
BaseIndexAccumulation()
BaseIndexAccumulation(INDArray x)
BaseIndexAccumulation(INDArray x, INDArray y)
BaseIndexAccumulation(INDArray x, INDArray y, INDArray z, long n) Initialize with the given input, pairwise transform, result, and number of elements
BaseIndexAccumulation(INDArray x, INDArray y, long n)
BaseIndexAccumulation(SameDiff sameDiff, SDVariable i_v, boolean keepDims, int[] dimensions)
BaseIndexAccumulation(SameDiff sameDiff, SDVariable i_v, SDVariable i_v2, boolean keepDims, int[] dimensions)

Method Summary

Modifier and Type	Method and Description
List<long[]>	calculateOutputShape() Calculate the output shape for this op
int	getFinalResult() Get the final result of the IndexAccumulation
void	init(INDArray x, INDArray y, INDArray z, long n) Initialize the operation based on the parameters
Op.Type	opType() The type of the op
void	setFinalResult(int idx) Set the final index/result of the accumulation.
double	zeroDouble() Initial value for the index accumulation
float	zeroFloat() Initial value for the index accumulation.
org.nd4j.linalg.primitives.Pair<Double,Integer>	zeroPair() The initial value and initial index to use for the accumulation

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

equals, exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, getOpType, hashCode, initFromOnnx, initFromTensorFlow, isExecSpecial, isPassThrough, n, numProcessed, outputVariables, setN, setX, setY, setZ, toCustomOp, toString, x, y, z

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

arg, arg, argNames, args, attributeAdaptersForFunction, configFieldName, diff, doDiff, dup, f, getNumOutputs, getValue, hasPlaceHolderInputs, isConfigProperties, larg, mappingsForFunction, onnxName, onnxNames, opName, opNum, outputVariable, outputVariables, outputVariablesNames, propertiesForFunction, rarg, 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.IndexAccumulation

zeroHalf

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

exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, isExecSpecial, isPassThrough, n, numProcessed, opName, opNum, setExtraArgs, setN, setX, setY, setZ, toCustomOp, x, y, z

Field Detail

finalResult

protected int finalResult

keepDims

protected boolean keepDims

newFormat

protected boolean newFormat

Constructor Detail

BaseIndexAccumulation

public BaseIndexAccumulation(SameDiff sameDiff,
                             SDVariable i_v,
                             boolean keepDims,
                             int[] dimensions)

BaseIndexAccumulation

public BaseIndexAccumulation(SameDiff sameDiff,
                             SDVariable i_v,
                             SDVariable i_v2,
                             boolean keepDims,
                             int[] dimensions)

BaseIndexAccumulation

public BaseIndexAccumulation()

BaseIndexAccumulation

public BaseIndexAccumulation(INDArray x,
                             INDArray y,
                             INDArray z,
                             long n)

Initialize with the given input, pairwise transform, result, and number of elements

Parameters:

x - the input

y - the pairwise transform

z - the result

n - the number of elements

BaseIndexAccumulation

public BaseIndexAccumulation(INDArray x,
                             INDArray y,
                             long n)

BaseIndexAccumulation

public BaseIndexAccumulation(INDArray x)

BaseIndexAccumulation

public BaseIndexAccumulation(INDArray x,
                             INDArray y)

Method Detail

zeroDouble

public double zeroDouble()

Description copied from interface: IndexAccumulation

Initial value for the index accumulation

Specified by:

zeroDouble in interface IndexAccumulation

Returns:

the initial value

zeroFloat

public float zeroFloat()

Description copied from interface: IndexAccumulation

Initial value for the index accumulation.

Specified by:

zeroFloat in interface IndexAccumulation

Returns:

the initial value

zeroPair

public org.nd4j.linalg.primitives.Pair<Double,Integer> zeroPair()

Description copied from interface: IndexAccumulation

The initial value and initial index to use for the accumulation

Specified by:

zeroPair in interface IndexAccumulation

Returns:

init

public void init(INDArray x,
                 INDArray y,
                 INDArray z,
                 long n)

Description copied from interface: Op

Initialize the operation based on the parameters

Specified by:

init in interface Op

Overrides:

init in class BaseOp

Parameters:

x - the input

y - the pairwise transform ndarray

z - the resulting ndarray

n - the number of elements

calculateOutputShape

public List<long[]> calculateOutputShape()

Description copied from class: DifferentialFunction

Calculate the output shape for this op

Overrides:

calculateOutputShape in class DifferentialFunction

Returns:

opType

public Op.Type opType()

Description copied from class: DifferentialFunction

The type of the op

Overrides:

opType in class DifferentialFunction

Returns:

setFinalResult

public void setFinalResult(int idx)

Description copied from interface: IndexAccumulation

Set the final index/result of the accumulation.

Specified by:

setFinalResult in interface IndexAccumulation

getFinalResult

public int getFinalResult()

Description copied from interface: IndexAccumulation

Get the final result of the IndexAccumulation

Specified by:

getFinalResult in interface IndexAccumulation