Package org.jfree.data.statistics

Class SimpleHistogramBin

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean includeLowerBound
      A flag that controls whether the lower bound is included in the bin range.
      private boolean includeUpperBound
      A flag that controls whether the upper bound is included in the bin range.
      private int itemCount
      The item count.
      private double lowerBound
      The lower bound for the bin.
      private static long serialVersionUID
      For serialization.
      private double upperBound
      The upper bound for the bin.

    • Constructor Summary

      Constructors 
      Constructor Description
      SimpleHistogramBin​(double lowerBound, double upperBound)
      Creates a new bin.
      SimpleHistogramBin​(double lowerBound, double upperBound, boolean includeLowerBound, boolean includeUpperBound)
      Creates a new bin.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accepts​(double value)
      Returns true if the specified value belongs in the bin, and false otherwise.
      java.lang.Object clone()
      Returns a clone of the bin.
      int compareTo​(java.lang.Object obj)
      Compares the bin to an arbitrary object and returns the relative ordering.
      boolean equals​(java.lang.Object obj)
      Tests this bin for equality with an arbitrary object.
      int getItemCount()
      Returns the item count.
      double getLowerBound()
      Returns the lower bound.
      double getUpperBound()
      Return the upper bound.
      boolean overlapsWith​(SimpleHistogramBin bin)
      Returns true if this bin overlaps with the specified bin, and false otherwise.
      void setItemCount​(int count)
      Sets the item count.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values

      • lowerBound

        private double lowerBound
        The lower bound for the bin.

      • upperBound

        private double upperBound
        The upper bound for the bin.

      • includeLowerBound

        private boolean includeLowerBound
        A flag that controls whether the lower bound is included in the bin range.

      • includeUpperBound

        private boolean includeUpperBound
        A flag that controls whether the upper bound is included in the bin range.

      • itemCount

        private int itemCount
        The item count.

    • Constructor Detail

      • SimpleHistogramBin

        public SimpleHistogramBin​(double lowerBound,
                          double upperBound)
        Creates a new bin.
        Parameters:
        lowerBound - the lower bound (inclusive).
        upperBound - the upper bound (inclusive);

      • SimpleHistogramBin

        public SimpleHistogramBin​(double lowerBound,
                          double upperBound,
                          boolean includeLowerBound,
                          boolean includeUpperBound)
        Creates a new bin.
        Parameters:
        lowerBound - the lower bound.
        upperBound - the upper bound.
        includeLowerBound - include the lower bound?
        includeUpperBound - include the upper bound?

    • Method Detail

      • getLowerBound

        public double getLowerBound()
        Returns the lower bound.
        Returns:
        The lower bound.

      • getUpperBound

        public double getUpperBound()
        Return the upper bound.
        Returns:
        The upper bound.

      • getItemCount

        public int getItemCount()
        Returns the item count.
        Returns:
        The item count.

      • setItemCount

        public void setItemCount​(int count)
        Sets the item count.
        Parameters:
        count - the item count.

      • accepts

        public boolean accepts​(double value)
        Returns true if the specified value belongs in the bin, and false otherwise.
        Parameters:
        value - the value.
        Returns:
        A boolean.

      • overlapsWith

        public boolean overlapsWith​(SimpleHistogramBin bin)
        Returns true if this bin overlaps with the specified bin, and false otherwise.
        Parameters:
        bin - the other bin (null not permitted).
        Returns:
        A boolean.

      • compareTo

        public int compareTo​(java.lang.Object obj)
        Compares the bin to an arbitrary object and returns the relative ordering.
        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        obj - the object.
        Returns:
        An integer indicating the relative ordering of the this bin and the given object.

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this bin for equality with an arbitrary object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Returns a clone of the bin.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class java.lang.Object
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - not thrown by this class.