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

Class StandardDeviation

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseAccumulation

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

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

All Implemented Interfaces:

Accumulation, Op

public class StandardDeviation
extends Variance

Standard deviation (sqrt of variance)

Author:

Adam Gibson

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.ops.Op

Op.Type

Field Summary

Fields inherited from class org.nd4j.linalg.api.ops.impl.accum.Variance

bias, biasCorrected, mean

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

applyFinalTransform, finalResult, finalResultComplex, isComplex

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

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

Constructor Summary

Constructors

Constructor and Description
StandardDeviation()
StandardDeviation(INDArray x)
StandardDeviation(INDArray x, boolean biasCorrected)
StandardDeviation(INDArray x, INDArray y)
StandardDeviation(INDArray x, INDArray y, INDArray z, long n, boolean biasCorrected)
StandardDeviation(INDArray x, INDArray y, long n)

Method Summary

Modifier and Type	Method and Description
double	calculateFinalResult(double accum, long n) Calculate the final result.
float	calculateFinalResult(float accum, long n)
void	exec() Execute the op if its pass through (not needed most of the time)
void	exec(int... dimension) Exec along each dimension
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
Variance	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

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

combineSubResults, combineSubResults, combineSubResults, init, isBiasCorrected, isPassThrough, noOp, op, op, setBiasCorrected, update, update, update, update, update, update, update, update, update

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

applyFinalTransform, currentResult, getFinalResult, getFinalResultComplex, isComplexAccumulation, numProcessed, op, op, op, op, op, op, setApplyFinalTransform, setFinalResult, setFinalResultComplex, zeroComplex, zeroDouble, zeroFloat, zeroHalf

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

extraArgs, extraArgsBuff, extraArgsDataBuff, getOpType, isExecSpecial, 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

extraArgs, extraArgsBuff, extraArgsDataBuff, isExecSpecial, n, setExtraArgs, setN, setX, setY, setZ, x, y, z

Constructor Detail

StandardDeviation

public StandardDeviation(INDArray x,
                         boolean biasCorrected)

StandardDeviation

public StandardDeviation(INDArray x,
                         INDArray y,
                         INDArray z,
                         long n,
                         boolean biasCorrected)

StandardDeviation

public StandardDeviation()

StandardDeviation

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

StandardDeviation

public StandardDeviation(INDArray x)

StandardDeviation

public StandardDeviation(INDArray x,
                         INDArray y)

Method Detail

opNum

public int opNum()

Description copied from interface: Op

An op number

Specified by:

opNum in interface Op

Overrides:

opNum in class Variance

Returns:

name

public String name()

Description copied from interface: Op

The name of this operation

Specified by:

name in interface Op

Overrides:

name in class Variance

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 Variance

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 Variance 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 Variance

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

exec

public void exec()

Description copied from interface: Op

Execute the op if its pass through (not needed most of the time)

Specified by:

exec in interface Op

Overrides:

exec in class Variance

exec

public void exec(int... dimension)

Description copied from interface: Op

Exec along each dimension

Specified by:

exec in interface Op

Overrides:

exec in class Variance

Parameters:

dimension - the dimensions to execute on

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 Variance

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 Variance

See Also:

Accumulation.getAndSetFinalResult(double)

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 Variance

See Also:

Accumulation.getAndSetFinalResult(double)

calculateFinalResult

public double calculateFinalResult(double accum,
                                   long 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 Variance

Parameters:

accum - The accumulated result

n - the number of elements accumulated

Returns:

calculated final result

calculateFinalResult

public float calculateFinalResult(float accum,
                                  long n)

Specified by:

calculateFinalResult in interface Accumulation

Overrides:

calculateFinalResult in class Variance

See Also:

Accumulation.calculateFinalResult(double, long)