Package functions.endpoint

Class Variable

Object

GeneralFunction

EndpointFunction

Variable

All Implemented Interfaces:

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

public class Variable
extends EndpointFunction

Field Summary

Fields

Modifier and Type	Field	Description
String	varID	The String representing this variable

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Variable(String varID)	Constructs a new Variable

Method Summary

Modifier and Type	Method	Description
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.
int	hashCode()	Returns a hash code value for this object
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
String	toString()	Returns a String representation of this GeneralFunction

Methods inherited from class EndpointFunction

getName, getOperands, iterator, substituteAll, 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

varID

public final String varID

The String representing this variable

Constructor Details

Variable

public Variable(String varID)

Constructs a new Variable

Parameters:

varID - The variable's representative String

Method Details

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

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

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

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

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