jhelp.util.math.formal

Class Constant

java.lang.Object

jhelp.util.math.formal.Function

jhelp.util.math.formal.Constant

All Implemented Interfaces:

java.lang.Comparable<Function>

public class Constant
extends Function

Represents a constant

Author:

JHelp

Nested Class Summary

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

Function.DefaultSimplifier

Field Summary

Fields

Modifier and Type	Field and Description
static Constant	E e
static Constant	MINUS_ONE -1
static Constant	ONE 1
static Constant	PI π
private double	real Real value
static Constant	TWO 2
static Constant	UNDEFINED The constant is undefined due illegal operation like division by zero, take the logarithm of negative value, ...
static Constant	ZERO 0

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

COMPARATOR, references

Constructor Summary

Constructors

Constructor and Description
Constant(double real) Constructs the constant

Method Summary

Methods

Modifier and Type	Method and Description
Constant	absoluteValue() Absolute value of constant
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
boolean	isMinusOne() Indicates if the constant is -1
boolean	isNegative() Indicates if constants is < 0
boolean	isNul() Indicates if the constant is 0
boolean	isOne() Indicates if the constant is 1
boolean	isPositive() Indicates if constants is > 0
boolean	isRealValueNumber() Indicates if function can see as real number, that is to say that the value of obtainRealValueNumber() as as meaning
boolean	isUndefined() Indicates if the constant is undefined
static Constant	MOINS_UN_PUISSANCE(int n) Give the -1n constant
Constant	multipleDePi() Return the constant divide by Pi
double	obtainRealValueNumber() Real value of function, if the function can be represents by a real number.
Constant	puissanceDeE() Return the Neperian logarithm apply to the constant
java.lang.String	realString() Real string representation
Function	replace(Variable variable, Function function) Replace variable list by function
Constant	sign() Constant sign
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, obtainFunctionSimplifier, parse, 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

E

public static final Constant E

e

MINUS_ONE

public static final Constant MINUS_ONE

-1

ONE

public static final Constant ONE

1

PI

public static final Constant PI

π

TWO

public static final Constant TWO

2

UNDEFINED

public static final Constant UNDEFINED

The constant is undefined due illegal operation like division by zero, take the logarithm of negative value, ...

ZERO

public static final Constant ZERO

0

real

private final double real

Real value

Constructor Detail

Constant

public Constant(double real)

Constructs the constant

Parameters:

real - Value

Method Detail

MOINS_UN_PUISSANCE

public static Constant MOINS_UN_PUISSANCE(int n)

Give the -1ⁿ constant

Parameters:

n - Power to apply to -1

Returns:

The constant result

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)

absoluteValue

public Constant absoluteValue()

Absolute value of constant

Returns:

Absolute value of constant

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()

isMinusOne

public boolean isMinusOne()

Indicates if the constant is -1

Returns:

true the constant is -1

isNegative

public boolean isNegative()

Indicates if constants is < 0

Returns:

true if constants is < 0

isNul

public boolean isNul()

Indicates if the constant is 0

Returns:

true if the constant is 0

isOne

public boolean isOne()

Indicates if the constant is 1

Returns:

true if the constant is 1

isPositive

public boolean isPositive()

Indicates if constants is > 0

Returns:

true if constants is > 0

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

See Also:

Function.isRealValueNumber()

isUndefined

public boolean isUndefined()

Indicates if the constant is undefined

Returns:

true if the constant is undefined

multipleDePi

public Constant multipleDePi()

Return the constant divide by Pi

Returns:

Constant divide by Pi

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()

puissanceDeE

public Constant puissanceDeE()

Return the Neperian logarithm apply to the constant

Returns:

Neperian logarithm apply to the constant

realString

public java.lang.String realString()

Real string representation

Overrides:

realString in class Function

Returns:

Real string representation

replace

public Function replace(Variable variable,
               Function function)

Replace variable list 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)

sign

public Constant sign()

Constant sign

Returns:

Constant sign

toString

public java.lang.String toString()

String that represents the function

Specified by:

toString in class Function

Returns:

String representation

See Also:

Object.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()