reactor.math

Class MathFlux

java.lang.Object

reactor.math.MathFlux

public final class MathFlux
extends Object

Mathematical utilities that compute sum, average, minimum or maximum values from numerical sources or sources that can be mapped to numerical values using custom mappings. Minimum and maximum values can be computed for any source containing Comparable values or using custom Comparator.

Method Summary

Modifier and Type	Method and Description
static Mono<BigDecimal>	averageBigDecimal(org.reactivestreams.Publisher<? extends Number> source) Computes the BigDecimal average of items in the source.
static <T> Mono<BigDecimal>	averageBigDecimal(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the BigDecimal average of items in the source, which are mapped to numerical values using the provided mapping.
static Mono<BigInteger>	averageBigInteger(org.reactivestreams.Publisher<? extends Number> source) Computes the BigInteger average of items in the source.
static <T> Mono<BigInteger>	averageBigInteger(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the BigInteger average of items in the source, which are mapped to numerical values using the provided mapping.
static Mono<Double>	averageDouble(org.reactivestreams.Publisher<? extends Number> source) Computes the double average of items in the source.
static <T> Mono<Double>	averageDouble(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the double average of items in the source, which are mapped to numerical values using the provided mapping.
static Mono<Float>	averageFloat(org.reactivestreams.Publisher<? extends Number> source) Computes the float average of items in the source.
static <T> Mono<Float>	averageFloat(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the float average of items in the source, which are mapped to numerical values using the provided mapping.
static <T extends Comparable<? super T>> Mono<T>	max(org.reactivestreams.Publisher<T> source) Computes the maximum value of items in the source.
static <T> Mono<T>	max(org.reactivestreams.Publisher<T> source, Comparator<? super T> comparator) Computes the maximum value of items in the source.
static <T extends Comparable<? super T>> Mono<T>	min(org.reactivestreams.Publisher<T> source) Computes the minimum value of items in the source.
static <T> Mono<T>	min(org.reactivestreams.Publisher<T> source, Comparator<? super T> comparator) Computes the minimum value of items in the source.
static Mono<BigDecimal>	sumBigDecimal(org.reactivestreams.Publisher<? extends Number> source) Computes the BigDecimal sum of items in the source.
static <T> Mono<BigDecimal>	sumBigDecimal(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the BigDecimal sum of items in the source, which are mapped to numerical values using provided mapping.
static Mono<BigInteger>	sumBigInteger(org.reactivestreams.Publisher<? extends Number> source) Computes the BigInteger sum of items in the source.
static <T> Mono<BigInteger>	sumBigInteger(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the BigInteger sum of items in the source, which are mapped to numerical values using provided mapping.
static Mono<Double>	sumDouble(org.reactivestreams.Publisher<? extends Number> source) Computes the double sum of items in the source.
static <T> Mono<Double>	sumDouble(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the double sum of items in the source, which are mapped to numerical values using the provided mapping.
static Mono<Float>	sumFloat(org.reactivestreams.Publisher<? extends Number> source) Computes the float sum of items in the source.
static <T> Mono<Float>	sumFloat(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the float sum of items in the source, which are mapped to numerical values using the provided mapping.
static Mono<Integer>	sumInt(org.reactivestreams.Publisher<? extends Number> source) Computes the integer sum of items in the source.
static <T> Mono<Integer>	sumInt(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the integer sum of items in the source, which are mapped to numerical values using the provided mapping.
static Mono<Long>	sumLong(org.reactivestreams.Publisher<? extends Number> source) Computes the long sum of items in the source.
static <T> Mono<Long>	sumLong(org.reactivestreams.Publisher<T> source, Function<? super T,? extends Number> mapping) Computes the long sum of items in the source, which are mapped to numerical values using the provided mapping.

Methods inherited from class java.lang.Object

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

Method Detail

sumInt

public static Mono<Integer> sumInt(org.reactivestreams.Publisher<? extends Number> source)

Computes the integer sum of items in the source. Note that in case of an overflow, this method won't return a negative sum but rather cap at Integer.MAX_VALUE (or Integer.MIN_VALUE for an underflow).

Parameters:

source - the numerical source

Returns:

Mono of the sum of items in source

sumInt

public static final <T> Mono<Integer> sumInt(org.reactivestreams.Publisher<T> source,
                                             Function<? super T,? extends Number> mapping)

Computes the integer sum of items in the source, which are mapped to numerical values using the provided mapping. Note that in case of an overflow, this method won't return a negative sum but rather cap at Integer.MAX_VALUE (or Integer.MIN_VALUE for an underflow).

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the sum of items in source

sumLong

public static Mono<Long> sumLong(org.reactivestreams.Publisher<? extends Number> source)

Computes the long sum of items in the source. Note that in case of an overflow, this method won't return a negative sum but rather cap at Long.MAX_VALUE (or Long.MIN_VALUE for an underflow).

Parameters:

source - the numerical source

Returns:

Mono of the sum of items in source

sumLong

public static final <T> Mono<Long> sumLong(org.reactivestreams.Publisher<T> source,
                                           Function<? super T,? extends Number> mapping)

Computes the long sum of items in the source, which are mapped to numerical values using the provided mapping. Note that in case of an overflow, this method won't return a negative sum but rather cap at Long.MAX_VALUE (or Long.MIN_VALUE for an underflow).

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the sum of items in source

sumFloat

public static Mono<Float> sumFloat(org.reactivestreams.Publisher<? extends Number> source)

Computes the float sum of items in the source.

Parameters:

source - the numerical source

Returns:

Mono of the sum of items in source

sumFloat

public static final <T> Mono<Float> sumFloat(org.reactivestreams.Publisher<T> source,
                                             Function<? super T,? extends Number> mapping)

Computes the float sum of items in the source, which are mapped to numerical values using the provided mapping.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the sum of items in source

sumDouble

public static Mono<Double> sumDouble(org.reactivestreams.Publisher<? extends Number> source)

Computes the double sum of items in the source.

Parameters:

source - the numerical source

Returns:

Mono of the sum of items in source

sumDouble

public static final <T> Mono<Double> sumDouble(org.reactivestreams.Publisher<T> source,
                                               Function<? super T,? extends Number> mapping)

Computes the double sum of items in the source, which are mapped to numerical values using the provided mapping.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the sum of items in source

sumBigInteger

public static Mono<BigInteger> sumBigInteger(org.reactivestreams.Publisher<? extends Number> source)

Computes the BigInteger sum of items in the source.

Further conversion of individual elements to BigDecimal is always applied to retain maximum precision. When the sum is ultimately produced, it can be rounded or truncated as a BigDecimal.toBigInteger() final conversion is applied.

Parameters:

source - the numerical source

Returns:

Mono of the sum of items in source

sumBigInteger

public static final <T> Mono<BigInteger> sumBigInteger(org.reactivestreams.Publisher<T> source,
                                                       Function<? super T,? extends Number> mapping)

Computes the BigInteger sum of items in the source, which are mapped to numerical values using provided mapping.

Further conversion of individual elements to BigDecimal is always applied to retain maximum precision. When the sum is ultimately produced, it can be rounded or truncated as a BigDecimal.toBigInteger() final conversion is applied.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of sum of items in source

sumBigDecimal

public static Mono<BigDecimal> sumBigDecimal(org.reactivestreams.Publisher<? extends Number> source)

Computes the BigDecimal sum of items in the source.

Parameters:

source - the numerical source

Returns:

Mono of the sum of items in source

sumBigDecimal

public static final <T> Mono<BigDecimal> sumBigDecimal(org.reactivestreams.Publisher<T> source,
                                                       Function<? super T,? extends Number> mapping)

Computes the BigDecimal sum of items in the source, which are mapped to numerical values using provided mapping.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of sum of items in source

averageFloat

public static Mono<Float> averageFloat(org.reactivestreams.Publisher<? extends Number> source)

Computes the float average of items in the source.

Parameters:

source - the numerical source

Returns:

Mono of the average of items in source

averageFloat

public static final <T> Mono<Float> averageFloat(org.reactivestreams.Publisher<T> source,
                                                 Function<? super T,? extends Number> mapping)

Computes the float average of items in the source, which are mapped to numerical values using the provided mapping.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the average of items in source

averageDouble

public static Mono<Double> averageDouble(org.reactivestreams.Publisher<? extends Number> source)

Computes the double average of items in the source.

Parameters:

source - the numerical source

Returns:

Mono of the average of items in source

averageDouble

public static final <T> Mono<Double> averageDouble(org.reactivestreams.Publisher<T> source,
                                                   Function<? super T,? extends Number> mapping)

Computes the double average of items in the source, which are mapped to numerical values using the provided mapping.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the average of items in source

averageBigInteger

public static Mono<BigInteger> averageBigInteger(org.reactivestreams.Publisher<? extends Number> source)

Computes the BigInteger average of items in the source.

The average is computed by summing BigDecimal-converted values and ultimately dividing that number by the number of elements. Eventually the result of that division can be rounded or truncated, as the FLOOR rounding mode is applied and the BigDecimal.toBigInteger() final conversion is performed.

Parameters:

source - the numerical source

Returns:

Mono of the average of items in source

averageBigInteger

public static final <T> Mono<BigInteger> averageBigInteger(org.reactivestreams.Publisher<T> source,
                                                           Function<? super T,? extends Number> mapping)

Computes the BigInteger average of items in the source, which are mapped to numerical values using the provided mapping.

Further conversion of individual elements to BigDecimal is always applied. The average is computed by summing BigDecimal-converted values and ultimately dividing that number by the number of elements. Eventually the result of that division can be rounded or truncated, as the FLOOR rounding mode is applied and the BigDecimal.toBigInteger() final conversion is performed.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the average of items in source

averageBigDecimal

public static Mono<BigDecimal> averageBigDecimal(org.reactivestreams.Publisher<? extends Number> source)

Computes the BigDecimal average of items in the source.

Parameters:

source - the numerical source

Returns:

Mono of the average of items in source

averageBigDecimal

public static final <T> Mono<BigDecimal> averageBigDecimal(org.reactivestreams.Publisher<T> source,
                                                           Function<? super T,? extends Number> mapping)

Computes the BigDecimal average of items in the source, which are mapped to numerical values using the provided mapping.

Parameters:

source - the source items

mapping - a function to map source items to numerical values

Returns:

Mono of the average of items in source

max

public static final <T extends Comparable<? super T>> Mono<T> max(org.reactivestreams.Publisher<T> source)

Computes the maximum value of items in the source.

Parameters:

source - the source containing comparable items

Returns:

Mono of the maximum value in source

max

public static <T> Mono<T> max(org.reactivestreams.Publisher<T> source,
                              Comparator<? super T> comparator)

Computes the maximum value of items in the source.

Parameters:

source - the source containing items to compare

comparator - the comparator used to compare the items in source

Returns:

Mono of the maximum value in source

min

public static final <T extends Comparable<? super T>> Mono<T> min(org.reactivestreams.Publisher<T> source)

Computes the minimum value of items in the source.

Parameters:

source - the source containing comparable items

Returns:

Mono of the minimum value in source

min

public static <T> Mono<T> min(org.reactivestreams.Publisher<T> source,
                              Comparator<? super T> comparator)

Computes the minimum value of items in the source.

Parameters:

source - the source containing items to compare

comparator - the comparator used to compare the items in source

Returns:

Mono of the minimum value in source