Package functions.endpoint

Class Constant

Object

GeneralFunction

EndpointFunction

Constant

All Implemented Interfaces:

Differentiable, Evaluable, Outputable, Simplifiable, Comparable<GeneralFunction>, Iterable<GeneralFunction>, OutputFunction

public class Constant
extends EndpointFunction

Field Summary

Fields

Modifier and Type	Field	Description
double	constant	The numerical value of the constant
@Nullable String	constantKey	The string relating to this special constant (null if normal constant)
static HashMap<String,Double>	specialConstants	Symbols or Strings with a dedicated value.

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Constant(double constant)	Constructs a new Constant from the specified numerical value
Constant(String constantKey)	Constructs a new special Constant from its String

Method Summary

Modifier and Type	Method	Description
static double	addSpecialConstant(String string, double value)	Defines a new special constant
GeneralFunction	clone()	Returns a clone of this GeneralFunction
int	compareSelf(GeneralFunction that)	Used internally for comparing two functions of the same exact type
boolean	equalsFunction(GeneralFunction that)	Returns true when the two fully-simplified functions are equal
double	evaluate(Map<String,Double> variableValues)	Evaluates a GeneralFunction at a point denoted by a Map
GeneralFunction	getDerivative(String varID)	Returns the derivative of a GeneralFunction with respect to a variable.
static double	getSpecialConstant(String string)	Returns the value of a special constant
int	hashCode()	Returns a hash code value for this object
boolean	isSpecial()	Returns true if the Constant is a special Constant
static boolean	isSpecialConstant(String string)	Returns true if string is a special Constant
static double	removeSpecialConstant(String string)	Removes a special constant
static void	resetConstants()
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
GeneralFunction	substituteAll(Predicate<? super GeneralFunction> test, Function<? super GeneralFunction,? extends GeneralFunction> replacer)	Replaces every GeneralFunction that satisfies the test using the action specified by replacer
String	toString()	Returns a String representation of this GeneralFunction

Methods inherited from class EndpointFunction

getName, getOperands, iterator, toLatex, toOutputFunction

Methods inherited from class GeneralFunction

compareTo, derivativeAt, equals, equalsSimplified, getNthDerivative, getSimplifiedDerivative, substituteVariables

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface OutputFunction

equals

Field Details

specialConstants

public static final HashMap<String,Double> specialConstants

Symbols or Strings with a dedicated value. The defaults are π and e.

constant

public final double constant

The numerical value of the constant

constantKey

@Nullable public final @Nullable String constantKey

The string relating to this special constant (null if normal constant)

Constructor Details

Constant

public Constant(double constant)

Constructs a new Constant from the specified numerical value

Parameters:

constant - The numerical value of the constant

Constant

public Constant(String constantKey)

Constructs a new special Constant from its String

Parameters:

constantKey - The string of the special Constant

Method Details

isSpecialConstant

public static boolean isSpecialConstant(String string)

Returns true if string is a special Constant

Parameters:

string - The string that is being checked if it is a special constant

Returns:

true if string is a special Constant

getSpecialConstant

public static double getSpecialConstant(String string)

Returns the value of a special constant

Parameters:

string - name of constant

Returns:

the value of the constant

addSpecialConstant

public static double addSpecialConstant(String string, double value)

Defines a new special constant

Parameters:

string - name of constant

value - value of constant

Returns:

the value of the constant for convenience

removeSpecialConstant

public static double removeSpecialConstant(String string)

Removes a special constant

Parameters:

string - name of constant

Returns:

the value of the constant

evaluate

public double evaluate(Map<String,Double> variableValues)

Description copied from interface: Evaluable

Evaluates a GeneralFunction at a point denoted by a Map

Parameters:

variableValues - the values of the variables in the GeneralFunction at the point

Returns:

the value of the GeneralFunction at the point

isSpecial

public boolean isSpecial()

Returns true if the Constant is a special Constant

Returns:

true if the Constant is a special Constant

toString

public String toString()

Description copied from class: GeneralFunction

Returns a String representation of this GeneralFunction

Specified by:

toString in interface OutputFunction

Specified by:

toString in class GeneralFunction

Returns:

String representation of this function

getDerivative

public GeneralFunction getDerivative(String varID)

Description copied from interface: Differentiable

Returns the derivative of a GeneralFunction with respect to a variable. Should not be used in general; GeneralFunction.getSimplifiedDerivative(java.lang.String) is strongly preferred.

Parameters:

varID - the ID of the variable that is differentiated against

Returns:

the derivative of the function with respect to varID

clone

public GeneralFunction clone()

Description copied from class: GeneralFunction

Returns a clone of this GeneralFunction

Specified by:

clone in class GeneralFunction

Returns:

a clone of this function

simplify

public GeneralFunction simplify()

Description copied from interface: Simplifiable

Returns this GeneralFunction, simplified

Returns:

the simplified function

substituteAll

public GeneralFunction substituteAll(Predicate<? super GeneralFunction> test, Function<? super GeneralFunction,? extends GeneralFunction> replacer)

Description copied from class: GeneralFunction

Replaces every GeneralFunction that satisfies the test using the action specified by replacer

Overrides:

substituteAll in class EndpointFunction

Parameters:

test - checks if the function should be replaced

replacer - replaces the function

Returns:

a new GeneralFunction with all replacements made

equalsFunction

public boolean equalsFunction(GeneralFunction that)

Description copied from class: GeneralFunction

Returns true when the two fully-simplified functions are equal

Specified by:

equalsFunction in class GeneralFunction

Parameters:

that - The GeneralFunction that the current function is being checked against

Returns:

true if the two functions are equal

resetConstants

public static void resetConstants()

compareSelf

public int compareSelf(GeneralFunction that)

Description copied from class: GeneralFunction

Used internally for comparing two functions of the same exact type

Specified by:

compareSelf in class GeneralFunction

Parameters:

that - the GeneralFunction that this is compared against

Returns:

the comparison

hashCode

public int hashCode()

Description copied from class: GeneralFunction

Returns a hash code value for this object

Specified by:

hashCode in interface OutputFunction

Specified by:

hashCode in class GeneralFunction

Returns:

a hash code value for this object