Gephi Toolkit Javadoc

org.gephi.data.attributes.api
Enum Estimator

java.lang.Object
  extended by java.lang.Enum<Estimator>
      extended by org.gephi.data.attributes.api.Estimator
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Estimator>

public enum Estimator
extends java.lang.Enum<Estimator>

This enum is used to determine what should be done with "ties". For example if in the given time interval some attribute has got 3 different values we should know how to estimate its value.

The table below shows how the estimation is done for different types (- means not specified).

AVERAGE MEDIAN MODE SUM MIN MAX FIRST LAST
Real numbers arithmetic mean the value separating the higher half from the lower half (if there is an even number of values, the median is then defined to be the mean of the two middle values) the value that occurs the most frequently the result of addition of all values the lowest value the highest value the value which occured firstly the value which occured lastly
Integers arithmetic mean - using integer division the value separating the higher half from the lower half (if there is an even number of values, the median is then defined to be the mean of the two middle values - using integer division) the value that occurs the most frequently the result of addition of all values the lowest value the highest value the value which occured firstly the value which occured lastly
Boolean - the bool separating the higher half from the lower half (if there is an even number of bools, the median is then defined to be the bool which occured earlier than the second middle bool) the bool that occurs the most frequently - false if exists in a given set of bools, otherwise true true if exists in a given set of bools, otherwise false the bool which occured firstly the bool which occured lastly
Character - the character separating the higher half from the lower half (if there is an even number of characters, the median is then defined to be the character which occured earlier than the second middle character) the character that occurs the most frequently - the lowest character (with the lowest int value) the highest character (with the highest int value) the character which occured firstly the character which occured lastly
String - the string separating the higher half from the lower half (if there is an even number of strings, the median is then defined to be the string which occured earlier than the second middle string) the string that occurs the most frequently - the lowest string (using compareTo method) the highest string (using compareTo method) the string which occured firstly the string which occured lastly
TimeInterval - the time interval separating the higher half from the lower half (if there is an even number of time intervals, the median is then defined to be the time interval which occured earlier than the second middle time interval) the time interval that occurs the most frequently - - - the time interval which occured firstly the time interval which occured lastly

Author:
Cezary Bartosiak

Enum Constant Summary
AVERAGE
           
FIRST
           
LAST
           
MAX
           
MEDIAN
           
MIN
           
MODE
           
SUM
           
 
Method Summary
static Estimator valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Estimator[] 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

AVERAGE

public static final Estimator AVERAGE

MEDIAN

public static final Estimator MEDIAN

MODE

public static final Estimator MODE

SUM

public static final Estimator SUM

MIN

public static final Estimator MIN

MAX

public static final Estimator MAX

FIRST

public static final Estimator FIRST

LAST

public static final Estimator LAST
Method Detail

values

public static Estimator[] 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 (Estimator c : Estimator.values())
    System.out.println(c);

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

valueOf

public static Estimator valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

Gephi Toolkit Javadoc