Package functions.binary

Class BinaryFunction

Object

GeneralFunction

BinaryFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

IntegerBinaryFunction, Logb, Pow, Rand

public abstract class BinaryFunction
extends GeneralFunction

The abstract BinaryFunction class represents function of two inputs and that aren't commutable. Ex: log_{2}(x) or 3^(x)

Field Summary

Fields

Modifier and Type	Field	Description
protected GeneralFunction	function1	One GeneralFunction in the binary operation
protected GeneralFunction	function2	The other GeneralFunction in the binary operation

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
BinaryFunction(GeneralFunction function1, GeneralFunction function2)	Constructs a new BinaryFunction

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	getFunction1()	Returns simplify()function1
GeneralFunction	getFunction2()	Returns simplify()function2
abstract BinaryFunction	getInstance(GeneralFunction function1, GeneralFunction function2)	Returns an instance of this GeneralFunction, using the correct subclass
int	hashCode()	Returns a hash code value for this object
@NotNull Iterator<GeneralFunction>	iterator()	Returns an iterator over the operands of this GeneralFunction
GeneralFunction	simplifyFOC()	Returns a new Constant of the BinaryFunction evaluated if both operands are a Constant
GeneralFunction	substituteAll(Predicate<? super GeneralFunction> test, Function<? super GeneralFunction,? extends GeneralFunction> replacer)	Substitutes all Variable in the function with a specified GeneralFunction
OutputFunction	toOutputFunction()	Converts this function into an OutputFunction for use in string conversion

Methods inherited from class GeneralFunction

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

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 Simplifiable

simplify

Field Details

function1

protected final GeneralFunction function1

One GeneralFunction in the binary operation

function2

protected final GeneralFunction function2

The other GeneralFunction in the binary operation

Constructor Details

BinaryFunction

public BinaryFunction(GeneralFunction function1, GeneralFunction function2)

Constructs a new BinaryFunction

Parameters:

function1 - The first GeneralFunction in the binary operation

function2 - The second GeneralFunction in the binary operation

Method Details

getFunction1

public GeneralFunction getFunction1()

Returns simplify()function1

Returns:

simplify()function1

getFunction2

public GeneralFunction getFunction2()

Returns simplify()function2

Returns:

simplify()function2

getInstance

public abstract BinaryFunction getInstance(GeneralFunction function1, GeneralFunction function2)

Returns an instance of this GeneralFunction, using the correct subclass

Parameters:

function1 - Constructor parameter 1

function2 - Constructor parameter 2

Returns:

an instance of this GeneralFunction

substituteAll

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

Substitutes all Variable in the function with a specified GeneralFunction

Specified by:

substituteAll in class GeneralFunction

Parameters:

test - the variable to be substituted into

replacer - the GeneralFunction that will be substituted

Returns:

the function after the given substitution was 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

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

simplifyFOC

public GeneralFunction simplifyFOC()

Returns a new Constant of the BinaryFunction evaluated if both operands are a Constant

Returns:

a new Constant of the BinaryFunction evaluated if both operands are a Constant

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