Class SortElements

    • Constructor Detail

      • SortElements

        public SortElements​(boolean increasing,
                            FieldI f)
        Construct the rank function.
        Parameters:
        increasing - whether ranks are calculated in increasing (standard) or ascending order. In increasing order the highest term has a rank of 1.
        f - field
    • Method Detail

      • 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.
      • eval

        public java.lang.Object eval​(java.lang.Object[] args)
                              throws EvaluationException
        Description copied from class: NaryFunction
        Evaluate the function
        Specified by:
        eval in class NaryFunction
        Parameters:
        args - arguments to the function
        Returns:
        value returned by the function
        Throws:
        EvaluationException - if the calculation cannot be performed
      • 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 an 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 can be calculated
        Throws:
        ParseException - if there is a parse error