org.expasy.mzjava.utils

Class IntervalList

java.lang.Object

org.expasy.mzjava.utils.IntervalList

public class IntervalList
extends Object

This class manages a list of intervals and implements a method to quickly check whether a given value lies within the list of intervals or not. For more than 50 intervals, this class implements a quick access to the intervals using a binned array. The bins are set to specific values indicating whether they are contained in a interval, lie outside all intervals or contain a border of a interval. These methods accelerate the lookup of the intervals only if the binWidth is much smaller than the average interval size. For less than 50 intervals, it turned out that direct checks on the intervals is the faster way to check whether a value is contained in the intervals.

Author:

Markus, nikitin

Constructor Summary

Constructors

Constructor and Description
IntervalList()
IntervalList(double minVal, double maxVal, double binWidth) The binned array indexing the intervals goes from minVal to maxVal with bin size binWidth.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterval(double lBound, double rBound) Add new interval to list.
boolean	contains(double value) Checks whether value is included in any of the intervals
double	getBinWidth()
double	getMaxVal()
double	getMinVal()
void	setBinArrayBounds(double minVal, double maxVal, double binWidth) The binned array indexing the intervals goes from minVal to maxVal with bin size binWidth.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntervalList

public IntervalList()

IntervalList

public IntervalList(double minVal,
            double maxVal,
            double binWidth)

The binned array indexing the intervals goes from minVal to maxVal with bin size binWidth.

Parameters:

minVal - Start value of the binned array

maxVal - End value of the binned array

binWidth - Bind width of the binned array

Method Detail

setBinArrayBounds

public void setBinArrayBounds(double minVal,
                     double maxVal,
                     double binWidth)

The binned array indexing the intervals goes from minVal to maxVal with bin size binWidth.

Parameters:

minVal - Start value of the binned array

maxVal - End value of the binned array

binWidth - Bind width of the binned array

getMinVal

public double getMinVal()

getMaxVal

public double getMaxVal()

getBinWidth

public double getBinWidth()

addInterval

public void addInterval(double lBound,
               double rBound)

Add new interval to list. lBound and rBound are exchanged if lBound > rBound.

Parameters:

lBound - left bound of interval

rBound - right bound of interval

contains

public final boolean contains(double value)

Checks whether value is included in any of the intervals

Parameters:

value - value to be tested

Returns:

true if included, false otherwise