Object

GeneralFunction

All Implemented Interfaces:: Differentiable, Evaluable, Outputable, Simplifiable, Comparable<GeneralFunction>, Iterable<GeneralFunction>

Direct Known Subclasses:: BinaryFunction, CommutativeFunction, EndpointFunction, UnitaryFunction

public abstract class GeneralFunction
extends Object
implements Evaluable, Differentiable, Simplifiable, Comparable<GeneralFunction>, Iterable<GeneralFunction>, Outputable

A GeneralFunction is the generalized abstract function used throughout the CAS. It is critical to note that ALL FUNCTIONS ARE IMMUTABLE: as a consequence, methods such as Simplifiable.simplify() return a function that has been simplified rather than simplifying the caller in place.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,GeneralFunction>`	`derivatives`	Caches derivatives with the key corresponding to the `varID` of the derivative
`static Class<?>[]`	`sortOrder`	Describes the order that a `GeneralFunction` should appear in a sorted array (used in `compareTo(GeneralFunction)`)

Constructor Summary

Constructors

Constructor Description

GeneralFunction()

Method Summary

Modifier and Type	Method	Description
`abstract GeneralFunction`	`clone()`	Returns a clone of this `GeneralFunction`
`protected abstract int`	`compareSelf(GeneralFunction that)`	Used internally for comparing two functions of the same exact type
`int`	`compareTo(@NotNull GeneralFunction that)`	`GeneralFunction`s of different types are sorted according to `sortOrder` and `MiscTools.findClassValue(GeneralFunction)`, and functions of the same exact type are sorted using `compareSelf(GeneralFunction)`
`double`	`derivativeAt(String varID, Map<String,Double> point)`	Returns the value of the derivative at `point`
`boolean`	`equals(Object that)`	Compares two functions with `equalsFunction(GeneralFunction)`
`abstract boolean`	`equalsFunction(GeneralFunction that)`	Returns true when the two fully-simplified functions are equal
`boolean`	`equalsSimplified(GeneralFunction that)`	Simplifies the two functions, then compares them with `equalsFunction(GeneralFunction)`
`GeneralFunction`	`getNthDerivative(String varID, int N)`	Returns the `N`th derivative of a `GeneralFunction` with respect to a variable
`GeneralFunction`	`getSimplifiedDerivative(String varID)`
`abstract int`	`hashCode()`	Returns a hash code value for this object
`abstract @NotNull Iterator<GeneralFunction>`	`iterator()`	Returns an iterator over the operands of this `GeneralFunction`
`abstract 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`
`GeneralFunction`	`substituteVariables(Map<String,? extends GeneralFunction> toSubstitute)`	Substitutes variables with functions as specified in a map
`abstract String`	`toString()`	Returns a String representation of this `GeneralFunction`

Methods inherited from class Object

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

Methods inherited from interface Differentiable

getDerivative

Methods inherited from interface Evaluable

evaluate

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Outputable

toOutputFunction

Methods inherited from interface Simplifiable

simplify

Field Details
- sortOrder
  
  public static final Class<?>[] sortOrder
  
  Describes the order that a GeneralFunction should appear in a sorted array (used in compareTo(GeneralFunction))
- derivatives
  
  protected final Map<String,GeneralFunction> derivatives
  
  Caches derivatives with the key corresponding to the varID of the derivative
Constructor Details
- GeneralFunction
  
  public GeneralFunction()
Method Details
- toString
  
  public abstract String toString()
  
  Returns a String representation of this GeneralFunction
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  String representation of this function
- clone
  
  public abstract GeneralFunction clone()
  
  Returns a clone of this GeneralFunction
  
  Overrides:
  
  clone in class Object
  
  Returns:
  
  a clone of this function
- getSimplifiedDerivative
  
  public GeneralFunction getSimplifiedDerivative(String varID)
- getNthDerivative
  
  public GeneralFunction getNthDerivative(String varID, int N)
  
  Description copied from interface: Differentiable
  
  Returns the Nth derivative of a GeneralFunction with respect to a variable
  
  Specified by:
  
  getNthDerivative in interface Differentiable
  
  Parameters:
  
  varID - the ID of the variable that is differentiated against
  
  N - the amount of times to differentiate
  
  Returns:
  
  the Nth derivative of the function with respect to varID
- derivativeAt
  
  public double derivativeAt(String varID, Map<String,Double> point)
  
  Returns the value of the derivative at point
  
  Parameters:
  
  varID - the variable being differentiated against
  
  point - the point to find the derivative at
  
  Returns:
  
  the value of the derivative at point
- substituteAll
  
  public abstract 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
  
  Parameters:
  
  test - checks if the function should be replaced
  
  replacer - replaces the function
  
  Returns:
  
  a new GeneralFunction with all replacements made
- substituteVariables
  
  public GeneralFunction substituteVariables(Map<String,? extends GeneralFunction> toSubstitute)
  
  Substitutes variables with functions as specified in a map
  
  Parameters:
  
  toSubstitute - the map between Variable strings and GeneralFunctions
  
  Returns:
  
  the new GeneralFunction after all substitutions are preformed
- equalsFunction
  
  public abstract boolean equalsFunction(GeneralFunction that)
  
  Returns true when the two fully-simplified functions are equal
  
  Parameters:
  
  that - The GeneralFunction that the current function is being checked against
  
  Returns:
  
  true if the two functions are equal
- equalsSimplified
  
  public boolean equalsSimplified(GeneralFunction that)
  
  Simplifies the two functions, then compares them with equalsFunction(GeneralFunction)
  
  Parameters:
  
  that - the function to be compared against
  
  Returns:
  
  true if they're equal when simplified
- equals
  
  public boolean equals(Object that)
  
  Compares two functions with equalsFunction(GeneralFunction)
  
  Overrides:
  
  equals in class Object
  
  Parameters:
  
  that - the object to be compared against
  
  Returns:
  
  true if they're equal
- compareSelf
  
  protected abstract int compareSelf(GeneralFunction that)
  
  Used internally for comparing two functions of the same exact type
  
  Parameters:
  
  that - the GeneralFunction that this is compared against
  
  Returns:
  
  the comparison
- compareTo
  
  public int compareTo(@NotNull @NotNull GeneralFunction that)
  
  GeneralFunctions of different types are sorted according to sortOrder and MiscTools.findClassValue(GeneralFunction), and functions of the same exact type are sorted using compareSelf(GeneralFunction)
  
  Specified by:
  
  compareTo in interface Comparable<GeneralFunction>
  
  Parameters:
  
  that - the GeneralFunction that this is compared against
  
  Returns:
  
  the comparison
- hashCode
  
  public abstract int hashCode()
  
  Returns a hash code value for this object
  
  Overrides:
  
  hashCode in class Object
  
  Returns:
  
  a hash code value for this object
- iterator
  
  @NotNull public abstract @NotNull Iterator<GeneralFunction> iterator()
  
  Returns an iterator over the operands of this GeneralFunction
  
  Specified by:
  
  iterator in interface Iterable<GeneralFunction>
  
  Returns:
  
  an iterator over the operands of this GeneralFunction

Class GeneralFunction

Field Summary

Constructor Summary