org.tensorics.core.function.lang

Class FunctionSupportWithConversionAndComparator<X,Y>

java.lang.Object

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

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

org.tensorics.core.function.lang.FunctionSupportWithConversionAndComparator<X,Y>

Type Parameters:

X - the type of the independent variable (input) of the discrete function

Y - the type of the dependent variable (output) of the discrete function and the type of the scalar values (elements of the field) on which to operate

All Implemented Interfaces:

BasicOperationSupport<Y>

Direct Known Subclasses:

FunctionSupport

public class FunctionSupportWithConversionAndComparator<X,Y>
extends ScalarIterableSupport<Y>

Provides utility methods for acting on DiscreteFunctions from X to Y.

The type of the values of the discrete function codomain is also the type of the values of the field.

Method Summary

Modifier and Type	Method and Description
<Z> Y	averageOf(DiscreteFunction<Z,Y> function)
OngoingDiscreteFunctionBinaryOperation<X,Y>	calculate(DiscreteFunction<X,Y> left)
protected Environment<Y>	environment() Only used by subclasses
<Z> Y	rmsOf(DiscreteFunction<Z,Y> function)
<Z> Y	stdOf(DiscreteFunction<Z,Y> function)

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

Method Detail

calculate

public final OngoingDiscreteFunctionBinaryOperation<X,Y> calculate(DiscreteFunction<X,Y> left)

averageOf

public final <Z> Y averageOf(DiscreteFunction<Z,Y> function)

Returns:

average of the y-values of a DiscreteFunction

rmsOf

public final <Z> Y rmsOf(DiscreteFunction<Z,Y> function)

Returns:

root mean square of the y-values of a DiscreteFunction

stdOf

public final <Z> Y stdOf(DiscreteFunction<Z,Y> function)

environment

protected Environment<Y> environment()

Only used by subclasses

Returns:

the Environment of this FunctionSupport