org.expasy.mzjava.stats

Class FrequencyTable

java.lang.Object

org.expasy.mzjava.stats.FrequencyTable

public class FrequencyTable
extends Object

A table to hold the frequency distribution of values from one variable.

Each entry in the table contains the frequency or count of the occurrences of values within a particular interval, and in this way, the table summarizes the distribution of values in the sample.

Version:

sqrt -1

Author:

Oliver Horlacher

Constructor Summary

Constructors

Constructor and Description
FrequencyTable(double binSize) Construct a new FrequencyTable that has intervals that have a width of binSize
FrequencyTable(double binSize, String name) Construct a new FrequencyTable that has intervals that have a width of binSize

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double value) Add a value to this table
void	addAll(FrequencyTable frequencyTable)
int	getBinId(double value) Return the id of the bin (interval) that the value falls in.
int[]	getBinIds() Returns an array that holds the ids of the bins (intervals) that contain values.
double	getBinSize() Return the bin size.
double	getCenter(int binId) Return the center value of the bin at index binId
int	getFrequency(int binId) Return the number of values that fall in the bin (interval) for the given binId
double	getMax(int binId) Return the max value of the bin at index binId
int	getMaxBinId() Return the id of the largest bin that contains a value
double	getMin(int binId) Return the min value of the bin at index binId
int	getMinBinId() Return the id of the smallest bin that contains a value
String	getName() Return the name of this FrequencyTable
int	getTotal() Return the total number of values in this table.
String	toString()
String	toString(boolean normalise) Returns a string representation of this FrequencyTable
static String	toString(String countName, FrequencyTable... tables) Summarize the tables in one string
static String	toStringNotNormalize(String countName, FrequencyTable... tables) Summarize the tables in one string without normalizing the frequencies
static gnu.trove.list.array.TDoubleArrayList[]	toTable(FrequencyTable... tables) Create an array of TDoubleArrayList that contains the frequencies from the tables

Methods inherited from class java.lang.Object

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

Constructor Detail

FrequencyTable

public FrequencyTable(double binSize)

Construct a new FrequencyTable that has intervals that have a width of binSize

Parameters:

binSize - the width of the intervals

FrequencyTable

public FrequencyTable(double binSize,
              String name)

Construct a new FrequencyTable that has intervals that have a width of binSize

Parameters:

binSize - the width of the intervals

name - the name of the table

Method Detail

add

public void add(double value)

Add a value to this table

Parameters:

value - the value to add

getTotal

public int getTotal()

Return the total number of values in this table.

Returns:

the total number of values in this table

getBinIds

public int[] getBinIds()

Returns an array that holds the ids of the bins (intervals) that contain values.

Returns:

an array that holds the ids of the bins (intervals) that contain values

getFrequency

public int getFrequency(int binId)

Return the number of values that fall in the bin (interval) for the given binId

Parameters:

binId - the bin for which the frequency is to be returned

Returns:

the number of values that fall in the bin (interval) for the given binId

getBinId

public int getBinId(double value)

Return the id of the bin (interval) that the value falls in.

Parameters:

value - the vale

Returns:

the id of the bin (interval) that the value falls in

getCenter

public double getCenter(int binId)

Return the center value of the bin at index binId

Parameters:

binId - the index of the bin

Returns:

the center value of the bin at index binId

getMin

public double getMin(int binId)

Return the min value of the bin at index binId

Parameters:

binId - the index of the bin

Returns:

the min value of the bin at index binId

getMax

public double getMax(int binId)

Return the max value of the bin at index binId

Parameters:

binId - the index of the bin

Returns:

the max value of the bin at index binId

getMinBinId

public int getMinBinId()

Return the id of the smallest bin that contains a value

Returns:

the id of the smallest bin that contains a value

getMaxBinId

public int getMaxBinId()

Return the id of the largest bin that contains a value

Returns:

the id of the largest bin that contains a value

getBinSize

public double getBinSize()

Return the bin size.

Returns:

the bin size

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean normalise)

Returns a string representation of this FrequencyTable

Parameters:

normalise - true if the frequencies are to be normalized

Returns:

string representation of this FrequencyTable

getName

public String getName()

Return the name of this FrequencyTable

Returns:

the name of this FrequencyTable

toString

public static String toString(String countName,
              FrequencyTable... tables)

Summarize the tables in one string

Parameters:

countName - the name of the values

tables - the tables

Returns:

the tables in one string

toStringNotNormalize

public static String toStringNotNormalize(String countName,
                          FrequencyTable... tables)

Summarize the tables in one string without normalizing the frequencies

Parameters:

countName - the name of the values

tables - the tables

Returns:

the tables in one string without normalizing the frequencies

toTable

public static gnu.trove.list.array.TDoubleArrayList[] toTable(FrequencyTable... tables)

Create an array of TDoubleArrayList that contains the frequencies from the tables

Parameters:

tables - the tables

Returns:

array of TDoubleArrayList that contains the frequencies from the tables

addAll

public void addAll(FrequencyTable frequencyTable)