Package functions.commutative

Class CommutativeFunction

Object

GeneralFunction

CommutativeFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

IntegerCommutativeFunction, Product, Sum

public abstract class CommutativeFunction
extends GeneralFunction

The abstract CommutativeFunction class represents function that are commutative. Ex: addition or multiplication

Field Summary

Fields

Modifier and Type	Field	Description
protected GeneralFunction[]	functions	The array of GeneralFunctions operated on by the CommutativeFunction

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
CommutativeFunction(GeneralFunction... functions)	Constructs a new CommutativeFunction

Method Summary

Modifier and Type	Method	Description
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
GeneralFunction[]	getFunctions()	Returns functions
abstract double	getIdentityValue()	Returns the identity of this CommutativeFunction, such as 0 for + or gcd and 1 for * or lcm
abstract CommutativeFunction	getInstance(GeneralFunction... functions)	Returns an instance of this GeneralFunction
protected Collector<CharSequence,?,String>	getJoiningCollector()	Returns a collector used to create the toString of the CommutativeFunction
int	hashCode()	Returns a hash code value for this object
@NotNull Iterator<GeneralFunction>	iterator()	Returns an iterator over the operands of this GeneralFunction
abstract double	operate(double a, double b)	Performs the operation of this CommutativeFunction on the two inputs
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
CommutativeFunction	simplifyConstants()	Combines all Constants using operate(double, double)
CommutativeFunction	simplifyElements()	Simplifies each element of this CommutativeFunction
CommutativeFunction	simplifyIdentity()	Removes all instances of the identity of the function from functions
CommutativeFunction	simplifyInternal()	Simplifies this CommutativeFunction using all methods that are guaranteed to return a CommutativeFunction of the same type
CommutativeFunction	simplifyPull()	Composes all sub-functions of the same type.
GeneralFunction	simplifyTrivialElement()	Returns identity Constant if functions length is 0 and returns the GeneralFunction if functions length is 1
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
OutputFunction	toOutputFunction()	Converts this function into an OutputFunction for use in string conversion
String	toString()	Returns a String representation of this GeneralFunction

Methods inherited from class GeneralFunction

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

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

Field Details

functions

protected final GeneralFunction[] functions

The array of GeneralFunctions operated on by the CommutativeFunction

Constructor Details

CommutativeFunction

public CommutativeFunction(GeneralFunction... functions)

Constructs a new CommutativeFunction

Parameters:

functions - The GeneralFunctions that will be acted on

Method Details

getFunctions

public GeneralFunction[] getFunctions()

Returns functions

Returns:

functions

getInstance

public abstract CommutativeFunction getInstance(GeneralFunction... functions)

Returns an instance of this GeneralFunction

Parameters:

functions - the GeneralFunctions that will be acted on

Returns:

an instance of this GeneralFunction

toString

public String toString()

Description copied from class: GeneralFunction

Returns a String representation of this GeneralFunction

Specified by:

toString in class GeneralFunction

Returns:

String representation of this function

getJoiningCollector

protected Collector<CharSequence,?,String> getJoiningCollector()

Returns a collector used to create the toString of the CommutativeFunction

Returns:

a joining collector

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

toOutputFunction

public OutputFunction toOutputFunction()

Description copied from interface: Outputable

Converts this function into an OutputFunction for use in string conversion

Returns:

this function as an OutputFunction

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

Specified by:

substituteAll in class GeneralFunction

Parameters:

test - checks if the function should be replaced

replacer - replaces the function

Returns:

a new GeneralFunction with all replacements made

simplify

public GeneralFunction simplify()

Description copied from interface: Simplifiable

Returns this GeneralFunction, simplified

Returns:

the simplified function

simplifyInternal

public CommutativeFunction simplifyInternal()

Simplifies this CommutativeFunction using all methods that are guaranteed to return a CommutativeFunction of the same type

Returns:

the simplified CommutativeFunction

simplifyElements

public CommutativeFunction simplifyElements()

Simplifies each element of this CommutativeFunction

Returns:

a new CommutativeFunction with each element of functions simplified

simplifyIdentity

public CommutativeFunction simplifyIdentity()

Removes all instances of the identity of the function from functions

Returns:

a new CommutativeFunction with

simplifyConstants

public CommutativeFunction simplifyConstants()

Combines all Constants using operate(double, double)

Returns:

a new CommutativeFunction with the combined Constants

simplifyPull

public CommutativeFunction simplifyPull()

Composes all sub-functions of the same type. Ex: (a+(b+c)) becomes (a+b+c)

Returns:

a new CommutativeFunction with all compositions performed

simplifyTrivialElement

public GeneralFunction simplifyTrivialElement()

Returns identity Constant if functions length is 0 and returns the GeneralFunction if functions length is 1

Returns:

identity Constant if functions length is 0 and returns the GeneralFunction if functions length is 1

getIdentityValue

public abstract double getIdentityValue()

Returns the identity of this CommutativeFunction, such as 0 for + or gcd and 1 for * or lcm

Returns:

the identity of this CommutativeFunction

operate

public abstract double operate(double a, double b)

Performs the operation of this CommutativeFunction on the two inputs

Parameters:

a - the first input

b - the second input

Returns:

the operation applied to the inputs

hashCode

public int hashCode()

Description copied from class: GeneralFunction

Returns a hash code value for this object

Specified by:

hashCode in class GeneralFunction

Returns:

a hash code value for this object

iterator

@NotNull public @NotNull Iterator<GeneralFunction> iterator()

Description copied from class: GeneralFunction

Returns an iterator over the operands of this GeneralFunction

Specified by:

iterator in interface Iterable<GeneralFunction>

Specified by:

iterator in class GeneralFunction

Returns:

an iterator over the operands of this GeneralFunction