io.github.privacystreams.commons.arithmetic

Class ArithmeticOperators

java.lang.Object

io.github.privacystreams.commons.arithmetic.ArithmeticOperators

@PSOperatorWrapper
public class ArithmeticOperators
extends java.lang.Object

A helper class to access arithmetic operators.

Constructor Summary

Constructors

Constructor and Description
ArithmeticOperators()

Method Summary

Modifier and Type	Method and Description
static Function<Item,java.lang.Number>	add(java.lang.String numField1, java.lang.String numField2) Add the values of two fields in an item.
static Function<Item,java.lang.Integer>	castToInt(java.lang.String numField) Cast a number to integer type.
static Function<Item,java.lang.Long>	castToLong(java.lang.String numField) Cast a number to long type.
static Function<Item,java.lang.Number>	divide(java.lang.String numField1, java.lang.String numField2) Divide the values of two fields in an item.
static Function<Item,java.lang.Number>	mode(java.lang.String numField1, java.lang.String numField2) Mode the values of two fields in an item.
static Function<Item,java.lang.Number>	multiply(java.lang.String numField1, java.lang.String numField2) Multiply the values of two fields in an item.
static Function<Item,java.lang.Double>	roundDown(java.lang.String numField, java.lang.Number value) Round down a number.
static Function<Item,java.lang.Double>	roundUp(java.lang.String numField, java.lang.Number value) Round up a number.
static Function<Item,java.lang.Number>	sub(java.lang.String numField1, java.lang.String numField2) Subtract the values of two fields in an item.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArithmeticOperators

public ArithmeticOperators()

Method Detail

roundUp

public static Function<Item,java.lang.Double> roundUp(java.lang.String numField,
                                                      java.lang.Number value)

Round up a number. For example, given an item with field "x"=17, `roundUp("x", 10)` will produce 20.

Parameters:

numField - the name of the number field

value - the value to round

Returns:

the function

roundDown

public static Function<Item,java.lang.Double> roundDown(java.lang.String numField,
                                                        java.lang.Number value)

Round down a number. For example, given an item with field "x"=0.027, roundUp("x", 0.01) will produce 0.02.

Parameters:

numField - the name of the number field

value - the value to round

Returns:

the function

castToLong

public static Function<Item,java.lang.Long> castToLong(java.lang.String numField)

Cast a number to long type.

Parameters:

numField - the name of the number field

Returns:

the function

castToInt

public static Function<Item,java.lang.Integer> castToInt(java.lang.String numField)

Cast a number to integer type.

Parameters:

numField - the name of the number field

Returns:

the function

add

public static Function<Item,java.lang.Number> add(java.lang.String numField1,
                                                  java.lang.String numField2)

Add the values of two fields in an item.

Parameters:

numField1 - the name of the first field

numField2 - the name of the second field

Returns:

the function

sub

public static Function<Item,java.lang.Number> sub(java.lang.String numField1,
                                                  java.lang.String numField2)

Subtract the values of two fields in an item.

Parameters:

numField1 - the name of the first field

numField2 - the name of the second field

Returns:

the function

multiply

public static Function<Item,java.lang.Number> multiply(java.lang.String numField1,
                                                       java.lang.String numField2)

Multiply the values of two fields in an item.

Parameters:

numField1 - the name of the first field

numField2 - the name of the second field

Returns:

the function

divide

public static Function<Item,java.lang.Number> divide(java.lang.String numField1,
                                                     java.lang.String numField2)

Divide the values of two fields in an item.

Parameters:

numField1 - the name of the first field

numField2 - the name of the second field

Returns:

the function

mode

public static Function<Item,java.lang.Number> mode(java.lang.String numField1,
                                                   java.lang.String numField2)

Mode the values of two fields in an item.

Parameters:

numField1 - the name of the first field

numField2 - the name of the second field

Returns:

the function