Package net.objecthunter.exp4j.extras

Class FunctionsMisc

java.lang.Object

net.objecthunter.exp4j.extras.FunctionsMisc

public final class FunctionsMisc
extends Object

This class contains a small set of useful functions that don't really fit in the other categories.

Since:

0.6-riddler

Author:

Federico Vera <[email protected]>

Field Summary

Fields

Modifier and Type	Field	Description
static final Function	DEG2RAD	Converts from degrees to radians.
static final Function	EQUAL	Equality function.
static final double	EQUALITY_THRESHOLD	This is the threshold used to consider values equal, that is, if two values a and b are separated by less than this threshold they will be considered to be equal, it has a default value of 1.0E-12
static final Function	GCD	Returns the Greatest Common Denominator of two numbers.
static final Function	IF	Branching function.
static final Function	INFINITY	Retrieves the value of Double.POSITIVE_INFINITY.
static final Function	IS_NAN	Tells if a number is Double.NaN.
static final Function	LCM	Returns the Least Common Multiple of two numbers.
static final Function	MAX	Returns the largest (closest to positive infinity) of two numbers.
static final Function	MIN	Returns the smallest (closest to negative infinity) of two numbers.
static final Function	RAD2DEG	Converts from radians to degrees.
static final Function	ROUND	Rounds to the closest integer.

Method Summary

Modifier and Type	Method	Description
static Function	getFunction(String name)	Get the function for a given name.
static Function[]	getFunctions()	Array with all the available functions.

Methods inherited from class java.lang.Object

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

Field Details

EQUAL

public static final Function EQUAL

Equality function.

The test is performed using a threshold given by Operator.BOOLEAN_THRESHOLD.

This function has two argument equal(a, b) where:

• a: First value to test
• b: Second value to test

Since:

0.6-riddler

See Also:

• Operator.BOOLEAN_THRESHOLD

IF

public static final Function IF

Branching function.

This function has three argument if(exp, v_true, v_false) where:

• exp: Boolean expression
• v_true: Value if true
• v_false: Value if false

Since:

0.6-riddler

See Also:

• FunctionsBoolean
• OperatorsComparison
• Operator.BOOLEAN_THRESHOLD
• OperatorsComparison.OP_EQU
• OperatorsComparison.OP_GOE
• OperatorsComparison.OP_GT
• OperatorsComparison.OP_LOE
• OperatorsComparison.OP_LT
• OperatorsComparison.OP_NEQ

INFINITY

public static final Function INFINITY

Retrieves the value of Double.POSITIVE_INFINITY.

Since:

0.8-riddler

See Also:

• Double.POSITIVE_INFINITY
• Double.NEGATIVE_INFINITY

IS_NAN

public static final Function IS_NAN

Tells if a number is Double.NaN.

Since:

0.8-riddler

See Also:

• Double.isNaN(double)

MIN

public static final Function MIN

Returns the smallest (closest to negative infinity) of two numbers.

Since:

0.8-riddler

See Also:

• Math.min(double, double)

MAX

public static final Function MAX

Returns the largest (closest to positive infinity) of two numbers.

Since:

0.8-riddler

See Also:

• Math.max(double, double)

GCD

public static final Function GCD

Returns the Greatest Common Denominator of two numbers.

The numbers WILL be rounded using Math.round(double) before the analysis.

If the resulting value is out of the range of the long type, then an ArithmeticException is thrown.

Since:

0.8-riddler

See Also:

• Functions.FLOOR
• Functions.CEIL
• ROUND
• LCM

LCM

public static final Function LCM

Returns the Least Common Multiple of two numbers.

The numbers WILL be rounded using Math.round(double) before the analysis.

If the resulting value is out of the range of the long type, then an ArithmeticException is thrown.

Since:

0.8-riddler

See Also:

• Functions.FLOOR
• Functions.CEIL
• ROUND
• GCD

ROUND

public static final Function ROUND

Rounds to the closest integer.

Since:

0.8-riddler

See Also:

• Functions.FLOOR
• Functions.CEIL
• Math.round(double)

DEG2RAD

public static final Function DEG2RAD

Converts from degrees to radians.

Since:

0.9-riddler

See Also:

• RAD2DEG
• Math.toRadians(double)

RAD2DEG

public static final Function RAD2DEG

Converts from radians to degrees.

Since:

0.9-riddler

See Also:

• DEG2RAD
• Math.toDegrees(double)

EQUALITY_THRESHOLD

public static final double EQUALITY_THRESHOLD

This is the threshold used to consider values equal, that is, if two values a and b are separated by less than this threshold they will be considered to be equal, it has a default value of 1.0E-12

See Also:

• Constant Field Values

Method Details

getFunctions

public static Function[] getFunctions()

Array with all the available functions.

Returns:

Function array

See Also:

• getFunction(String)
• EQUAL
• IF
• INFINITY
• IS_NAN
• MIN
• MAX
• GCD
• LCM
• ROUND
• DEG2RAD
• RAD2DEG

getFunction

public static Function getFunction(String name)

Get the function for a given name.

Parameters:

name - the name of the function

Returns:

a Function instance

See Also:

• getFunctions()
• EQUAL
• IF
• INFINITY
• IS_NAN
• MIN
• MAX
• GCD
• LCM
• ROUND
• DEG2RAD
• RAD2DEG