org.mariuszgromada.math.mxparser

Class mXparser

java.lang.Object

org.mariuszgromada.math.mxparser.mXparser

public final class mXparser
extends Object

mXparser class provides usefull methods when parsing, calculating or parameters transforming.

Version:

4.0.0

Author:

Mariusz Gromada
mariuszgromada.org@gmail.com
MathSpace.pl
MathParser.org - mXparser project page
mXparser on GitHub
mXparser on SourceForge
mXparser on Bitbucket
mXparser on CodePlex
Janet Sudoku - project web page
Janet Sudoku on GitHub
Janet Sudoku on CodePlex
Janet Sudoku on SourceForge
Janet Sudoku on BitBucket

See Also:

RecursiveArgument, Expression, Function, Constant

Field Summary

Fields

Modifier and Type	Field and Description
static String	LICENSE License info.
static int	PRIMES_CACHE_NOT_INITIALIZED
static PrimesCache	primesCache Prime numbers cache

Constructor Summary

Constructors

Constructor and Description
mXparser()

Method Summary

Methods

Modifier and Type	Method and Description
static double[]	arrayList2double(ArrayList<Double> numbers) Converts ArrayList of double to double[]
static boolean	checkIfEpsilonMode() Checks if epsilon comparison mode is active;
static boolean	checkIfExactMode() Checks if exact comparison mode is active;
static boolean	checkIfUlpRounding() Double floating-point precision arithmetic causes rounding problems, i.e. 0.1 + 0.1 + 0.1 is slightly different than 0.3, additionally doubles are having a lot of advantages providing flexible number representation regardless of number size. mXparser is fully based on double numbers and that is why is providing intelligent ULP rounding to minimize misleading results.
static void	consolePrint(Object o) Prints object.toString to the Console
static void	consolePrintHelp() Prints all help content.
static void	consolePrintHelp(String word) Prints filtered help content.
static void	consolePrintln() Prints new line to the Console, no new line
static void	consolePrintln(Object o) Prints object.toString to the Console + new line
static void	consolePrintTokens(ArrayList<Token> tokens) Prints tokens to the console.
static void	disableUlpRounding() Double floating-point precision arithmetic causes rounding problems, i.e. 0.1 + 0.1 + 0.1 is slightly different than 0.3, additionally doubles are having a lot of advantages providing flexible number representation regardless of number size. mXparser is fully based on double numbers and that is why is providing intelligent ULP rounding to minimize misleading results.
static void	enableUlpRounding() Double floating-point precision arithmetic causes rounding problems, i.e. 0.1 + 0.1 + 0.1 is slightly different than 0.3, additionally doubles are having a lot of advantages providing flexible number representation regardless of number size. mXparser is fully based on double numbers and that is why is providing intelligent ULP rounding to minimize misleading results.
static String	getConsoleOutput() Returns console output string, console output string is being built by consolePrintln(), consolePrint().
static double	getEpsilon() Returns current epsilon value.
static double	getFunctionValue(Expression f, Argument x, double x0) Calculates function f(x0) (given as expression) assigning Argument x = x0;
static double[]	getFunctionValues(Expression f, Argument index, double from, double to, double delta) Returns array of double values of the function f(i) calculated on the range: i = from to i = to by step = delta
static String	getHelp() General mXparser expression help
static String	getHelp(String word) General mXparser expression help - in-line key word searching
String	getLicense() Gets license info
static int	getMaxNumInPrimesCache() Returns maximum integer number in primes cache
static int	getThreadsNumber() Gets maximum threads number
static String	hexString2AsciiString(String hexString) Converts hex string into ASCII string, where each letter is represented by two hex digits (byte) from the hex string.
static void	initPrimesCache() Initialization of prime numbers cache.
static void	initPrimesCache(int mximumNumberInCache) Initialization of prime numbers cache.
static void	initPrimesCache(PrimesCache primesCache) Initialization of prime numbers cache.
static String	numberToAsciiString(double number) Converts (long)double number into ASCII string, where each letter is represented by two hex digits (byte) from the hex representation of the original number casted to long type.
static String	numberToAsciiString(int number) Converts number into ASCII string, where each letter is represented by two hex digits (byte) from the hex representation of the original number
static String	numberToAsciiString(long number) Converts number into ASCII string, where each letter is represented by two hex digits (byte) from the hex representation of the original number
static String	numberToHexString(double number) Converts (long)double number to hex string (plain text)
static String	numberToHexString(int number) Converts integer number to hex string (plain text)
static String	numberToHexString(long number) Converts long number to hex string (plain text)
static void	resetConsoleOutput() Resets console output string, console output string is being built by consolePrintln(), consolePrint().
void	setConsoleOutputPrefix(String consoleOutputPrefix) Sets console output string prefix.
void	setConsolePrefix(String consolePrefix) Sets console prefix.
void	setDefaultConsoleOutputPrefix() Sets default console output string prefix.
void	setDefaultConsolePrefix() Sets default console prefix.
static void	setDefaultEpsilon() Sets default epsilon value.
static void	setDefaultThreadsNumber() Sets default threads number
static void	setEpsilon(double epsilon) Sets epsilon value.
static void	setEpsilonComparison() Sets comparison mode to EPSILON.
static void	setExactComparison() Sets comparison mode to EXACT.
static void	setNoPrimesCache() Sets primesCache to null
static void	setRandomGenerator(Random randomGenerator) Modifies random generator used by the ProbabilityDistributions class.
static void	setThreadsNumber(int threadsNumber) Sets threads number
static void	wait(int n) Waits given number of milliseconds

Methods inherited from class java.lang.Object

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

Field Detail

primesCache

public static PrimesCache primesCache

Prime numbers cache

PRIMES_CACHE_NOT_INITIALIZED

public static final int PRIMES_CACHE_NOT_INITIALIZED

See Also:

Constant Field Values

LICENSE

public static final String LICENSE

License info.

See Also:

Constant Field Values

Constructor Detail

mXparser

public mXparser()

Method Detail

initPrimesCache

public static final void initPrimesCache()

Initialization of prime numbers cache. Cache size according to PrimesCache.DEFAULT_MAX_NUM_IN_CACHE

See Also:

PrimesCache

initPrimesCache

public static final void initPrimesCache(int mximumNumberInCache)

Initialization of prime numbers cache.

Parameters:

mximumNumberInCache - The maximum integer number that will be stored in cache.

See Also:

PrimesCache

initPrimesCache

public static final void initPrimesCache(PrimesCache primesCache)

Initialization of prime numbers cache.

Parameters:

primesCache - The primes cache object

See Also:

PrimesCache

setNoPrimesCache

public static void setNoPrimesCache()

Sets primesCache to null

getMaxNumInPrimesCache

public static final int getMaxNumInPrimesCache()

Returns maximum integer number in primes cache

Returns:

If primes cache was initialized then maximum number in primes cache, otherwise PRIMES_CACHE_NOT_INITIALIZED

getThreadsNumber

public static final int getThreadsNumber()

Gets maximum threads number

Returns:

Threads number.

setDefaultThreadsNumber

public static final void setDefaultThreadsNumber()

Sets default threads number

setThreadsNumber

public static final void setThreadsNumber(int threadsNumber)

Sets threads number

Parameters:

threadsNumber - Thread number.

getFunctionValue

public static final double getFunctionValue(Expression f,
                      Argument x,
                      double x0)

Calculates function f(x0) (given as expression) assigning Argument x = x0;

Parameters:

f - the expression

x - the argument

x0 - the argument value

Returns:

f.calculate()

See Also:

Expression

arrayList2double

public static final double[] arrayList2double(ArrayList<Double> numbers)

Converts ArrayList of double to double[]

Parameters:

numbers - the numbers list

Returns:

numbers array

getFunctionValues

public static final double[] getFunctionValues(Expression f,
                         Argument index,
                         double from,
                         double to,
                         double delta)

Returns array of double values of the function f(i) calculated on the range: i = from to i = to by step = delta

Parameters:

f - Function expression

index - Index argument

from - 'from' value

to - 'to' value

delta - 'delta' step definition

Returns:

Array of function values

setRandomGenerator

public static final void setRandomGenerator(Random randomGenerator)

Modifies random generator used by the ProbabilityDistributions class.

Parameters:

randomGenerator - Random generator.

See Also:

ProbabilityDistributions, ProbabilityDistributions.randomGenerator

setExactComparison

public static final void setExactComparison()

Sets comparison mode to EXACT.

See Also:

BinaryRelations

setEpsilonComparison

public static final void setEpsilonComparison()

Sets comparison mode to EPSILON.

See Also:

BinaryRelations

setEpsilon

public static final void setEpsilon(double epsilon)

Sets epsilon value.

Parameters:

epsilon - Epsilon value (grater than 0).

See Also:

setEpsilonComparison(), BinaryRelations

setDefaultEpsilon

public static final void setDefaultEpsilon()

Sets default epsilon value.

See Also:

setEpsilonComparison(), BinaryRelations.DEFAULT_COMPARISON_EPSILON, BinaryRelations

getEpsilon

public static final double getEpsilon()

Returns current epsilon value.

Returns:

Returns current epsilon value.

See Also:

setEpsilonComparison(), BinaryRelations

checkIfEpsilonMode

public static final boolean checkIfEpsilonMode()

Checks if epsilon comparison mode is active;

Returns:

True if epsilon mode is active, otherwise returns false.

See Also:

setEpsilonComparison(), setExactComparison(), BinaryRelations

checkIfExactMode

public static final boolean checkIfExactMode()

Checks if exact comparison mode is active;

Returns:

True if exact mode is active, otherwise returns false.

See Also:

setEpsilonComparison(), setExactComparison(), BinaryRelations

enableUlpRounding

public static final void enableUlpRounding()

Double floating-point precision arithmetic causes rounding problems, i.e. 0.1 + 0.1 + 0.1 is slightly different than 0.3, additionally doubles are having a lot of advantages providing flexible number representation regardless of number size. mXparser is fully based on double numbers and that is why is providing intelligent ULP rounding to minimize misleading results. By default this option is enabled resulting in automatic rounding only in some cases. Using this mode 0.1 + 0.1 + 0.1 = 0.3

disableUlpRounding

public static final void disableUlpRounding()

Double floating-point precision arithmetic causes rounding problems, i.e. 0.1 + 0.1 + 0.1 is slightly different than 0.3, additionally doubles are having a lot of advantages providing flexible number representation regardless of number size. mXparser is fully based on double numbers and that is why is providing intelligent ULP rounding to minimize misleading results. By default this option is enabled resulting in automatic rounding only in some cases. Disabling this mode 0.1 + 0.1 + 0.1 will be slightly different than 0.3.

checkIfUlpRounding

public static final boolean checkIfUlpRounding()

Double floating-point precision arithmetic causes rounding problems, i.e. 0.1 + 0.1 + 0.1 is slightly different than 0.3, additionally doubles are having a lot of advantages providing flexible number representation regardless of number size. mXparser is fully based on double numbers and that is why is providing intelligent ULP rounding to minimize misleading results. By default this option is enabled resulting in automatic rounding only in some cases. Using this mode 0.1 + 0.1 + 0.1 = 0.3

Returns:

True if ULP rounding is enabled, otherwise false.

numberToHexString

public static final String numberToHexString(int number)

Converts integer number to hex string (plain text)

Parameters:

number - Integer number

Returns:

Hex string (i.e. FF23)

numberToHexString

public static final String numberToHexString(long number)

Converts long number to hex string (plain text)

Parameters:

number - Long number

Returns:

Hex string (i.e. FF23)

numberToHexString

public static final String numberToHexString(double number)

Converts (long)double number to hex string (plain text)

Parameters:

number - Double number

Returns:

Hex string (i.e. FF23)

hexString2AsciiString

public static final String hexString2AsciiString(String hexString)

Converts hex string into ASCII string, where each letter is represented by two hex digits (byte) from the hex string.

Parameters:

hexString - Hex string (i.e. 48656C6C6F)

Returns:

ASCII string (i.e. '48656C6C6F' = 'Hello')

numberToAsciiString

public static final String numberToAsciiString(int number)

Converts number into ASCII string, where each letter is represented by two hex digits (byte) from the hex representation of the original number

Parameters:

number - Integer number (i.e. 310939249775 = '48656C6C6F')

Returns:

ASCII string (i.e. '48656C6C6F' = 'Hello')

numberToAsciiString

public static final String numberToAsciiString(long number)

Converts number into ASCII string, where each letter is represented by two hex digits (byte) from the hex representation of the original number

Parameters:

number - Long number (i.e. 310939249775 = '48656C6C6F')

Returns:

ASCII string (i.e. '48656C6C6F' = 'Hello')

numberToAsciiString

public static final String numberToAsciiString(double number)

Converts (long)double number into ASCII string, where each letter is represented by two hex digits (byte) from the hex representation of the original number casted to long type.

Parameters:

number - Double number (i.e. 310939249775 = '48656C6C6F')

Returns:

ASCII string (i.e. '48656C6C6F' = 'Hello')

consolePrintln

public static final void consolePrintln(Object o)

Prints object.toString to the Console + new line

Parameters:

o - Object to print

consolePrintln

public static final void consolePrintln()

Prints new line to the Console, no new line

consolePrint

public static final void consolePrint(Object o)

Prints object.toString to the Console

Parameters:

o - Object to print

resetConsoleOutput

public static final void resetConsoleOutput()

Resets console output string, console output string is being built by consolePrintln(), consolePrint().

See Also:

consolePrint(Object), consolePrintln(Object), consolePrintln(), resetConsoleOutput()

setDefaultConsolePrefix

public void setDefaultConsolePrefix()

Sets default console prefix.

setDefaultConsoleOutputPrefix

public void setDefaultConsoleOutputPrefix()

Sets default console output string prefix.

setConsolePrefix

public void setConsolePrefix(String consolePrefix)

Sets console prefix.

Parameters:

consolePrefix - String containing console prefix definition.

setConsoleOutputPrefix

public void setConsoleOutputPrefix(String consoleOutputPrefix)

Sets console output string prefix.

Parameters:

consoleOutputPrefix - String containing console output prefix definition.

getConsoleOutput

public static final String getConsoleOutput()

Returns console output string, console output string is being built by consolePrintln(), consolePrint().

Returns:

Console output string

See Also:

consolePrint(Object), consolePrintln(Object), consolePrintln(), resetConsoleOutput()

getHelp

public static final String getHelp()

General mXparser expression help

Returns:

String with all general help content

getHelp

public static final String getHelp(String word)

General mXparser expression help - in-line key word searching

Parameters:

word - Key word to be searched

Returns:

String with all help content lines containing given keyword

consolePrintHelp

public static final void consolePrintHelp()

Prints all help content.

consolePrintHelp

public static final void consolePrintHelp(String word)

Prints filtered help content.

Parameters:

word - Key word.

consolePrintTokens

public static final void consolePrintTokens(ArrayList<Token> tokens)

Prints tokens to the console.

Parameters:

tokens - Tokens list.

See Also:

Expression.getCopyOfInitialTokens(), Token

getLicense

public String getLicense()

Gets license info

Returns:

license info as string

wait

public static void wait(int n)

Waits given number of milliseconds

Parameters:

n - Number of milliseconds