org.jfree.data.statistics.SimpleHistogramBin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D API, it supports a wide range of chart types including
bar charts, pie charts, line charts, XY-plots, time series plots, Sankey charts
and more.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-present, by David Gilbert and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -----------------------
* SimpleHistogramBin.java
* -----------------------
* (C) Copyright 2005-present, by David Gilbert and Contributors.
*
* Original Author: David Gilbert;
* Contributor(s): -;
*
*/
package org.jfree.data.statistics;
import java.io.Serializable;
import org.jfree.chart.util.PublicCloneable;
/**
* A bin for the {@link SimpleHistogramDataset}.
*/
public class SimpleHistogramBin implements Comparable,
Cloneable, PublicCloneable, Serializable {
/** For serialization. */
private static final long serialVersionUID = 3480862537505941742L;
/** The lower bound for the bin. */
private double lowerBound;
/** The upper bound for the bin. */
private double upperBound;
/**
* A flag that controls whether the lower bound is included in the bin
* range.
*/
private boolean includeLowerBound;
/**
* A flag that controls whether the upper bound is included in the bin
* range.
*/
private boolean includeUpperBound;
/** The item count. */
private int itemCount;
/**
* Creates a new bin.
*
* @param lowerBound the lower bound (inclusive).
* @param upperBound the upper bound (inclusive);
*/
public SimpleHistogramBin(double lowerBound, double upperBound) {
this(lowerBound, upperBound, true, true);
}
/**
* Creates a new bin.
*
* @param lowerBound the lower bound.
* @param upperBound the upper bound.
* @param includeLowerBound include the lower bound?
* @param includeUpperBound include the upper bound?
*/
public SimpleHistogramBin(double lowerBound, double upperBound,
boolean includeLowerBound,
boolean includeUpperBound) {
if (lowerBound >= upperBound) {
throw new IllegalArgumentException("Invalid bounds");
}
this.lowerBound = lowerBound;
this.upperBound = upperBound;
this.includeLowerBound = includeLowerBound;
this.includeUpperBound = includeUpperBound;
this.itemCount = 0;
}
/**
* Returns the lower bound.
*
* @return The lower bound.
*/
public double getLowerBound() {
return this.lowerBound;
}
/**
* Return the upper bound.
*
* @return The upper bound.
*/
public double getUpperBound() {
return this.upperBound;
}
/**
* Returns the item count.
*
* @return The item count.
*/
public int getItemCount() {
return this.itemCount;
}
/**
* Sets the item count.
*
* @param count the item count.
*/
public void setItemCount(int count) {
this.itemCount = count;
}
/**
* Returns {@code true} if the specified value belongs in the bin,
* and {@code false} otherwise.
*
* @param value the value.
*
* @return A boolean.
*/
public boolean accepts(double value) {
if (Double.isNaN(value)) {
return false;
}
if (value < this.lowerBound) {
return false;
}
if (value > this.upperBound) {
return false;
}
if (value == this.lowerBound) {
return this.includeLowerBound;
}
if (value == this.upperBound) {
return this.includeUpperBound;
}
return true;
}
/**
* Returns {@code true} if this bin overlaps with the specified bin,
* and {@code false} otherwise.
*
* @param bin the other bin ({@code null} not permitted).
*
* @return A boolean.
*/
public boolean overlapsWith(SimpleHistogramBin bin) {
if (this.upperBound < bin.lowerBound) {
return false;
}
if (this.lowerBound > bin.upperBound) {
return false;
}
if (this.upperBound == bin.lowerBound) {
return this.includeUpperBound && bin.includeLowerBound;
}
if (this.lowerBound == bin.upperBound) {
return this.includeLowerBound && bin.includeUpperBound;
}
return true;
}
/**
* Compares the bin to an arbitrary object and returns the relative
* ordering.
*
* @param obj the object.
*
* @return An integer indicating the relative ordering of the this bin and
* the given object.
*/
@Override
public int compareTo(Object obj) {
if (!(obj instanceof SimpleHistogramBin)) {
return 0;
}
SimpleHistogramBin bin = (SimpleHistogramBin) obj;
if (this.lowerBound < bin.lowerBound) {
return -1;
}
if (this.lowerBound > bin.lowerBound) {
return 1;
}
// lower bounds are the same
if (this.upperBound < bin.upperBound) {
return -1;
}
if (this.upperBound > bin.upperBound) {
return 1;
}
return 0;
}
/**
* Tests this bin for equality with an arbitrary object.
*
* @param obj the object ({@code null} permitted).
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof SimpleHistogramBin)) {
return false;
}
SimpleHistogramBin that = (SimpleHistogramBin) obj;
if (this.lowerBound != that.lowerBound) {
return false;
}
if (this.upperBound != that.upperBound) {
return false;
}
if (this.includeLowerBound != that.includeLowerBound) {
return false;
}
if (this.includeUpperBound != that.includeUpperBound) {
return false;
}
if (this.itemCount != that.itemCount) {
return false;
}
return true;
}
/**
* Returns a clone of the bin.
*
* @return A clone.
*
* @throws CloneNotSupportedException not thrown by this class.
*/
@Override
public Object clone() throws CloneNotSupportedException {
return super.clone();
}
}