org.nd4j.linalg.api.ops

Class BaseIndexAccumulation

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseIndexAccumulation

All Implemented Interfaces:

IndexAccumulation, Op

Direct Known Subclasses:

IAMax, IMax, IMin

public abstract class BaseIndexAccumulation
extends BaseOp
implements IndexAccumulation

Field Summary

Fields

Modifier and Type	Field and Description
protected int	finalResult

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

extraArgs, n, numProcessed, passThrough, x, y, z

Constructor Summary

Constructors

Constructor and Description
BaseIndexAccumulation()
BaseIndexAccumulation(INDArray x)
BaseIndexAccumulation(INDArray x, INDArray y)
BaseIndexAccumulation(INDArray x, INDArray y, INDArray z, int n) Initialize with the given input, pairwise transform, result, and number of elements
BaseIndexAccumulation(INDArray x, INDArray y, int n)

Method Summary

Modifier and Type	Method and Description
int	combineSubResults(double first, int idxFirst, double second, int idxSecond) Combine sub-results, when the index accumulation is split and executed in parallel.
int	combineSubResults(float first, int idxFirst, float second, int idxSecond)
org.apache.commons.math3.util.Pair<Double,Integer>	combineSubResults(org.apache.commons.math3.util.Pair<Double,Integer> first, org.apache.commons.math3.util.Pair<Double,Integer> second)
int	getFinalResult() Get the final result of the IndexAccumulation
void	init(INDArray x, INDArray y, INDArray z, int n) Initialize the operation based on the parameters
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.
org.apache.commons.math3.util.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

ensureProperVectors, exec, exec, extraArgs, isPassThrough, n, numProcessed, setN, setX, setY, setZ, toString, x, y, z

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

update, update, update, update, update, update, update, update

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

exec, exec, extraArgs, isPassThrough, n, name, numProcessed, op, op, op, op, op, op, op, op, opForDimension, opForDimension, setN, setX, setY, setZ, x, y, z

Field Detail

finalResult

protected int finalResult

Constructor Detail

BaseIndexAccumulation

public BaseIndexAccumulation()

BaseIndexAccumulation

public BaseIndexAccumulation(INDArray x,
                             INDArray y,
                             INDArray z,
                             int 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,
                             int 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.apache.commons.math3.util.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:

zeroComplex

public IComplexNumber zeroComplex()

Description copied from interface: IndexAccumulation

Complex initial value

Specified by:

zeroComplex in interface IndexAccumulation

Returns:

the complex initial value

init

public void init(INDArray x,
                 INDArray y,
                 INDArray z,
                 int 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

combineSubResults

public int combineSubResults(double first,
                             int idxFirst,
                             double second,
                             int idxSecond)

Description copied from interface: IndexAccumulation

Combine sub-results, when the index accumulation is split and executed in parallel. Often this is the same as the update operations (i.e., when finding index of maximum value for example), but sometimes not.
Generally used internally by OpExecutors etc.

Specified by:

combineSubResults in interface IndexAccumulation

Parameters:

first - Value of one sub-accumulation (i.e., partial from one thread)

idxFirst - Index of the first value

second - Value of another sub-accumulation (i.e., partial accumulation from another thread)

idxSecond - Index of the second value

Returns:

Combined/accumulated index

combineSubResults

public int combineSubResults(float first,
                             int idxFirst,
                             float second,
                             int idxSecond)

Specified by:

combineSubResults in interface IndexAccumulation

See Also:

IndexAccumulation.combineSubResults(double, int, double, int)

combineSubResults

public org.apache.commons.math3.util.Pair<Double,Integer> combineSubResults(org.apache.commons.math3.util.Pair<Double,Integer> first,
                                                                            org.apache.commons.math3.util.Pair<Double,Integer> second)

Specified by:

combineSubResults in interface IndexAccumulation

See Also:

IndexAccumulation.combineSubResults(double, int, double, int)

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