org.ojalgo.function.aggregator

Class AggregatorSet<N extends Number>

java.lang.Object

org.ojalgo.function.aggregator.AggregatorSet<N>

Direct Known Subclasses:

BigAggregator, ComplexAggregator, PrimitiveAggregator, QuaternionAggregator, RationalAggregator

public abstract class AggregatorSet<N extends Number>
extends Object

Do not cache instances of this class! The methods BigAggregator.getSet(), ComplexAggregator.getSet() and PrimitiveAggregator.getSet() return threadlocal instances, and when you access the individual aggregators they are AggregatorFunction.reset() for you.

Author:

apete

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregatorSet()

Method Summary

Modifier and Type	Method and Description
abstract AggregatorFunction<N>	average() Average value
abstract AggregatorFunction<N>	cardinality() Count of non-zero elements
AggregatorFunction<N>	get(Aggregator aggregator)
abstract AggregatorFunction<N>	largest() Largest absolute value
abstract AggregatorFunction<N>	maximum() Max value
abstract AggregatorFunction<N>	minimum() Min value
abstract AggregatorFunction<N>	norm1() Sum of absolute values
abstract AggregatorFunction<N>	norm2() Square root of sum of squared values
abstract AggregatorFunction<N>	product() Running product
abstract AggregatorFunction<N>	product2() Running product of squares
abstract AggregatorFunction<N>	smallest() Smallest non-zero absolute value
abstract AggregatorFunction<N>	sum() Running sum
abstract AggregatorFunction<N>	sum2() Running sum of squares

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatorSet

protected AggregatorSet()

Method Detail

average

public abstract AggregatorFunction<N> average()

Average value

cardinality

public abstract AggregatorFunction<N> cardinality()

Count of non-zero elements

get

public final AggregatorFunction<N> get(Aggregator aggregator)

largest

public abstract AggregatorFunction<N> largest()

Largest absolute value

maximum

public abstract AggregatorFunction<N> maximum()

Max value

minimum

public abstract AggregatorFunction<N> minimum()

Min value

norm1

public abstract AggregatorFunction<N> norm1()

Sum of absolute values

norm2

public abstract AggregatorFunction<N> norm2()

Square root of sum of squared values

product

public abstract AggregatorFunction<N> product()

Running product

product2

public abstract AggregatorFunction<N> product2()

Running product of squares

smallest

public abstract AggregatorFunction<N> smallest()

Smallest non-zero absolute value

sum

public abstract AggregatorFunction<N> sum()

Running sum

sum2

public abstract AggregatorFunction<N> sum2()

Running sum of squares