org.nd4j.linalg.api.ops.impl.indexaccum

Class IMax

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseIndexAccumulation

org.nd4j.linalg.api.ops.impl.indexaccum.IMax

All Implemented Interfaces:

IndexAccumulation, Op

public class IMax
extends BaseIndexAccumulation

Calculate the index of max value over a vector

Author:

Alex Black

Field Summary

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

finalResult

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

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

Constructor Summary

Constructors

Constructor and Description
IMax()
IMax(INDArray x)
IMax(INDArray x, INDArray y)
IMax(INDArray x, INDArray y, long n)

Method Summary

Modifier and Type	Method and Description
String	name() The name of this operation
double	op(double origin) Transform an individual element
double	op(double origin, double other) Pairwise op (applicable with an individual element in y)
float	op(float origin) Transform an individual element
float	op(float origin, float other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin) Transform an individual element
IComplexNumber	op(IComplexNumber origin, double other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin, float other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin, IComplexNumber other) Pairwise op (applicable with an individual element in y)
Op	opForDimension(int index, int... dimension) A copy of this operation for a particular dimension of the input
Op	opForDimension(int index, int dimension) A copy of this operation for a particular dimension of the input
int	opNum() An op number
int	update(double accum, int accumIdx, double x, double y, int idx) Do one accumulation update for a pair-wise (2 input) index accumulation
int	update(double accum, int accumIdx, double x, int xIdx) Do one accumulation update.
int	update(float accum, int accumIdx, float x, float y, int idx)
int	update(float accum, int accumIdx, float x, int xIdx)
int	update(IComplexNumber accum, int accumIdx, double x, double y, int idx) Accumulation update for pairswise (2 input) complex numbers.
int	update(IComplexNumber accum, int accumIdx, double x, int idx) Accumulation update for complex numbers.
int	update(IComplexNumber accum, int accumIdx, IComplexNumber x, IComplexNumber y, int idx) Accumulation update for pairswise (2 input) complex numbers.
int	update(IComplexNumber accum, int accumIdx, IComplexNumber x, int xIdx) Accumulation update for complex numbers.
IComplexNumber	zeroComplex() Complex initial value
double	zeroDouble() Initial value for the index accumulation
float	zeroFloat() Initial value for the index accumulation.

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

combineSubResults, combineSubResults, combineSubResults, getFinalResult, init, setFinalResult, zeroPair

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

exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, isExecSpecial, 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.Op

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

Constructor Detail

IMax

public IMax()

IMax

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

IMax

public IMax(INDArray x)

IMax

public IMax(INDArray x,
            INDArray y)

Method Detail

update

public int update(double accum,
                  int accumIdx,
                  double x,
                  int xIdx)

Description copied from interface: IndexAccumulation

Do one accumulation update. Given the current accumulation value (for example, maximum value found so far in an 'index of maximum value' operation) and another value and its index (x/xIdx), update the accumulation index.
If the accumulation value is required in addition to its index, use the Op.op(...) methods.

Parameters:

accum - The value at the accumulation index

accumIdx - The accumulation index

x - A value to be processed/accumulated

xIdx - The index of the value to be processed/accumulated

Returns:

The new accumulation index

update

public int update(float accum,
                  int accumIdx,
                  float x,
                  int xIdx)

See Also:

IndexAccumulation.update(double, int, double, int)

update

public int update(double accum,
                  int accumIdx,
                  double x,
                  double y,
                  int idx)

Description copied from interface: IndexAccumulation

Do one accumulation update for a pair-wise (2 input) index accumulation

See Also:

IndexAccumulation.update(double, int, double, int)

update

public int update(float accum,
                  int accumIdx,
                  float x,
                  float y,
                  int idx)

See Also:

IndexAccumulation.update(double, int, double, double, int)

update

public int update(IComplexNumber accum,
                  int accumIdx,
                  IComplexNumber x,
                  int xIdx)

Description copied from interface: IndexAccumulation

Accumulation update for complex numbers.

See Also:

IndexAccumulation.update(double, int, double, int)

update

public int update(IComplexNumber accum,
                  int accumIdx,
                  double x,
                  int idx)

Description copied from interface: IndexAccumulation

Accumulation update for complex numbers.

See Also:

IndexAccumulation.update(double, int, double, int)

update

public int update(IComplexNumber accum,
                  int accumIdx,
                  double x,
                  double y,
                  int idx)

Description copied from interface: IndexAccumulation

Accumulation update for pairswise (2 input) complex numbers.

See Also:

IndexAccumulation.update(double, int, double, int)

update

public int update(IComplexNumber accum,
                  int accumIdx,
                  IComplexNumber x,
                  IComplexNumber y,
                  int idx)

Description copied from interface: IndexAccumulation

Accumulation update for pairswise (2 input) complex numbers.

See Also:

IndexAccumulation.update(double, int, double, int)

opNum

public int opNum()

Description copied from interface: Op

An op number

Returns:

name

public String name()

Description copied from interface: Op

The name of this operation

Returns:

the name of this operation

op

public IComplexNumber op(IComplexNumber origin,
                         double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public IComplexNumber op(IComplexNumber origin,
                         float other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public IComplexNumber op(IComplexNumber origin,
                         IComplexNumber other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public float op(float origin,
                float other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public double op(double origin,
                 double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public double op(double origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

public float op(float origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

public IComplexNumber op(IComplexNumber origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

zeroFloat

public float zeroFloat()

Description copied from interface: IndexAccumulation

Initial value for the index accumulation.

Specified by:

zeroFloat in interface IndexAccumulation

Overrides:

zeroFloat in class BaseIndexAccumulation

Returns:

the initial value

zeroDouble

public double zeroDouble()

Description copied from interface: IndexAccumulation

Initial value for the index accumulation

Specified by:

zeroDouble in interface IndexAccumulation

Overrides:

zeroDouble in class BaseIndexAccumulation

Returns:

the initial value

zeroComplex

public IComplexNumber zeroComplex()

Description copied from interface: IndexAccumulation

Complex initial value

Specified by:

zeroComplex in interface IndexAccumulation

Overrides:

zeroComplex in class BaseIndexAccumulation

Returns:

the complex initial value

opForDimension

public Op opForDimension(int index,
                         int dimension)

Description copied from interface: Op

A copy of this operation for a particular dimension of the input

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

opForDimension

public Op opForDimension(int index,
                         int... dimension)

Description copied from interface: Op

A copy of this operation for a particular dimension of the input

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension