org.nd4j.linalg.api.ops

Interface IndexAccumulation

All Superinterfaces:

Op

All Known Implementing Classes:

BaseIndexAccumulation, FirstIndex, IAMax, IAMin, IMax, IMin, LastIndex

public interface IndexAccumulation
extends Op

An index accumulation is an operation that returns an index within a NDArray.
Examples of IndexAccumulation operations include finding the index of the minimim value, index of the maximum value, index of the first element equal to value y, index of the maximum pair-wise difference between two NDArrays X and Y etc.
Index accumulation is similar to Accumulation in that both are accumulation/reduction operations, however index accumulation returns an integer corresponding to an index, rather than a real (or complex) value.
Index accumulation operations generally have 3 inputs:
x -> the origin ndarray
y -> the pairwise ndarray (frequently null/not applicable)
n -> the number of times to accumulate
Note that IndexAccumulation op implementations should be stateless (other than the final result and x/y/n arguments) and hence threadsafe, such that they may be parallelized using the update, combineSubResults and set/getFinalResults methods.

Nested Class Summary

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

Op.Type

Method Summary

Modifier and Type	Method and Description
int	getFinalResult() Get the final result of the IndexAccumulation
void	setFinalResult(int idx) Set the final index/result of the accumulation.
IComplexNumber	zeroComplex() Complex initial value
double	zeroDouble() Initial value for the index accumulation
float	zeroFloat() Initial value for the index accumulation.
float	zeroHalf() 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 interface org.nd4j.linalg.api.ops.Op

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

Method Detail

setFinalResult

void setFinalResult(int idx)

Set the final index/result of the accumulation.

getFinalResult

int getFinalResult()

Get the final result of the IndexAccumulation

zeroDouble

double zeroDouble()

Initial value for the index accumulation

Returns:

the initial value

zeroFloat

float zeroFloat()

Initial value for the index accumulation.

Returns:

the initial value

zeroHalf

float zeroHalf()

Initial value for the index accumulation.

Returns:

the initial value

zeroPair

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

The initial value and initial index to use for the accumulation

Returns:

zeroComplex

IComplexNumber zeroComplex()

Complex initial value

Returns:

the complex initial value