Package com.singularsys.extensions.statistical

Class Rank

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.extensions.statistical.Rank

All Implemented Interfaces:

MatrixFunctionI, JepComponent, PostfixMathCommandI, Serializable

public class Rank
extends BinaryFunction
implements JepComponent, MatrixFunctionI

PostfixMathCommand to return the rank of a single number in a list. Various conventions for calculating ranks can be used

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Rank.Type	Type of Rank to calculate.

Nested classes/interfaces inherited from class com.singularsys.jep.functions.BinaryFunction

BinaryFunction.BiFunctionWithException<T>

Field Summary

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
Rank(Rank.Type type, boolean descending, FieldI f)	Construct the rank function.

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 val, Object data)	Evaluate the function
String	getDescription()	Return a description of the function from the properties file.
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.
void	init(Jep jep)	Initialize the component.

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

instanceOf, instanceOf, instanceOf, instanceOf, run

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

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, 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

Rank

public Rank(Rank.Type type,
 boolean descending,
 FieldI f)

Construct the rank function.

Parameters:

type - Method used to calculate ranks, Type.COMPETITION is standard

descending - whether ranks are calculated in descending (standard) or ascending order.

f - field to use

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 val,
 Object data)
            throws EvaluationException

Description copied from class: BinaryFunction

Evaluate the function

Specified by:

eval in class BinaryFunction

Parameters:

val - lhs argument

data - rhs argument

Returns:

the results

Throws:

EvaluationException - if the 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)

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

getDescription

public String getDescription()

Description copied from class: PostfixMathCommand

Return a description of the function from the properties file. The property name is the class name followed by ".description". The property is found using the JepMessages class, which can be configured to add additional properties files. If PostfixMathCommand.setDescription(String) has been called, return the description set by that method instead.

Specified by:

getDescription in interface PostfixMathCommandI

Overrides:

getDescription in class PostfixMathCommand

Returns:

the description of the function