IntegerBinaryFunction

Object

GeneralFunction

IntegerBinaryFunction

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

Direct Known Subclasses:: IntegerQuotient, Modulo

public abstract class IntegerBinaryFunction
extends BinaryFunction

IntegerBinaryFunction provides resources for subclasses to implement mathematical functions with integer-restricted domain.

Field Summary

Fields inherited from class BinaryFunction
function1, function2

Fields inherited from class GeneralFunction
derivatives, sortOrder
Constructor Summary

Constructors

Constructor Description

IntegerBinaryFunction(GeneralFunction function1, GeneralFunction function2)
Constructs a new IntegerBinaryFunction

Method Summary

Modifier and Type	Method	Description
`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.
`protected abstract int`	`operate(int first, int second)`	Performs the operation of this function on the inputs

Methods inherited from class BinaryFunction

compareSelf, equalsFunction, getFunction1, getFunction2, getInstance, hashCode, iterator, simplifyFOC, substituteAll, toOutputFunction

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 Iterable

forEach, spliterator

Methods inherited from interface Simplifiable

simplify

Constructor Details
- IntegerBinaryFunction
  
  public IntegerBinaryFunction(GeneralFunction function1, GeneralFunction function2)
  
  Constructs a new IntegerBinaryFunction
  
  Parameters:
  
  function1 - the first GeneralFunction in the binary operation
  
  function2 - the second GeneralFunction in the binary operation
Method Details
- 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
- operate
  
  protected abstract int operate(int first, int second)
  
  Performs the operation of this function on the inputs
  
  Parameters:
  
  first - the first input
  
  second - the second input
  
  Returns:
  
  the operation applied to the inputs