com.opengamma.strata.math.impl

Class FunctionUtils

java.lang.Object

com.opengamma.strata.math.impl.FunctionUtils

public final class FunctionUtils
extends Object

A collection of basic useful maths functions.

Method Summary

Modifier and Type	Method and Description
static double	cube(double x) Deprecated. Use MathUtils.pow3(double)
static int[]	fromTensorIndex(int index, int[] dimensions)
static int	getLowerBoundIndex(DoubleArray set, double value) Find the index of a sorted set that is less than or equal to a given value.
static double	square(double x) Deprecated. Use MathUtils.pow2(double)
static int	toTensorIndex(int[] indices, int[] dimensions)
static double[]	unique(double[] in) Same behaviour as mathlab unique.
static int[]	unique(int[] in) Same behaviour as mathlab unique.

Methods inherited from class java.lang.Object

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

Method Detail

square

@Deprecated
public static double square(double x)

Deprecated. Use MathUtils.pow2(double)

Returns the square of a number.

Parameters:

x - the number to square

Returns:

x*x

cube

@Deprecated
public static double cube(double x)

Deprecated. Use MathUtils.pow3(double)

Returns the cube of a number.

Parameters:

x - the number to cube

Returns:

x*x*x

toTensorIndex

public static int toTensorIndex(int[] indices,
                                int[] dimensions)

fromTensorIndex

public static int[] fromTensorIndex(int index,
                                    int[] dimensions)

unique

public static double[] unique(double[] in)

Same behaviour as mathlab unique.

Parameters:

in - the input array

Returns:

a sorted array with no duplicates values

unique

public static int[] unique(int[] in)

Same behaviour as mathlab unique.

Parameters:

in - the input array

Returns:

a sorted array with no duplicates values

getLowerBoundIndex

public static int getLowerBoundIndex(DoubleArray set,
                                     double value)

Find the index of a sorted set that is less than or equal to a given value. If the given value is lower than the lowest member (i.e. the first) of the set, zero is returned. This uses Arrays.binarySearch.

Parameters:

set - a sorted array of numbers.

value - the value to search for

Returns:

the index in the array