Package functions.unitary

Class UnitaryFunction

Object

GeneralFunction

UnitaryFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

GeneralTrigFunction, IntegerUnitaryFunction, PiecewiseFunction, SpecialCaseBinaryFunction, Transformation

public abstract class UnitaryFunction
extends GeneralFunction

The abstract UnitaryFunction class represents function of one input. Ex: cos or abs

Field Summary

Fields

Modifier and Type	Field	Description
GeneralFunction	operand	The GeneralFunction which the UnitaryFunction operates on

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
UnitaryFunction(GeneralFunction operand)	Constructs a new UnitaryFunction

Method Summary

Modifier and Type	Method	Description
UnitaryFunction	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
abstract UnitaryFunction	getInstance(GeneralFunction operand)	Returns a new instance of this UnitaryFunction
int	hashCode()	Returns a hash code value for this object
@NotNull Iterator<GeneralFunction>	iterator()	Returns an iterator over the operands of this GeneralFunction
static UnitaryFunction	newInstanceOf(Class<?> type, GeneralFunction operand)	Returns a UnitaryFunction of the given type and of the given operand
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
GeneralFunction	simplifyFOC()	Returns a new Constant of the UnitaryFunction evaluated if the operand is a Constant
UnitaryFunction	simplifyInternal()	Simplifies the operand using Simplifiable.simplify()
GeneralFunction	simplifyInverse()	If operand is an instance of the inverse of this function, returns operand.operand
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

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

operand

public final GeneralFunction operand

The GeneralFunction which the UnitaryFunction operates on

Constructor Details

UnitaryFunction

public UnitaryFunction(GeneralFunction operand)

Constructs a new UnitaryFunction

Parameters:

operand - The GeneralFunction which will be operated on

Method Details

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

simplify

public GeneralFunction simplify()

Description copied from interface: Simplifiable

Returns this GeneralFunction, simplified

Returns:

the simplified function

simplifyFOC

public GeneralFunction simplifyFOC()

Returns a new Constant of the UnitaryFunction evaluated if the operand is a Constant

Returns:

a new Constant of the UnitaryFunction evaluated if the operand is a Constant

simplifyInverse

public GeneralFunction simplifyInverse()

If operand is an instance of the inverse of this function, returns operand.operand

Returns:

operand.operand if operand is an instance of the inverse, and this otherwise

getInstance

public abstract UnitaryFunction getInstance(GeneralFunction operand)

Returns a new instance of this UnitaryFunction

Parameters:

operand - the GeneralFunction to be operated on

Returns:

a new instance of this UnitaryFunction

clone

public UnitaryFunction clone()

Description copied from class: GeneralFunction

Returns a clone of this GeneralFunction

Specified by:

clone in class GeneralFunction

Returns:

a clone of this function

simplifyInternal

public UnitaryFunction simplifyInternal()

Simplifies the operand using Simplifiable.simplify()

Returns:

an instance of this UnitaryFunction with the operand simplified

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

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

newInstanceOf

public static UnitaryFunction newInstanceOf(Class<?> type, GeneralFunction operand)

Returns a UnitaryFunction of the given type and of the given operand

Parameters:

type - The Class of the UnitaryFunction being returned

operand - The operand of the UnitaryFunction

Returns:

a new UnitaryFunction of the given type and of the given operand

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