IRangeSet
hep.aida

Interface IRangeSet

  • All Known Implementing Classes:
    RangeSet, RangeSet


    public interface IRangeSet
    User level interface to RangeSet. Proposed rules for ranges: - By default (no arguments) RangeSet object is created with one valid range: (-infinity, +infinity). - size=0 means no valid ranges (isInRange(double point) will return false for any point). It also can be used to check if any range is set - RangeSet include valid interval only if size!=0. - RangeSet can be smart, e.g merge overlapping valid ranges. So size() does not always equal to the number of times user call include method.
    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      voidexclude(double xMin, double xMax)
      Exclude [xMin, xMax] interval from the existing set of valid ranges
      voidexcludeAll()
      Set empty range.
      voidinclude(double xMin, double xMax)
      Add [xMin, xMax] interval to existing set of valid ranges
      voidincludeAll()
      Set full range (from MINUS_INF to PLUS_INF ).
      booleanisInRange(double point) 
      double[]lowerBounds()
      Return array of lower Bounds for the current set of ranges
      doubleMINUS_INF() 
      doublePLUS_INF() 
      intsize()
      Return current number of disjoint ranges (non-overlapping intervals).
      double[]upperBounds()
      Return array of upper Bounds for the current set of ranges
    • Method Detail

      • lowerBounds

        double[] lowerBounds()
        Return array of lower Bounds for the current set of ranges
        Returns:
        Array of lower bounds for all valid ranges
      • upperBounds

        double[] upperBounds()
        Return array of upper Bounds for the current set of ranges
        Returns:
        Array of upper bounds for all valid ranges
      • include

        void include(double xMin,           double xMax)
        Add [xMin, xMax] interval to existing set of valid ranges
        Parameters:
        xMin - - lower bound of a new valid range
        xMax - - upper bound of a new valid range
      • exclude

        void exclude(double xMin,           double xMax)
        Exclude [xMin, xMax] interval from the existing set of valid ranges
        Parameters:
        xMin - - lower bound of range to be excluded
        xMax - - upper bound of range to be excluded
      • includeAll

        void includeAll()
        Set full range (from MINUS_INF to PLUS_INF ).
      • excludeAll

        void excludeAll()
        Set empty range.
      • isInRange

        boolean isInRange(double point)
      • size

        int size()
        Return current number of disjoint ranges (non-overlapping intervals). Note: it is not always equal to the number of times user set the range
        Returns:
        Number of disjoint ranges
      • PLUS_INF

        double PLUS_INF()
      • MINUS_INF

        double MINUS_INF()

SCaVis 2.2 © jWork.ORG