com.whitestein.lsps.stdlib.function

Class NumberFunctions

java.lang.Object

com.whitestein.lsps.stdlib.function.NumberFunctions

public class NumberFunctions
extends Object

Utility class for number types related utility methods This methods are defined in Standard library specification

Author:

rki

Constructor Summary

Constructors

Constructor and Description
NumberFunctions() Creates new instance.

Method Summary

Modifier and Type	Method and Description
Decimal	abs(ExecutionContext ctx, Decimal number) Returns the absolute value of the number.
Decimal	max(ExecutionContext ctx, Decimal... values) Computes max long from all passed long
Decimal	min(ExecutionContext ctx, Decimal... values) Computes min long from all passed long
Decimal	random() Returns a pseudorandom, uniformly distributed decimal value between 0.0 (inclusive) and 1.0 (exclusive).
Decimal	random(ExecutionContext ctx, Decimal upperBound) Returns a pseudorandom, uniformly distributed decimal value between 0 (inclusive) and the upperBound (exclusive).
Decimal	roundCeiling(ExecutionContext ctx, Decimal number) Returns rounding of the number towards positive infinity.
Decimal	roundDown(ExecutionContext ctx, Decimal number) Returns rounding of the number towards zero.
Decimal	roundFloor(ExecutionContext ctx, Decimal number) Returns rounding of the number towards negative infinity.
Decimal	roundHalfDown(ExecutionContext ctx, Decimal number) Returns rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds down.
Decimal	roundHalfEven(ExecutionContext ctx, Decimal number) Returns rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds towards the even neighbor.
Decimal	roundHalfUp(ExecutionContext ctx, Decimal number) Returns rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds up.
Decimal	roundUp(ExecutionContext ctx, Decimal number) Returns rounding of the number away from zero.
Decimal	scale(ExecutionContext ctx, Decimal number) Returns the scale of the number.

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberFunctions

public NumberFunctions()

Creates new instance.

Method Detail

min

public Decimal min(ExecutionContext ctx,
                   Decimal... values)
            throws ErrorException

Computes min long from all passed long

Parameters:

ctx -

values -

Returns:

min long

Throws:

ErrorException

max

public Decimal max(ExecutionContext ctx,
                   Decimal... values)
            throws ErrorException

Computes max long from all passed long

Parameters:

ctx -

values -

Returns:

max long

Throws:

ErrorException

abs

public Decimal abs(ExecutionContext ctx,
                   Decimal number)
            throws ErrorException

Returns the absolute value of the number.

Parameters:

ctx -

number -

Returns:

the absolute value of the number

Throws:

ErrorException

roundFloor

public Decimal roundFloor(ExecutionContext ctx,
                          Decimal number)
                   throws ErrorException

Returns rounding of the number towards negative infinity.

Parameters:

ctx -

number -

Returns:

rounding of the number towards negative infinity

Throws:

ErrorException

roundCeiling

public Decimal roundCeiling(ExecutionContext ctx,
                            Decimal number)
                     throws ErrorException

Returns rounding of the number towards positive infinity.

Parameters:

ctx -

number -

Returns:

rounding of the number towards positive infinity

Throws:

ErrorException

roundDown

public Decimal roundDown(ExecutionContext ctx,
                         Decimal number)
                  throws ErrorException

Returns rounding of the number towards zero.

Parameters:

ctx -

number -

Returns:

rounding of the number towards zero

Throws:

ErrorException

roundUp

public Decimal roundUp(ExecutionContext ctx,
                       Decimal number)
                throws ErrorException

Returns rounding of the number away from zero.

Parameters:

ctx -

number -

Returns:

rounding of the number away from zero

Throws:

ErrorException

roundHalfDown

public Decimal roundHalfDown(ExecutionContext ctx,
                             Decimal number)
                      throws ErrorException

Returns rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds down.

Parameters:

ctx -

number -

Returns:

rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds down.

Throws:

ErrorException

roundHalfEven

public Decimal roundHalfEven(ExecutionContext ctx,
                             Decimal number)
                      throws ErrorException

Returns rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds towards the even neighbor.

Parameters:

ctx -

number -

Returns:

rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds towards the even neighbor.

Throws:

ErrorException

roundHalfUp

public Decimal roundHalfUp(ExecutionContext ctx,
                           Decimal number)
                    throws ErrorException

Returns rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds up.

Parameters:

ctx -

number -

Returns:

rounding of the number towards the nearest neighbour, if both neighbors are equidistant, rounds up.

Throws:

ErrorException

scale

public Decimal scale(ExecutionContext ctx,
                     Decimal number)
              throws ErrorException

Returns the scale of the number.

Parameters:

ctx -

number -

Returns:

the scale of the number

Throws:

ErrorException

random

public Decimal random()

Returns a pseudorandom, uniformly distributed decimal value between 0.0 (inclusive) and 1.0 (exclusive).

Returns:

decimal

random

public Decimal random(ExecutionContext ctx,
                      Decimal upperBound)
               throws ErrorException

Returns a pseudorandom, uniformly distributed decimal value between 0 (inclusive) and the upperBound (exclusive).

Parameters:

ctx -

upperBound -

Returns:

Decimal

Throws:

ErrorException