Package com.opengamma.strata.calc.runner

Class FunctionUtils

java.lang.Object

com.opengamma.strata.calc.runner.FunctionUtils

public final class FunctionUtils
extends Object

Static utility methods useful when writing calculation functions.

Method Summary

Modifier and Type	Method	Description
static void	duplicateResult(Measure existingKey, Measure newKey, Map<Measure,Result<?>> mutableMeasureMap)	Checks if a map of results contains a value for a key, and if it does inserts it into the map for a different key.
static Collector<CurrencyAmount,List<CurrencyAmount>,CurrencyScenarioArray>	toCurrencyValuesArray()	Returns a collector that builds a single-currency scenerio result.
static Collector<MultiCurrencyAmount,List<MultiCurrencyAmount>,MultiCurrencyScenarioArray>	toMultiCurrencyValuesArray()	Returns a collector that builds a multi-currency scenerio result.
static <T> Collector<T,List<T>,ScenarioArray<T>>	toScenarioArray()	Returns a collector which can be used at the end of a stream of results to build a ScenarioArray.
static Collector<Double,List<Double>,DoubleScenarioArray>	toValuesArray()	Returns a collector that builds a scenario result based on Double.

Methods inherited from class java.lang.Object

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

Method Detail

toScenarioArray

public static <T> Collector<T,List<T>,ScenarioArray<T>> toScenarioArray()

Returns a collector which can be used at the end of a stream of results to build a ScenarioArray.

Type Parameters:

T - the type of the results in the stream

Returns:

a collector used to create a CurrencyAmountList from a stream of CurrencyAmount

toMultiCurrencyValuesArray

public static Collector<MultiCurrencyAmount,List<MultiCurrencyAmount>,MultiCurrencyScenarioArray> toMultiCurrencyValuesArray()

Returns a collector that builds a multi-currency scenerio result.

This is used at the end of a stream to collect per-scenario instances of MultiCurrencyAmount into a single instance of MultiCurrencyScenarioArray, which is designed to be space-efficient.

Returns:

a collector used at the end of a stream of MultiCurrencyAmount to build a MultiCurrencyScenarioArray

toCurrencyValuesArray

public static Collector<CurrencyAmount,List<CurrencyAmount>,CurrencyScenarioArray> toCurrencyValuesArray()

Returns a collector that builds a single-currency scenerio result.

This is used at the end of a stream to collect per-scenario instances of CurrencyAmount into a single instance of CurrencyScenarioArray, which is designed to be space-efficient.

Returns:

a collector used at the end of a stream of CurrencyAmount to build a CurrencyScenarioArray

toValuesArray

public static Collector<Double,List<Double>,DoubleScenarioArray> toValuesArray()

Returns a collector that builds a scenario result based on Double.

This is used at the end of a stream to collect per-scenario instances of Double into a single instance of DoubleScenarioArray, which is designed to be space-efficient.

Note that DoubleStream does not support collectors, which makes this less efficient than it should be.

Returns:

a collector used at the end of a stream of Double to build a DoubleScenarioArray

duplicateResult

public static void duplicateResult(Measure existingKey,
                                   Measure newKey,
                                   Map<Measure,Result<?>> mutableMeasureMap)

Checks if a map of results contains a value for a key, and if it does inserts it into the map for a different key.

Parameters:

existingKey - a key for which the map possibly contains a value

newKey - the key which is inserted into the map

mutableMeasureMap - a mutable map of values, keyed by measure