Package com.singularsys.extensions.statistical

Class SortElements

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.NaryFunction

com.singularsys.extensions.statistical.ListReturningFunction

com.singularsys.extensions.statistical.SortElements

All Implemented Interfaces:

MatrixFunctionI, JepComponent, PostfixMathCommandI, Serializable

public class SortElements
extends ListReturningFunction

PostfixMathCommand to sort elements in a list. Flatten arrays so not suitable for matrices

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.singularsys.extensions.statistical.ListReturningFunction

listFun, lp

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
SortElements(boolean increasing, FieldI f)	Construct the rank function.
SortElements(boolean increasing, FieldI f, MatrixFactoryI mf)

Method Summary

Modifier and Type	Method	Description
Dimensions	calcDims(Dimensions... inDims)	Attempts to calculate the dimensions of a result of a PostfixMathCommand.
boolean	checkNumberOfParameters(int n)	Checks the number of parameters of the function.
Object	eval(Object[] args)	Evaluate the function
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.

Methods inherited from class com.singularsys.extensions.statistical.ListReturningFunction

convertToList, init

Methods inherited from class com.singularsys.jep.functions.NaryFunction

run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, getDescription, getDescription, getDescriptionWithType, getName, getNumberOfParameters, setCurNumberOfParameters, setDescription, setName, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

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

SortElements

public SortElements(boolean increasing,
 FieldI f,
 MatrixFactoryI mf)

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.

eval

public Object eval(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.

Returns:

either a new instance, null or 'this'.

calcDims

public Dimensions calcDims(Dimensions... inDims)

Description copied from interface: MatrixFunctionI

Attempts to calculate the dimensions of a result of a PostfixMathCommand.

Parameters:

inDims - the dimensions of each argument

Returns:

the dimension of the result, or null, if it cannot be calculated