Class Function

java.lang.Object
com.github.gbenroscience.parser.Function
All Implemented Interfaces:
Savable, MethodRegistry.MethodAction, Serializable
public class Function extends Object implements Savable, MethodRegistry.MethodAction
Author:
JIBOYE OLUWAGBEMIRO OLAOLUWA
See Also:

  • Constructor Details

    • Function

      public Function()

    • Function

      public Function(Matrix matrix)
      Parameters:
      matrix - A Matrix to be used to initialize the function..

    • Function

      public Function(String input) throws InputMismatchException
      Parameters:
      input - The user input into the system, usually of the form: F(x,y,z,w,....)=mathexpr; or F= @(x,y,z,w,...)mathexpr.....where mathexpr is an algebraic expression in terms of x,y,z,w,... OR JUST PLAIN
      Throws:
      InputMismatchException

  • Method Details

    • setType

      public void setType(TYPE type)

    • getType

      public TYPE getType()

    • updateArgs

      public void updateArgs(double... x)

    • calc

      public double calc()
      Returns:
      the value of the function with these variables set.

    • calc

      public MathExpression.EvalResult calc(MathExpression.EvalResult[] x)
      Parameters:
      x - A list of variable values to set for the function. The supplied value list is applied to the function's parameter list in the order they were supplied in the original question.
      Returns:
      the value of the function with these variables set.

    • calc

      public MathExpression.EvalResult calc(MathExpression.EvalResult nextResult, int arity, MathExpression.EvalResult[] x)
      Description copied from interface: MethodRegistry.MethodAction
      Allows methods like diff(fn,args) to differentiate an expression using the MethodRegistry interface Is the intersection between methods and user-defined functions
      Specified by:
      calc in interface MethodRegistry.MethodAction
      Parameters:
      nextResult -
      arity - The number of argument to read from the args array
      x - The args passed to the function
      Returns:

    • assignObject

      public static boolean assignObject(String input, ErrorLog log)

    • assignAnonymousToNamedFunction

      public static boolean assignAnonymousToNamedFunction(String fname, String anonFuncName)
      Assigns a stored anonymous function to become a named function.
      Parameters:
      fname -
      anonFuncName - The name of the stored anonymous fucntion

    • setTurboExpr

      public void setTurboExpr(FastCompositeExpression turboExpr)

    • getTurboExpr

      public FastCompositeExpression getTurboExpr()

    • setDependentVariable

      public void setDependentVariable(Variable dependentVariable)

    • getDependentVariable

      public Variable getDependentVariable()

    • setMathExpression

      public void setMathExpression(MathExpression mathExpression)

    • getWideningArgsExpression

      public FastCompositeExpression getWideningArgsExpression()

    • getArrayArgsExpression

      public FastCompositeExpression getArrayArgsExpression()

    • setMatrix

      public void setMatrix(Matrix m)

    • getMathExpression

      public MathExpression getMathExpression()

    • setIndependentVariables

      public void setIndependentVariables(ArrayList<Variable> independentVariables)

    • getIndependentVariables

      public ArrayList<Variable> getIndependentVariables()

    • numberOfParameters

      public int numberOfParameters()
      Returns:
      the number of independent variables possessed by this Function object.

    • getArity

      public int getArity()

    • getMatrix

      public Matrix getMatrix()

    • getIndependentVariable

      public Variable getIndependentVariable(String name)
      Parameters:
      name - The name of the variable.
      Returns:
      the Variable if it exists in the parameter list of this Function. Returns null if no Variable having that name is to be found in the parameter list of this Function.

    • hasIndependentVariable

      public boolean hasIndependentVariable(String var)
      Parameters:
      var - The name of the Variable to check.
      Returns:
      true if this object has an independent variable that goes by the given name.

    • getParameters

      public static String[] getParameters(String paramList)
      Parameters:
      paramList - A string containing info. about the arguments to be passed to the Function. The format is (var1,var2,var3,....)
      Returns:
      an array containing the parameters, if its format is valid.

    • isParam

      public boolean isParam(String name)
      Parameters:
      name - The name of the Variable object to check, whether or not it is a parameter of this Function object.
      Returns:
      true if a Variable of the specified name exists in the parameter list of this Function object.

    • storeAnonymousMatrixFunction

      public static String storeAnonymousMatrixFunction(Matrix matrix)
      Parameters:
      matrix - The Matrix object to be wrapped in a function
      Returns:
      the name assigned to the anonymous function created.

    • storeAnonymousFunction

      public static Function storeAnonymousFunction(String expression)
      Parameters:
      expression - The expression used to create the function...e.g
      Returns:
      the name assigned to the anonymous function created.

    • isMatrix

      public boolean isMatrix()

    • evalArgs

      public String evalArgs(String args)
      Deprecated.
      Deprecated this in favor of evalArgs(double...) which is far faster due to direct passing of args
      Parameters:
      args -
      Returns:
      the value of a function when valid arguments are passed into its parentheses. e.g if the fullname of the Function is f(x,y,c), this method could be passed..f(3,-4,9)

    • evalArgs

      public String evalArgs(double... args)

    • evalArgsTurbo

      public double evalArgsTurbo(double... args)

    • evalRange

      public double[][] evalRange(String rangeDescr)
      Parameters:
      rangeDescr - Describes the range between which this Function object should be plotted. e.g. x:-10:10:0.0001
      Returns:
      an 2D array containing two 1d arrays. The first array containsAlgebraicFunction the values that the Function object will have for all values specified for the range of the independent variable. The second array containsAlgebraicFunction the values that the independent variable will assume in its given range. If the rangeDescr parameter is not valid.. it returns a 2D array containing 2 null arrays.

    • evalRange

      public double[][] evalRange(double xLower, double xUpper, double xStep, String variableName, int DRG)
      Parameters:
      xLower - The lower limit from which plotting begins.
      xUpper - The upper limit from which plotting begins.
      xStep - The plot step.
      variableName - The name of the independent(the horizontal axis variable..usually x)
      DRG - States whether the function should be evaluated in Degrees, Radians, and Grad.
      Returns:
      an 2D array containing two 1d arrays. The first array containsAlgebraicFunction the values that the Function object will have for all values specified for the range of the independent variable. The second array containsAlgebraicFunction the values that the independent variable will assume in its given range. If the rangeDescr parameter is not valid.. it returns a2D array containing 2 null arrays.

    • evalRange

      public double[][] evalRange(double xLower, double xUpper, double xStep, String variableName, int DRG, boolean turbo)

    • print2DArray

      public static void print2DArray(Object[][] obj)
      Prints the content of a 2D array
      Parameters:
      obj -

    • eval

      public String eval()
      Returns:
      the value of the function based on assigned values of its variables and constants.

    • isFunctionFullName

      public static boolean isFunctionFullName(String str)
      Parameters:
      str - The input string to check if or not it is of the format of the full name of a Function. e.g. F(x),p(x,y) e.t.c.
      Returns:
      true if the input string has the format of the full name of a Function. This method will be used to identify when the input into a calculator is to be treated as a Function problem...i.e. identify when the user is trying to create or modify a Function. F(x,y,x1,c,e3,u)

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      the standard math form of this Function object.

    • isAnonymous

      public boolean isAnonymous()

    • isAnonymous

      public static boolean isAnonymous(Function f)

    • isAnonymous

      public static boolean isAnonymous(String name)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getFullName

      public String getFullName()
      Returns:
      the dependent variable together with its independent variables within its circular parentheses. e.g if the Function is y=x^2, this method will return y(x)

    • getName

      public String getName()
      Returns:
      the simple name of the function. e.g if the function is y=@(x)cos(x), then this method returns 'y'.

    • calcDet

      public double calcDet()
      Returns:
      the determinant of the function if it is of type
      invalid reference 
      Function#MATRIX
      Otherwise it returns Double.NaN

    • calcInverse

      public Matrix calcInverse()
      Returns:
      the inverse of the matrix-function if it is of type
      invalid reference 
      Function#MATRIX
      Otherwise it returns null

    • triangularMatrix

      public Matrix triangularMatrix()
      Returns:
      the triangular Matrix of the function if it is of type
      invalid reference 
      Function#MATRIX
      Otherwise it returns null

    • reduceToEchelon

      public Matrix reduceToEchelon()
      Returns:
      the row-reduced echelon matrix of the function if it is of type
      invalid reference 
      Function#MATRIX
      Otherwise it returns null

    • expressionForm

      public String expressionForm()
      Returns:
      the sub-expression on the right hand side of the assignment '=' sign in the expression that created this Function object.

    • listToMatrix

      public static Matrix listToMatrix(List<String> data)
      Parameters:
      data - The input list The input list is such that: The first 2 entries specify the number of rows and columns. The remaining entries are the Matrix's entries.
      Returns:
      a number list which represents the row-reduced echelon Matrix that the entries reduce to.

    • matrixToList

      public static List<String> matrixToList(Matrix mat)
      The input list is such that: The first 2 entries specify the number of rows and columns. The remaining entries are the Matrix's entries.
      Returns:
      a list containing the data of the Matrix. This list does not contain the dimensions of the Matrix, only the data.

    • matrixToCommaList

      public static String matrixToCommaList(Matrix mat)
      Parameters:
      mat - The Matrix object
      Returns:
      a comma separated string containing the data of the Matrix. This string does not contain the dimensions of the Matrix, only the data.

    • copy

      public Function copy()
      Creates a deep copy of this Function instance. Essential for thread-safe parallel integration. Each thread gets an independent Function with: - Same expression and parsed structure - Independent state variables - No shared mutable references
      Returns:
      A new Function instance safe for concurrent use

    • parse

      public static Function parse(String enc)

    • main

      public static void main(String[] args)

    • serialize

      public String serialize()
      Specified by:
      serialize in interface Savable