jhelp.util.math.formal

Class Function

java.lang.Object

jhelp.util.math.formal.Function

All Implemented Interfaces:

java.lang.Comparable<Function>

Direct Known Subclasses:

BinaryOperator, Constant, UnaryOperator, Variable

public abstract class Function
extends java.lang.Object
implements java.lang.Comparable<Function>

Represents a mathematical function in formal format

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Function.DefaultSimplifier Simplifier of function by default.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<Function>	COMPARATOR Comparator of 2 functions
private Function.DefaultSimplifier	defaultSimplifier The default function simplifier
protected static ConstantsReferences	references Actual constant reference

Constructor Summary

Constructors

Constructor and Description
Function() Function empty

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.String	addParentheses(java.lang.String string) Add parentheses to respect the operator priority
static boolean	allEquals(Function function, Function... functions) Indicates if several functions are equals each others
int	compareTo(Function function) Compare with an other function Parent documentation:
protected abstract int	compareToInternal(Function function) Internal comparison
static Function	createAddition(Function... functions) Create an addition of several functions
static Function	createMultiplication(Function... functions) Create an multiplication of several functions
Function	derive(java.lang.String... list) Derive with several variable
Function	derive(java.lang.String variable) Derive the function
abstract Function	derive(Variable variable) Derive the function
Function	derive(VariableList list) Derive with several variable
boolean	equals(java.lang.Object object) Indicates if an object is equals to the function
abstract boolean	functionIsEquals(Function function) Indicates if a function is equals to this function
protected boolean	functionIsEqualsMoreSimple(Function function) Indicates if function is equals, the equality test is more simple than functionIsEquals(Function) its use internally for simplifyMaximum()
protected static java.lang.String	getArgument(java.lang.String string) Give the "parameter" of the string
abstract Function	getCopy() Copy the function
private static boolean	isBinaryOperator(char car) Indicates if a character is binary operator
abstract boolean	isRealValueNumber() Indicates if function can see as real number, that is to say that the value of obtainRealValueNumber() as as meaning
FunctionSimplifier	obtainFunctionSimplifier() Obtain the simplifier of the function.
abstract double	obtainRealValueNumber() Real value of function, if the function can be represents by a real number.
static Function	parse(java.lang.String function) Parse string to function.
java.lang.String	realString() Real string representation
Function	replace(java.lang.String variable, double constant) Replace variable by constant
Function	replace(java.lang.String variable, Function function) Replace variable by function
Function	replace(Variable variable, double constant) Replace variable by constant
abstract Function	replace(Variable variable, Function function) Replace variable by function
static void	setConstantsReferences(ConstantsReferences references) Modify the constants reference This reference says what variable name can be replace by constant, example : PI replace by 3.1415926535897932384626433832795
Function	simplify() Simplify the function
Function	simplifyMaximum() Simplify at maximum the function
Function	simplifyMaximum(java.io.PrintStream printStream) Simplify at maximum the function on printing each steps
abstract java.lang.String	toString() String that represents the function
Function	totalDerive() Total derive
abstract VariableList	variableList() Variable list contains in this function

Methods inherited from class java.lang.Object

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

Field Detail

references

protected static ConstantsReferences references

Actual constant reference

COMPARATOR

public static final java.util.Comparator<Function> COMPARATOR

Comparator of 2 functions

defaultSimplifier

private Function.DefaultSimplifier defaultSimplifier

The default function simplifier

Constructor Detail

Function

public Function()

Function empty

Method Detail

addParentheses

private static java.lang.String addParentheses(java.lang.String string)

Add parentheses to respect the operator priority

Parameters:

string - String to add parentheses

Returns:

String with parentheses

isBinaryOperator

private static boolean isBinaryOperator(char car)

Indicates if a character is binary operator

Parameters:

car - Tested character

Returns:

true if character is binary operator

getArgument

protected static java.lang.String getArgument(java.lang.String string)

Give the "parameter" of the string

Parameters:

string - String to parse

Returns:

Extracted "parameter"

allEquals

public static final boolean allEquals(Function function,
                Function... functions)

Indicates if several functions are equals each others

Parameters:

function - Function reference

functions - Functions tests to be equals to the references

Returns:

true if all functions are equals to the reference

createAddition

public static Function createAddition(Function... functions)

Create an addition of several functions

Parameters:

functions - Functions list

Returns:

Created function

createMultiplication

public static Function createMultiplication(Function... functions)

Create an multiplication of several functions

Parameters:

functions - Functions list

Returns:

Created function

parse

public static Function parse(java.lang.String function)

Parse string to function.
This function is case sensitive
Reserved word/symbol :

Symbol	Explanations
+	Addition
-	Subtraction It also represents the unary minus (Take the opposite sign)
*	Multiplication
/	Division
cos	Cosinus
exp	Exponential
ln	Logarithm Neperian
sin	Sinus
tan	Tangent

Real number are treat as constants. The decimal separator is the dot (.) symbol ex: 3.21
Other symbols/words are treats as variable

Parameters:

function - String to parse

Returns:

Function parsed

setConstantsReferences

public static void setConstantsReferences(ConstantsReferences references)

Modify the constants reference
This reference says what variable name can be replace by constant, example : PI replace by 3.1415926535897932384626433832795

Parameters:

references - New reference

compareToInternal

protected abstract int compareToInternal(Function function)

Internal comparison

Parameters:

function - Function sure be the instance of the function

Returns:

Comparison

functionIsEqualsMoreSimple

protected boolean functionIsEqualsMoreSimple(Function function)

Indicates if function is equals, the equality test is more simple than functionIsEquals(Function) its use internally for simplifyMaximum()

Parameters:

function - Function to compare with

Returns:

true if equals

See Also:

functionIsEqualsMoreSimple(jhelp.util.math.formal.Function)

compareTo

public int compareTo(Function function)

Compare with an other function

Parent documentation:

Specified by:

compareTo in interface java.lang.Comparable<Function>

Parameters:

function - Function to compare

Returns:

Comparison

See Also:

Comparable.compareTo(java.lang.Object)

derive

public final Function derive(java.lang.String variable)

Derive the function

Parameters:

variable - Variable for derive

Returns:

Derived

derive

public final Function derive(java.lang.String... list)

Derive with several variable

Parameters:

list - Variable list

Returns:

Derive

derive

public abstract Function derive(Variable variable)

Derive the function

Parameters:

variable - Variable for derive

Returns:

Derived

derive

public final Function derive(VariableList list)

Derive with several variable

Parameters:

list - Variable list

Returns:

Derive

equals

public final boolean equals(java.lang.Object object)

Indicates if an object is equals to the function

Overrides:

equals in class java.lang.Object

Parameters:

object - Tested object

Returns:

true if equals

See Also:

Object.equals(java.lang.Object)

functionIsEquals

public abstract boolean functionIsEquals(Function function)

Indicates if a function is equals to this function

Parameters:

function - Function tested

Returns:

true if there sure equals. false dosen't mean not equals, but not sure about equality

getCopy

public abstract Function getCopy()

Copy the function

Returns:

Copy

isRealValueNumber

public abstract boolean isRealValueNumber()

Indicates if function can see as real number, that is to say that the value of obtainRealValueNumber() as as meaning

Returns:

true if the function can see as real number

obtainFunctionSimplifier

public FunctionSimplifier obtainFunctionSimplifier()

Obtain the simplifier of the function.
Override this function to provide a simplifier that is not the default one

Returns:

Simplifier link to the function

obtainRealValueNumber

public abstract double obtainRealValueNumber()

Real value of function, if the function can be represents by a real number. Else Double.NaN is return

Returns:

Variable value or Double.NaN if not define

realString

public java.lang.String realString()

Real string representation

Returns:

Real string representation

replace

public final Function replace(java.lang.String variable,
               double constant)

Replace variable by constant

Parameters:

variable - Variable to replace

constant - Constant for replace

Returns:

Result function

replace

public final Function replace(java.lang.String variable,
               Function function)

Replace variable by function

Parameters:

variable - Variable to replace

function - Function for replace

Returns:

Result function

replace

public final Function replace(Variable variable,
               double constant)

Replace variable by constant

Parameters:

variable - Variable to replace

constant - Constant for replace

Returns:

Result function

replace

public abstract Function replace(Variable variable,
               Function function)

Replace variable by function

Parameters:

variable - Variable to replace

function - Function for replace

Returns:

Result function

simplify

public final Function simplify()

Simplify the function

Returns:

Simplified function

simplifyMaximum

public final Function simplifyMaximum()

Simplify at maximum the function

Returns:

The most simple version of the function

simplifyMaximum

public final Function simplifyMaximum(java.io.PrintStream printStream)

Simplify at maximum the function on printing each steps

Parameters:

printStream - Where print the steps

Returns:

The most simple version of the function

toString

public abstract java.lang.String toString()

String that represents the function

Overrides:

toString in class java.lang.Object

Returns:

String representation

See Also:

Object.toString()

totalDerive

public final Function totalDerive()

Total derive

Returns:

Total derive

variableList

public abstract VariableList variableList()

Variable list contains in this function

Returns:

Variable list contains in this function