org.expasy.mzjava.stats

Class HistogramImpl

java.lang.Object

org.expasy.mzjava.stats.HistogramImpl

All Implemented Interfaces:

Histogram, Copyable<Histogram>

public class HistogramImpl
extends Object
implements Histogram

The default implementation of Histogram

Nested Class Summary

Nested classes/interfaces inherited from interface org.expasy.mzjava.stats.Histogram

Histogram.Normalization

Field Summary

Fields

Modifier and Type	Field and Description
protected double[]	breaks
protected double	cumulFrequencies
protected double[]	mids

Constructor Summary

Constructors

Constructor and Description
HistogramImpl()
HistogramImpl(double binWidth, double min, double max) Remark:
HistogramImpl(int binNumber, double binWidth, double min)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addBins(double[] bins) Add
boolean	addData(double value) Add one occurrence of value
void	addData(double[] values) Add one occurrence of each value
void	addData(double[] values, double[] weights)
boolean	addData(double value, double weight) Add value contributing with weight
boolean	addData(double value, double weight, com.google.common.base.Predicate<Double> predicate) Add the data into this histogram if the given predicate is true
boolean	addDataAtBin(double weight, int index) Add data at given bin
void	clear() Empty data
HistogramImpl	copy() Creates and returns a copy of this object.
boolean	equals(Object o)
double	getAbsoluteBinFreq(int index) Get the absolute frequency at given bin
double[]	getAbsoluteBinFreqs(double[] dest)
int	getBinIndex(double value) Get the bin index containing the given value (else must return -1)
double	getBinWidth() Get the bin width
double[]	getBreaks(double[] dest) Get the n+1 cells boundaries
double	getCumulFreqs() Get the counts of the cumulative number of observations in all bins
double	getCumulFreqs(int fromIncluded, int toExcluded) Get the counts of the cumulative number of weighed observations in all of the bins in the specifed range
double[]	getMids(double[] dest) Get the n cell midpoints
int	getMostIntenseBinIndex() Get the most intense bin index
String	getName() Get its name
Set<Integer>	getNonEmptyBinIndices() Get the set of non-empty bins
com.google.common.collect.Range<Double>	getRange() Get the range of defined values (first to last bin)
double	getRelativeBinFreq(int index) Get the relative (normalized by the cumulative weights) weighted frequencies at given bin
double	getRelativeBinFreq(int fromIncluded, int toExcluded) Get the relative (normalized by the cumulative weights) weighted frequencies between bins
int	hashCode()
protected void	initBins(int binNumber)
boolean	isEmpty() Return true if no data
Histogram	normalize(Histogram.Normalization normalization) Normalize histogram (weighted) frequencies
void	setName(String name)
HistogramImpl	shallowCopy() Copy the bin structure only
int	size() Get the number of bins (n)
String	toString()
static HistogramImpl	valueOfBinNumWidthMin(int binNumber, double binWidth, double min)
static HistogramImpl	valueOfBinWidthMinMax(double binWidth, double min, double max)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cumulFrequencies

protected double cumulFrequencies

mids

protected double[] mids

breaks

protected double[] breaks

Constructor Detail

HistogramImpl

public HistogramImpl()

HistogramImpl

public HistogramImpl(double binWidth,
             double min,
             double max)

Remark:

if (max-first) % binWidth ≠ 0 then max is extended to the next correct bin.

Parameters:

binWidth - the width of bins.

min - first bin lower bound (included).

max - last bin upper bound (excluded)

HistogramImpl

public HistogramImpl(int binNumber,
             double binWidth,
             double min)

Method Detail

valueOfBinNumWidthMin

public static HistogramImpl valueOfBinNumWidthMin(int binNumber,
                                  double binWidth,
                                  double min)

valueOfBinWidthMinMax

public static HistogramImpl valueOfBinWidthMinMax(double binWidth,
                                  double min,
                                  double max)

initBins

protected void initBins(int binNumber)

shallowCopy

public HistogramImpl shallowCopy()

Description copied from interface: Histogram

Copy the bin structure only

Specified by:

shallowCopy in interface Histogram

copy

public HistogramImpl copy()

Description copied from interface: Copyable

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.copy() != x

will be true, and that the expression:

 x.copy().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.copy().equals(x)

will be true, this is not an absolute requirement.

Specified by:

copy in interface Copyable<Histogram>

Returns:

a copy of this instance.

clear

public void clear()

Description copied from interface: Histogram

Empty data

Specified by:

clear in interface Histogram

addBins

public boolean addBins(double[] bins)

Add

Parameters:

bins -

Returns:

addDataAtBin

public boolean addDataAtBin(double weight,
                   int index)

Description copied from interface: Histogram

Add data at given bin

Specified by:

addDataAtBin in interface Histogram

getAbsoluteBinFreq

public double getAbsoluteBinFreq(int index)

Description copied from interface: Histogram

Get the absolute frequency at given bin

Specified by:

getAbsoluteBinFreq in interface Histogram

getAbsoluteBinFreqs

public double[] getAbsoluteBinFreqs(double[] dest)

Specified by:

getAbsoluteBinFreqs in interface Histogram

getMostIntenseBinIndex

public int getMostIntenseBinIndex()

Description copied from interface: Histogram

Get the most intense bin index

Specified by:

getMostIntenseBinIndex in interface Histogram

normalize

public Histogram normalize(Histogram.Normalization normalization)

Description copied from interface: Histogram

Normalize histogram (weighted) frequencies

Specified by:

normalize in interface Histogram

getName

public String getName()

Description copied from interface: Histogram

Get its name

Specified by:

getName in interface Histogram

setName

public void setName(String name)

isEmpty

public boolean isEmpty()

Description copied from interface: Histogram

Return true if no data

Specified by:

isEmpty in interface Histogram

addData

public boolean addData(double value)

Description copied from interface: Histogram

Add one occurrence of value

Specified by:

addData in interface Histogram

addData

public boolean addData(double value,
              double weight)

Description copied from interface: Histogram

Add value contributing with weight

Specified by:

addData in interface Histogram

addData

public void addData(double[] values)

Description copied from interface: Histogram

Add one occurrence of each value

Specified by:

addData in interface Histogram

addData

public void addData(double[] values,
           double[] weights)

Specified by:

addData in interface Histogram

addData

public boolean addData(double value,
              double weight,
              com.google.common.base.Predicate<Double> predicate)

Description copied from interface: Histogram

Add the data into this histogram if the given predicate is true

Specified by:

addData in interface Histogram

getRange

public com.google.common.collect.Range<Double> getRange()

Description copied from interface: Histogram

Get the range of defined values (first to last bin)

Specified by:

getRange in interface Histogram

size

public int size()

Description copied from interface: Histogram

Get the number of bins (n)

Specified by:

size in interface Histogram

getNonEmptyBinIndices

public Set<Integer> getNonEmptyBinIndices()

Description copied from interface: Histogram

Get the set of non-empty bins

Specified by:

getNonEmptyBinIndices in interface Histogram

getBinWidth

public double getBinWidth()

Description copied from interface: Histogram

Get the bin width

Specified by:

getBinWidth in interface Histogram

getRelativeBinFreq

public double getRelativeBinFreq(int index)

Description copied from interface: Histogram

Get the relative (normalized by the cumulative weights) weighted frequencies at given bin

Specified by:

getRelativeBinFreq in interface Histogram

getRelativeBinFreq

public double getRelativeBinFreq(int fromIncluded,
                        int toExcluded)

Description copied from interface: Histogram

Get the relative (normalized by the cumulative weights) weighted frequencies between bins

Specified by:

getRelativeBinFreq in interface Histogram

getCumulFreqs

public double getCumulFreqs()

Description copied from interface: Histogram

Get the counts of the cumulative number of observations in all bins

Specified by:

getCumulFreqs in interface Histogram

getCumulFreqs

public double getCumulFreqs(int fromIncluded,
                   int toExcluded)

Description copied from interface: Histogram

Get the counts of the cumulative number of weighed observations in all of the bins in the specifed range

Specified by:

getCumulFreqs in interface Histogram

getBinIndex

public int getBinIndex(double value)

Description copied from interface: Histogram

Get the bin index containing the given value (else must return -1)

Specified by:

getBinIndex in interface Histogram

getBreaks

public double[] getBreaks(double[] dest)

Description copied from interface: Histogram

Get the n+1 cells boundaries

Specified by:

getBreaks in interface Histogram

getMids

public double[] getMids(double[] dest)

Description copied from interface: Histogram

Get the n cell midpoints

Specified by:

getMids in interface Histogram

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object