Package com.singularsys.extensions.statistical

Class Variance

java.lang.Object
com.singularsys.jep.functions.PostfixMathCommand
com.singularsys.extensions.statistical.Variance
All Implemented Interfaces:
MatrixFunctionI, JepComponent, PostfixMathCommandI, Serializable
public class Variance extends PostfixMathCommand implements JepComponent, MatrixFunctionI
PostfixMathCommand for variance and standard deviation. Allows for various methods of calculating the statistics.
Author:
Richard Morris
See Also:

  • Constructor Details

    • Variance

      public Variance(Variance.Type type, FieldI f)
      Constructor
      Parameters:
      type - Type of variance or standard deviation to calculate
      f - field used to perform calculations
      Throws:
      ArithmeticException - if the constant 1/2 can not be constructed

  • Method Details

    • checkNumberOfParameters

      public boolean checkNumberOfParameters(int n)
      Description copied from class: PostfixMathCommand
      Checks the number of parameters of the function. Functions which set numberOfParameter=-1 should overload this method
      Specified by:
      checkNumberOfParameters in interface PostfixMathCommandI
      Overrides:
      checkNumberOfParameters in class PostfixMathCommand
      Parameters:
      n - number of parameters function will be called with.
      Returns:
      false if an illegal number of parameters is supplied, true otherwise.

    • run

      public void run(Stack<Object> stack) throws EvaluationException
      Description copied from class: PostfixMathCommand
      Throws an exception because this method should never be called under normal circumstances. Each function should use its own run() method for evaluating the function. This includes popping off the parameters from the stack, and pushing the result back on the stack.
      Specified by:
      run in interface PostfixMathCommandI
      Overrides:
      run in class PostfixMathCommand
      Parameters:
      stack - arguments for function
      Throws:
      EvaluationException - if function cannot be evaluated

    • init

      public void init(Jep jep)
      Description copied from interface: JepComponent
      Initialize the component. This method is called whenever a component is added to Jep. Hence, it allows components to keep track of the other components they may rely on.
      Specified by:
      init in interface JepComponent
      Parameters:
      jep - the current Jep instance

    • getLightWeightInstance

      public JepComponent getLightWeightInstance()
      Description copied from interface: JepComponent
      Gets a light-weight instance suitable for using in multiple threads.
      Specified by:
      getLightWeightInstance in interface JepComponent
      Returns:
      either a new instance, null or 'this'.

    • calcDims

      public Dimensions calcDims(Dimensions... inDims) throws ParseException
      Description copied from interface: MatrixFunctionI
      Attempts to calculate the dimensions of a result of a PostfixMathCommand.
      Specified by:
      calcDims in interface MatrixFunctionI
      Parameters:
      inDims - the dimensions of each argument
      Returns:
      the dimension of the result, or null, if it cannot be calculated
      Throws:
      ParseException - if there is a parse error