jhelp.util.math.formal

Class Variable

java.lang.Object

jhelp.util.math.formal.Function

jhelp.util.math.formal.Variable

All Implemented Interfaces:

java.lang.Comparable<Function>

public class Variable
extends Function

Represents a variable

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Variable.VariableSimplifier Simplify a variable.

Nested classes/interfaces inherited from class jhelp.util.math.formal.Function

Function.DefaultSimplifier

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	name Variable name
private Variable.VariableSimplifier	variableSimplifier The variable simplifier instance

Fields inherited from class jhelp.util.math.formal.Function

COMPARATOR, references

Constructor Summary

Constructors

Constructor and Description
Variable(java.lang.String name) Create a variable

Method Summary

Methods

Modifier and Type	Method and Description
protected int	compareToInternal(Function function) Internal comparison Parent documentation: Internal comparison
Function	derive(Variable variable) Derive the function
boolean	functionIsEquals(Function function) Indicates if a function is equals to this function
Function	getCopy() Copy the function
java.lang.String	getName() Variable name
boolean	isRealValueNumber() Indicates if function can see as real number, that is to say that the value of obtainRealValueNumber() as as meaning
FunctionSimplifier	obtainFunctionSimplifier() Simplify the variable.
double	obtainRealValueNumber() Real value of function, if the function can be represents by a real number.
Function	replace(Variable variable, Function function) Replace variable by function
java.lang.String	toString() String that represents the function
VariableList	variableList() Variable list contains in this function

Methods inherited from class jhelp.util.math.formal.Function

allEquals, compareTo, createAddition, createMultiplication, derive, derive, derive, equals, functionIsEqualsMoreSimple, getArgument, parse, realString, replace, replace, replace, setConstantsReferences, simplify, simplifyMaximum, simplifyMaximum, totalDerive

Methods inherited from class java.lang.Object

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

Field Detail

variableSimplifier

private Variable.VariableSimplifier variableSimplifier

The variable simplifier instance

name

final java.lang.String name

Variable name

Constructor Detail

Variable

public Variable(java.lang.String name)

Create a variable

Parameters:

name - Variable name

Method Detail

compareToInternal

protected int compareToInternal(Function function)

Internal comparison

Parent documentation:
Internal comparison

Specified by:

compareToInternal in class Function

Parameters:

function - Function sure be the instance of the function

Returns:

Comparison

See Also:

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

derive

public Function derive(Variable variable)

Derive the function

Specified by:

derive in class Function

Parameters:

variable - Variable for derive

Returns:

Derived

See Also:

Function.derive(jhelp.util.math.formal.Variable)

functionIsEquals

public boolean functionIsEquals(Function function)

Indicates if a function is equals to this function

Specified by:

functionIsEquals in class Function

Parameters:

function - Function tested

Returns:

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

See Also:

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

getCopy

public Function getCopy()

Copy the function

Specified by:

getCopy in class Function

Returns:

Copy

See Also:

Function.getCopy()

getName

public java.lang.String getName()

Variable name

Returns:

Variable name

isRealValueNumber

public boolean isRealValueNumber()

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

Specified by:

isRealValueNumber in class Function

Returns:

true if the function can see as real number

See Also:

Function.isRealValueNumber()

obtainFunctionSimplifier

public FunctionSimplifier obtainFunctionSimplifier()

Simplify the variable.
It checks if the variable is a predefined constants. If its a predefined constants, the variable is replace by its value.

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

Overrides:

obtainFunctionSimplifier in class Function

Returns:

Function simplified

See Also:

Function.obtainFunctionSimplifier()

obtainRealValueNumber

public double obtainRealValueNumber()

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

Specified by:

obtainRealValueNumber in class Function

Returns:

Variable value or Double.NaN if not define

See Also:

Function.obtainRealValueNumber()

replace

public Function replace(Variable variable,
               Function function)

Replace variable by function

Specified by:

replace in class Function

Parameters:

variable - Variable to replace

function - Function for replace

Returns:

Result function

See Also:

Function.replace(jhelp.util.math.formal.Variable, jhelp.util.math.formal.Function)

toString

public java.lang.String toString()

String that represents the function

Specified by:

toString in class Function

Returns:

String representation

See Also:

Function.toString()

variableList

public VariableList variableList()

Variable list contains in this function

Specified by:

variableList in class Function

Returns:

Variable list contains in this function

See Also:

Function.variableList()