org.apache.commons.math3.stat.ranking
Enum TiesStrategy

java.lang.Object
  extended by java.lang.Enum<TiesStrategy>
      extended by org.apache.commons.math3.stat.ranking.TiesStrategy
All Implemented Interfaces:
Serializable, Comparable<TiesStrategy>

public enum TiesStrategy
extends Enum<TiesStrategy>

Strategies for handling tied values in rank transformations.

Since:
2.0
Version:
$Id: TiesStrategy.java 1416643 2012-12-03 19:37:14Z tn $

Enum Constant Summary
AVERAGE
          Ties get the average of applicable ranks
MAXIMUM
          Ties get the maximum applicable rank
MINIMUM
          Ties get the minimum applicable rank
RANDOM
          Ties get a random integral value from among applicable ranks
SEQUENTIAL
          Ties assigned sequential ranks in order of occurrence
 
Method Summary
static TiesStrategy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TiesStrategy[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SEQUENTIAL

public static final TiesStrategy SEQUENTIAL
Ties assigned sequential ranks in order of occurrence


MINIMUM

public static final TiesStrategy MINIMUM
Ties get the minimum applicable rank


MAXIMUM

public static final TiesStrategy MAXIMUM
Ties get the maximum applicable rank


AVERAGE

public static final TiesStrategy AVERAGE
Ties get the average of applicable ranks


RANDOM

public static final TiesStrategy RANDOM
Ties get a random integral value from among applicable ranks

Method Detail

values

public static TiesStrategy[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (TiesStrategy c : TiesStrategy.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static TiesStrategy valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.