org.tensorics.core.iterable.operations

Class IterableAverage<V>

java.lang.Object

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

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

Type Parameters:

V - the type of the scalar values over which to average.

All Implemented Interfaces:

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

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

This operation reduces an Iterable of a certain value type to one value by averaging over them.

Constructor Summary

Constructors

Constructor and Description
IterableAverage(ExtendedField<V> field)

Method Summary

Modifier and Type	Method and Description
V	apply(java.lang.Iterable<V> iterable) 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

IterableAverage

public IterableAverage(ExtendedField<V> field)

Method Detail

apply

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

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:

iterable - the object to convert

Returns:

an object of the correct return type.