org.cactoos.scalar

Class AvgOf

java.lang.Object

java.lang.Number

org.cactoos.scalar.NumberEnvelope

org.cactoos.scalar.AvgOf

All Implemented Interfaces:

Serializable, Scalar<Double>

public final class AvgOf
extends NumberEnvelope

Average of numbers.

Here is how you can use it to fine mathematical average of numbers:

 int sum = new AvgOf(1, 2, 3, 4).intValue();
 long sum = new AvgOf(1L, 2L, 3L).longValue();
 int sum = new AvgOf(numbers.toArray(new Integer[numbers.size()])).intValue();
 

This class implements Scalar, which throws a checked Exception. This may not be convenient in many cases. To make it more convenient and get rid of the checked exception you can use UncheckedScalar or IoCheckedScalar decorators.

There is no thread-safety guarantee.

Since:

0.24

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.cactoos.Scalar

Scalar.NoNulls<T>

Constructor Summary

Constructors

Constructor and Description
AvgOf(Double... src) Ctor.
AvgOf(Float... src) Ctor.
AvgOf(Integer... src) Ctor.
AvgOf(Iterable<Scalar<Number>> src) Ctor.
AvgOf(Long... src) Ctor.
AvgOf(Scalar<Number>... src) Ctor.

Method Summary

Methods inherited from class org.cactoos.scalar.NumberEnvelope

doubleValue, floatValue, intValue, longValue, value

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AvgOf

public AvgOf(Integer... src)

Ctor.

Parameters:

src - Numbers

AvgOf

public AvgOf(Long... src)

Ctor.

Parameters:

src - Numbers

AvgOf

public AvgOf(Double... src)

Ctor.

Parameters:

src - Numbers

AvgOf

public AvgOf(Float... src)

Ctor.

Parameters:

src - Numbers

AvgOf

@SafeVarargs
public AvgOf(Scalar<Number>... src)

Ctor.

Parameters:

src - Numbers

AvgOf

public AvgOf(Iterable<Scalar<Number>> src)

Ctor.

Parameters:

src - The iterable