Package org.apfloat.calc

Interface CalculatorImpl

All Known Implementing Classes:

AbstractCalculatorImpl, ApfloatCalculatorImpl, FunctionCalculatorImpl

public interface CalculatorImpl

Calculator implementation interface. The calculator parser uses this interface to perform the actual calculations.

Version:

1.14.0

Method Summary

Modifier and Type	Method	Description
java.lang.Number	add(java.lang.Number x, java.lang.Number y)	Addition.
java.lang.Number	divide(java.lang.Number x, java.lang.Number y)	Division.
java.lang.Number	doubleFactorial(java.lang.Number x)	Double factorial.
java.lang.Number	factorial(java.lang.Number x)	Factorial.
java.lang.String	format(java.lang.Number x)	Convert a number to a String.
java.lang.Number	function(java.lang.String name, java.util.List<java.lang.Number> arguments)	Arbitrary function.
java.lang.Number	getVariable(java.lang.String name)	Get a variable.
java.lang.Number	mod(java.lang.Number x, java.lang.Number y)	Remainder.
java.lang.Number	multiply(java.lang.Number x, java.lang.Number y)	Multiplication.
java.lang.Number	negate(java.lang.Number x)	Negative value.
java.lang.Number	parseDecimal(java.lang.String value)	Parse a string to a floating-point number.
java.lang.Number	parseInteger(java.lang.String value)	Parse a string to an integer number.
java.lang.Number	pow(java.lang.Number x, java.lang.Number y)	Power.
void	setFormat(boolean pretty)	Set the formatting option.
void	setInputPrecision(java.lang.Long inputPrecision)	Set a fixed input precision.
void	setVariable(java.lang.String name, java.lang.Number value)	Set a variable.
java.lang.Number	subtract(java.lang.Number x, java.lang.Number y)	Subtraction.

Method Detail

negate

java.lang.Number negate(java.lang.Number x)
                 throws ParseException

Negative value.

Parameters:

x - The argument.

Returns:

-x

Throws:

ParseException - In case of invalid argument.

add

java.lang.Number add(java.lang.Number x,
                     java.lang.Number y)
              throws ParseException

Addition.

Parameters:

x - First argument.

y - Second argument.

Returns:

x + y

Throws:

ParseException - In case of invalid arguments.

subtract

java.lang.Number subtract(java.lang.Number x,
                          java.lang.Number y)
                   throws ParseException

Subtraction.

Parameters:

x - First argument.

y - Second argument.

Returns:

x - y

Throws:

ParseException - In case of invalid arguments.

multiply

java.lang.Number multiply(java.lang.Number x,
                          java.lang.Number y)
                   throws ParseException

Multiplication.

Parameters:

x - First argument.

y - Second argument.

Returns:

x * y

Throws:

ParseException - In case of invalid arguments.

divide

java.lang.Number divide(java.lang.Number x,
                        java.lang.Number y)
                 throws ParseException

Division.

Parameters:

x - First argument.

y - Second argument.

Returns:

x / y

Throws:

ParseException - In case of invalid arguments.

mod

java.lang.Number mod(java.lang.Number x,
                     java.lang.Number y)
              throws ParseException

Remainder.

Parameters:

x - First argument.

y - Second argument.

Returns:

x % y

Throws:

ParseException - In case of invalid arguments.

pow

java.lang.Number pow(java.lang.Number x,
                     java.lang.Number y)
              throws ParseException

Power.

Parameters:

x - First argument.

y - Second argument.

Returns:

xy

Throws:

ParseException - In case of invalid arguments.

factorial

java.lang.Number factorial(java.lang.Number x)
                    throws ParseException

Factorial.

Parameters:

x - The argument.

Returns:

x!

Throws:

ParseException - In case of invalid arguments.

doubleFactorial

java.lang.Number doubleFactorial(java.lang.Number x)
                          throws ParseException

Double factorial.

Parameters:

x - The argument.

Returns:

x!!

Throws:

ParseException - In case of invalid arguments.

function

java.lang.Number function(java.lang.String name,
                          java.util.List<java.lang.Number> arguments)
                   throws ParseException

Arbitrary function.

Parameters:

name - Name of the function.

arguments - Function arguments.

Returns:

Function value.

Throws:

ParseException - In case of invalid arguments.

parseInteger

java.lang.Number parseInteger(java.lang.String value)
                       throws ParseException

Parse a string to an integer number.

Parameters:

value - The string to parse.

Returns:

The number.

Throws:

ParseException - In case of invalid number.

parseDecimal

java.lang.Number parseDecimal(java.lang.String value)
                       throws ParseException

Parse a string to a floating-point number.

Parameters:

value - The string to parse.

Returns:

The number.

Throws:

ParseException - In case of invalid number.

getVariable

java.lang.Number getVariable(java.lang.String name)
                      throws ParseException

Get a variable.

Parameters:

name - Name of the variable.

Returns:

Value of the variable, or null if the variable is not defined.

Throws:

ParseException - In case of invalid argument.

setVariable

void setVariable(java.lang.String name,
                 java.lang.Number value)
          throws ParseException

Set a variable.

Parameters:

name - Name of the variable.

value - Value of the variable.

Throws:

ParseException - In case of invalid arguments.

setFormat

void setFormat(boolean pretty)

Set the formatting option.

Parameters:

pretty - If a fixed-point or a floating-point notation should be used.

setInputPrecision

void setInputPrecision(java.lang.Long inputPrecision)

Set a fixed input precision.

Parameters:

inputPrecision - The precision if a fixed precision is used or null for arbitrary precision.

format

java.lang.String format(java.lang.Number x)

Convert a number to a String. The current formatting option is used.

Parameters:

x - The number.

Returns:

The String.