org.nd4j.linalg.api.ops.impl.accum

Class Mean

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseAccumulation

org.nd4j.linalg.api.ops.impl.accum.Sum

org.nd4j.linalg.api.ops.impl.accum.Mean

All Implemented Interfaces:

Accumulation, Op

public class Mean
extends Sum

Calculate the mean of the vector

Author:

Adam Gibson

Field Summary

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

applyFinalTransform, finalResult, finalResultComplex

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

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

Constructor Summary

Constructors

Constructor and Description
Mean()
Mean(INDArray x)
Mean(INDArray x, INDArray y)
Mean(INDArray x, INDArray y, INDArray z, int n)
Mean(INDArray x, INDArray y, int n)

Method Summary

Modifier and Type	Method and Description
double	calculateFinalResult(double accum, int n) Calculate the final result.
float	calculateFinalResult(float accum, int n)
double	getAndSetFinalResult(double accum) Get and set the final result. The final result is also stored in the Accumulation op itself (and can be retrieved by getFinalResult()) In some Accumulation operations, a final operation must be done on the accumulated result.
float	getAndSetFinalResult(float accum)
IComplexNumber	getAndSetFinalResult(IComplexNumber accum) Complex version of getAndSetFinalResult().
String	name() The name of this operation
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

Methods inherited from class org.nd4j.linalg.api.ops.impl.accum.Sum

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

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

applyFinalTransform, combineSubResults, combineSubResults, combineSubResults, currentResult, getFinalResult, getFinalResultComplex, init, numProcessed, op, op, op, op, op, op, op, op, setApplyFinalTransform, setFinalResult, setFinalResultComplex, zeroComplex, zeroDouble, zeroFloat

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

ensureProperVectors, exec, exec, extraArgs, isPassThrough, n, 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, isPassThrough, n, setN, setX, setY, setZ, x, y, z

Constructor Detail

Mean

public Mean()

Mean

public Mean(INDArray x,
            INDArray y,
            INDArray z,
            int n)

Mean

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

Mean

public Mean(INDArray x)

Mean

public Mean(INDArray x,
            INDArray y)

Method Detail

name

public String name()

Description copied from interface: Op

The name of this operation

Specified by:

name in interface Op

Overrides:

name in class Sum

Returns:

the name of this operation

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

Specified by:

opForDimension in interface Op

Overrides:

opForDimension in class Sum

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

Specified by:

opForDimension in interface Op

Overrides:

opForDimension in class Sum

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

getAndSetFinalResult

public double getAndSetFinalResult(double accum)

Description copied from interface: Accumulation

Get and set the final result.
The final result is also stored in the Accumulation op itself (and can be retrieved by getFinalResult()) In some Accumulation operations, a final operation must be done on the accumulated result. For example, division by n in a mean operation: the accumulated result is the sum, whereas the final result is the sum/n.

Specified by:

getAndSetFinalResult in interface Accumulation

Overrides:

getAndSetFinalResult in class BaseAccumulation

Parameters:

accum - The accumulated result

Returns:

The final result

getAndSetFinalResult

public float getAndSetFinalResult(float accum)

Specified by:

getAndSetFinalResult in interface Accumulation

Overrides:

getAndSetFinalResult in class BaseAccumulation

See Also:

Accumulation.getAndSetFinalResult(double)

calculateFinalResult

public double calculateFinalResult(double accum,
                                   int n)

Description copied from interface: Accumulation

Calculate the final result. unlike Accumulation.getAndSetFinalResult(double), the result is merely calculated and returned, not stored in the Accumulation op itself.

Specified by:

calculateFinalResult in interface Accumulation

Overrides:

calculateFinalResult in class BaseAccumulation

Parameters:

accum - The accumulated result

n - the number of elements accumulated

Returns:

calculated final result

calculateFinalResult

public float calculateFinalResult(float accum,
                                  int n)

Specified by:

calculateFinalResult in interface Accumulation

Overrides:

calculateFinalResult in class BaseAccumulation

See Also:

Accumulation.calculateFinalResult(double, int)

getAndSetFinalResult

public IComplexNumber getAndSetFinalResult(IComplexNumber accum)

Description copied from interface: Accumulation

Complex version of getAndSetFinalResult().

Specified by:

getAndSetFinalResult in interface Accumulation

Overrides:

getAndSetFinalResult in class BaseAccumulation

See Also:

Accumulation.getAndSetFinalResult(double)