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 ReduceOp 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
INDArray	dimensions() This method returns dimensions for this op
Number	getFinalResult()
boolean	isKeepDims() This method returns TRUE if we're going to keep axis, FALSE otherwise
boolean	validateDataTypes()

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

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

Method Detail

validateDataTypes

boolean validateDataTypes()

isKeepDims

boolean isKeepDims()

This method returns TRUE if we're going to keep axis, FALSE otherwise

Returns:

dimensions

INDArray dimensions()

This method returns dimensions for this op

Returns:

getFinalResult

Number getFinalResult()