Package pulse.input

Class IndexRange

  • All Implemented Interfaces:
    Serializable
    public class IndexRange
extends Object
implements Serializable
    Provides a way to define the indices corresponding to a certain range of data.

    Essentially, an object of this class contains an ordered pair representing the associated indices. Works in conjunction with the Range class.

    See Also:
    Range, Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static int closestLeft​(double of, List<Double> in)
      Searches through the elements contained in the the second argument of this method to find an element belonging to in most closely resembling the first argument.
      static int closestRight​(double of, List<Double> in)
      Searches through the elements contained in the the second argument of this method to find an element belonging to in most closely resembling the first argument.
      int getLowerBound()
      Gets the integer value representing the index of the lower bound previously set by looking at a certain unspecified data list.
      int getUpperBound()
      Gets the integer value representing the index of the upper bound previously set by looking at a certain unspecified data list.
      boolean isValid()
      Checks if this index range is viable.
      protected void reset​(List<Double> data)
      Resets the index range by effectively treating the data list as bounded by its first and last elements, assuming that data is sorted in ascending order.
      void set​(List<Double> data, Range range)
      Sets the bounds of this index range using the minimum and maximum values of the segment specified in the range object.
      void setLowerBound​(List<Double> data, double a)
      Sets the start index by conducting a primitive binary search using closest(...) to find an element in data either matching or being as close as possible to a (if a is non-negative) or zero.
      void setUpperBound​(List<Double> data, double b)
      Sets the end index by conducting a primitive binary search using closest(...) to find an element in data either matching or being as close as possible to b.
      String toString()  

    • Constructor Detail

      • IndexRange

        public IndexRange​(IndexRange other)

      • IndexRange

        public IndexRange​(int start,
                  int end)

    • Method Detail

      • reset

        protected void reset​(List<Double> data)
        Resets the index range by effectively treating the data list as bounded by its first and last elements, assuming that data is sorted in ascending order. Because of this last assumption, the visibility of this method has been set to protected.
        Parameters:
        data - a list sorted in ascending order

      • setUpperBound

        public final void setUpperBound​(List<Double> data,
                                double b)
        Sets the end index by conducting a primitive binary search using closest(...) to find an element in data either matching or being as close as possible to b. For the above operation, the list is searched through from its last to first element (i.e., in reverse order).
        Parameters:
        data - the list to process
        b - an element representing the upper bound (not necessarily contained in data).
        See Also:
        closestLeft(double,java.util.List<java.lang.Double>), closestRight(double,java.util.List<java.lang.Double>)

      • getLowerBound

        public final int getLowerBound()
        Gets the integer value representing the index of the lower bound previously set by looking at a certain unspecified data list.
        Returns:
        the start index

      • getUpperBound

        public final int getUpperBound()
        Gets the integer value representing the index of the upper bound previously set by looking at a certain unspecified data list.
        Returns:
        the end index

      • isValid

        public boolean isValid()
        Checks if this index range is viable.
        Returns:
        true if the upper bound is positive and greater than the lower bound, false otherwise.

      • closestLeft

        public static int closestLeft​(double of,
                              List<Double> in)
        Searches through the elements contained in the the second argument of this method to find an element belonging to in most closely resembling the first argument. The search is completed once of lies between any two adjacent elements of in. The result is then the index of the preceding element.
        Parameters:
        of - an element which will be compared against
        in - a list of data presumably containing an element similar to of
        Returns:

        any integer greater than 0 and lesser than in.size that matches the above criterion. If of is greater than the last element of in, this will return the latter. Otherwise, if no element matching the criterion is found, returns 0.

      • closestRight

        public static int closestRight​(double of,
                               List<Double> in)
        Searches through the elements contained in the the second argument of this method to find an element belonging to in most closely resembling the first argument. The search utilises a reverse order, i.e. it starts from the last element and goes to the first. The search is completed once of lies between any two adjacent elements of in. The result is then the index of the preceding element.
        Parameters:
        of - an element which will be compared against
        in - a list of data presumably containing an element similar to of
        Returns:

        any integer greater than 0 and lesser than in.size that matches the above criterion. If of is greater than the last element of in, this will return the latter. Otherwise, if no element matching the criterion is found, returns 0.