com.itemanalysis.psychometrics.histogram

Class Bin

java.lang.Object

com.itemanalysis.psychometrics.histogram.Bin

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Bin
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

A class representing a single histogram bin. A bin is characterized by a lower bound, upper bound, frequency count, and bin width. This class form a basic element in constructing a histogram. The bin can be lower inclusive, upper inclusive, or both. The constructors require the user to specify whether the bin is lower or upper inclusive. Bin frequencies are counted incrementally. Thus, a bin is storeless in that is does not store each individual value in the bin. It only records summary statistics.

Author:

J. Patrick Meyer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bin(double lowerBound, double upperBound, boolean lowerInclusive) Creates a histogram bin with the most amount of flexibility in the arguments.
Bin(double lowerBound, double upperBound, boolean lowerInclusive, boolean upperInclusive) This constructor is mainly used when the bin is used for something other than a histogram.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object obj) Evaluates the equality of of two bins.
double	getBinMean() Gets the mean of the bin.
double	getBinWidth() Gets the bin width.
double	getFrequency() Gets the frequency of observations in the bin.
double	getLowerBound() Gets the lower bound of the bin.
double	getMidPoint() Get the bin midpiont.
double	getUpperBound() Gets the upper bound of the bin.
boolean	inBin(double value) Tests whether a value belongs to this bin.
void	increment(double value) Incrementally count a value as belonging to this bin if it fits within the bounds.
void	increment(double value, double frequency) Incrementally count a value as belonging to this bin if it fits within the bounds.
boolean	lowerInclusive() Gets a boolean indicating whether the bin is lower inclusive or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bin

public Bin(double lowerBound,
           double upperBound,
           boolean lowerInclusive)

Creates a histogram bin with the most amount of flexibility in the arguments.

Parameters:

lowerBound - lower bound of the bin.

upperBound - upper bound of the bin.

lowerInclusive - a value equal to the lower bound is counted in this bin if true. Otherwise, it is not counted in this bin.

Bin

public Bin(double lowerBound,
           double upperBound,
           boolean lowerInclusive,
           boolean upperInclusive)

This constructor is mainly used when the bin is used for something other than a histogram. See Deciles.

Parameters:

lowerBound - lower bound of the bin.

upperBound - upper bound of the bin.

lowerInclusive - a value equal to the lower bound is counted in this bin if true. Otherwise, it is not counted in this bin.

upperInclusive - a value equal to the upper bound is counted in this bin if true. Otherwise, it is not counted in this bin.

Method Detail

increment

public void increment(double value)

Incrementally count a value as belonging to this bin if it fits within the bounds.

Parameters:

value - a value to be counted.

increment

public void increment(double value,
                      double frequency)

Incrementally count a value as belonging to this bin if it fits within the bounds. The observation is weighted by the frequency argument.

Parameters:

value - a value to be counted.

frequency - a frequency weight for the observation.

inBin

public boolean inBin(double value)

Tests whether a value belongs to this bin.

Parameters:

value - a value to be tested.

Returns:

true if the value belongs to the bin. False otherwise.

getMidPoint

public double getMidPoint()

Get the bin midpiont.

Returns:

bin midpoint.

getBinMean

public double getBinMean()

Gets the mean of the bin.

Returns:

bin mean.

getFrequency

public double getFrequency()

Gets the frequency of observations in the bin.

Returns:

frequency of observations in the bin.

getLowerBound

public double getLowerBound()

Gets the lower bound of the bin.

Returns:

the lower bound.

getUpperBound

public double getUpperBound()

Gets the upper bound of the bin.

Returns:

the upper bound.

lowerInclusive

public boolean lowerInclusive()

Gets a boolean indicating whether the bin is lower inclusive or not.

Returns:

true if lower inclusive, false otherwise.

getBinWidth

public double getBinWidth()

Gets the bin width.

Returns:

bin width.

equals

public boolean equals(java.lang.Object obj)

Evaluates the equality of of two bins.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException