org.tensorics.core.reduction

Class RootMeanSquare<S>

java.lang.Object

org.tensorics.core.scalar.lang.ScalarSupport<V>

org.tensorics.core.iterable.lang.ScalarIterableSupport<S>

org.tensorics.core.reduction.RootMeanSquare<S>

Type Parameters:

S - the type of the scalars (field elements) on which all the operations are based on.

All Implemented Interfaces:

BasicOperationSupport<S>, ReductionStrategy<java.lang.Object,S,S>

public class RootMeanSquare<S>
extends ScalarIterableSupport<S>
implements ReductionStrategy<java.lang.Object,S,S>

Performs an rms calculation over all in one direction of a tensor, if used for tensor reduction.

Constructor Summary

Constructors

Constructor and Description
RootMeanSquare(ExtendedField<S> field)

Method Summary

Modifier and Type	Method and Description
Position	context(Position originalContext)
S	reduce(java.util.Map<? extends java.lang.Object,S> inputValues, Position position)

Methods inherited from class org.tensorics.core.iterable.lang.ScalarIterableSupport

averageOf, rmsOf, sizeOf, stdOf, sumOf, sumOfSquaresOf, varOf

Methods inherited from class org.tensorics.core.scalar.lang.ScalarSupport

absoluteValueOf, calculate, countOf, field, inverseOf, negativeOf, one, squareOf, squareRootOf, testIf, two, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

RootMeanSquare

public RootMeanSquare(ExtendedField<S> field)

Method Detail

reduce

public S reduce(java.util.Map<? extends java.lang.Object,S> inputValues,
                Position position)

Specified by:

reduce in interface ReductionStrategy<java.lang.Object,S,S>

Parameters:

inputValues - the sub values of the tensor from which the reduction is performed

position - a remaining position in the tensor for which reduction is performed

Returns:

the value of reduction

context

public Position context(Position originalContext)

Specified by:

context in interface ReductionStrategy<java.lang.Object,S,S>