Package com.io7m.jranges

Interface RangeInclusiveLType

All Known Implementing Classes:
RangeInclusiveL
@Immutable public interface RangeInclusiveLType
An inclusive range with long components.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    checkPreconditions()
    Check preconditions for the type.
    default boolean
    includesValue(long value)
    Determine if the given value is included in this range.
    default long
    interval()
    Retrieve the number of values in the range [lower, upper].
    default boolean
    isIncludedIn(RangeInclusiveL other)
    Determine if the given range is included in this range.
    long
    lower()
     
    long
    upper()
     

  • Method Details

    • lower

      @Parameter long lower()
      Returns:
      The lower bound of the inclusive range.

    • upper

      @Parameter long upper()
      Returns:
      The upper bound of the inclusive range.

    • interval

      default long interval()

      Retrieve the number of values in the range [lower, upper]. That is, (upper - lower) + 1.

      Returns:
      The number of values in the range

    • includesValue

      default boolean includesValue(long value)

      Determine if the given value is included in this range.

      Parameters:
      value - The given value
      Returns:
      true iff value >= this.getLower() && value <= this.getUpper() .

    • isIncludedIn

      default boolean isIncludedIn(RangeInclusiveL other)

      Determine if the given range is included in this range.

      Parameters:
      other - The given range
      Returns:
      true iff this.getLower() >= other.getLower() && this.getUpper() <= other.getUpper() .

    • checkPreconditions

      @Check default void checkPreconditions()
      Check preconditions for the type.