org.nd4j.linalg.api.ops

Class BaseAccumulation

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseAccumulation

All Implemented Interfaces:

Accumulation, Op

Direct Known Subclasses:

BaseLossFunction, Bias, CosineSimilarity, Dot, EuclideanDistance, IAMax, ManhattanDistance, Max, Mean, Min, Norm1, Norm2, NormMax, Prod, Sum, Variance

public abstract class BaseAccumulation
extends BaseOp
implements Accumulation

Base class for accumulation, initiates the initial entry with respect to the child class. Also contains baseline fields for the over all field with accumulation.

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
protected IComplexNumber	currentComplexResult
protected Number	currentResult
protected Number	initial
protected IComplexNumber	initialComplex
protected List<Number>	otherAccum
protected List<IComplexNumber>	otherAccumComplex

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Number	currentResult() Current result
IComplexNumber	currentResultComplex() Current accumulated result
void	init(INDArray x, INDArray y, INDArray z, int n) Initialize the operation based on the parameters
int	numProcessed() Number processed
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)
List<Number>	otherAccum() Other accmuluations from the primary
List<IComplexNumber>	otherAccumComplex() Other accmuluations from the primary
void	setCurrentResult(Number number) Set the current result
void	setCurrentResultComplex(IComplexNumber complexNumber) Set the current complex number result
Number	zero() Initial value
IComplexNumber	zeroComplex() Complex initial value

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

exec, extraArgs, isPassThrough, n, 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.Accumulation

update, update

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

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

Field Detail

currentResult

protected Number currentResult

currentComplexResult

protected IComplexNumber currentComplexResult

otherAccum

protected List<Number> otherAccum

otherAccumComplex

protected List<IComplexNumber> otherAccumComplex

initial

protected Number initial

initialComplex

protected IComplexNumber initialComplex

Constructor Detail

BaseAccumulation

public BaseAccumulation()

BaseAccumulation

public BaseAccumulation(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

BaseAccumulation

public BaseAccumulation(INDArray x,
                        INDArray y,
                        int n)

BaseAccumulation

public BaseAccumulation(INDArray x)

BaseAccumulation

public BaseAccumulation(INDArray x,
                        INDArray y)

Method Detail

op

public IComplexNumber op(IComplexNumber origin,
                         double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Specified by:

op in interface Op

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)

Specified by:

op in interface Op

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)

Specified by:

op in interface Op

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)

Specified by:

op in interface Op

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)

Specified by:

op in interface Op

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

Specified by:

op in interface Op

Parameters:

origin - the origin element

Returns:

the new element

op

public float op(float origin)

Description copied from interface: Op

Transform an individual element

Specified by:

op in interface Op

Parameters:

origin - the origin element

Returns:

the new element

op

public IComplexNumber op(IComplexNumber origin)

Description copied from interface: Op

Transform an individual element

Specified by:

op in interface Op

Parameters:

origin - the origin element

Returns:

the new element

zero

public Number zero()

Description copied from interface: Accumulation

Initial value

Specified by:

zero in interface Accumulation

Returns:

the initial value

zeroComplex

public IComplexNumber zeroComplex()

Description copied from interface: Accumulation

Complex initial value

Specified by:

zeroComplex in interface Accumulation

Returns:

the complex initial value

currentResultComplex

public IComplexNumber currentResultComplex()

Description copied from interface: Accumulation

Current accumulated result

Specified by:

currentResultComplex in interface Accumulation

Returns:

currentResult

public Number currentResult()

Description copied from interface: Accumulation

Current result

Specified by:

currentResult in interface Accumulation

Returns:

numProcessed

public int numProcessed()

Description copied from interface: Op

Number processed

Specified by:

numProcessed in interface Op

Overrides:

numProcessed in class BaseOp

Returns:

the number of elements accumulated

otherAccumComplex

public List<IComplexNumber> otherAccumComplex()

Description copied from interface: Accumulation

Other accmuluations from the primary

Specified by:

otherAccumComplex in interface Accumulation

Returns:

other accumulations from the primary

otherAccum

public List<Number> otherAccum()

Description copied from interface: Accumulation

Other accmuluations from the primary

Specified by:

otherAccum in interface Accumulation

Returns:

other accumulations from the primary

setCurrentResult

public void setCurrentResult(Number number)

Description copied from interface: Accumulation

Set the current result

Specified by:

setCurrentResult in interface Accumulation

Parameters:

number - the result

setCurrentResultComplex

public void setCurrentResultComplex(IComplexNumber complexNumber)

Description copied from interface: Accumulation

Set the current complex number result

Specified by:

setCurrentResultComplex in interface Accumulation

Parameters:

complexNumber - the current complex number result

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