org.tensorics.core.iterable.operations

Class IterableRms<V>

java.lang.Object

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

org.tensorics.core.iterable.operations.IterableRms<V>

Type Parameters:

V - the type of the scalars (elements of the field on which the rms will be based)

All Implemented Interfaces:

java.util.function.Function<java.lang.Iterable<V>,V>, BasicOperationSupport<V>, Conversion<java.lang.Iterable<V>,V>, IterableOperation<V>

public class IterableRms<V>
extends ScalarSupport<V>
implements IterableOperation<V>

An operation that takes and iterable of a certain type of values (for which a field has to be provided) and calculates the rms (Root mean square) out of it.

For the definition of the root mean square, have a look at wikipedia.

Constructor Summary

Constructors

Constructor and Description
IterableRms(ExtendedField<V> field)

Method Summary

Modifier and Type	Method and Description
V	apply(java.lang.Iterable<V> values) Has to implement the conversion logic to convert the given object into an object of type R.

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

IterableRms

public IterableRms(ExtendedField<V> field)

Method Detail

apply

public V apply(java.lang.Iterable<V> values)

Description copied from interface: Conversion

Has to implement the conversion logic to convert the given object into an object of type R.

Specified by:

apply in interface java.util.function.Function<java.lang.Iterable<V>,V>

Specified by:

apply in interface Conversion<java.lang.Iterable<V>,V>

Parameters:

values - the object to convert

Returns:

an object of the correct return type.