Range (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.math.Range

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Range>
```
public class Range
extends java.lang.Object
implements java.lang.Comparable<Range>, java.io.Serializable
```
A class that represents ranges that may include or exclude the upper and lower bounds. This class is immutable.
Note: If a range is constructed where the upper and lower bounds are equal and one of them is exclusive, this range is considered empty, i.e. no number can be contained in it.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Range(double lowerBound, boolean lowerIsInclusive, double upperBound, boolean upperIsInclusive)` Create range.
`Range(double lower, double upper)` Create range where both bounds are inclusive.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Range other)`
`boolean`	`contains(double number)` Checks is a number is contained in the range.
`boolean`	`contains(Range other)` Determines whether the other range is fully contained in this range.
`boolean`	`equals(java.lang.Object obj)` Two ranges are equal if their bounds are equal and the flags that indicate if the bounds are inclusive or not are equal, too.
`java.lang.String`	`format(java.text.NumberFormat numberFormat)` String representation contains the bounds and brackets that indicate if the bounds are inclusive or exclusive.
`double`	`getLower()` Get lower bound.
`double`	`getUpper()` Get upper bound.
`int`	`hashCode()` Hash code includes bound and the flags that indicate if the bounds are inclusive or not.
`boolean`	`isEmpty()` Checks if a range is empty.
`boolean`	`isLowerInclusive()` Get flag that indicates if the lower bound is inclusive.
`boolean`	`isSingleton()` Returns whether this range is a singleton (i.e.
`boolean`	`isUpperInclusive()` Get flag that indicates if the upper bound is inclusive.
`boolean`	`overlaps(Range other)` Returns whether this range has a non-empty intersection with another range.
`double`	`size()` Returns the size of the range.
`java.lang.String`	`toString()` This forwards to `format(null);`.
`Range`	`union(Range other)` Calculates the union of this range with another range.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Range
```
public Range(double lower,
             double upper)
```
    Create range where both bounds are inclusive.
  - Range
```
public Range(double lowerBound,
             boolean lowerIsInclusive,
             double upperBound,
             boolean upperIsInclusive)
```
    Create range.
    
    Parameters:
    
    lowerIsInclusive - flag that indicates if lower bound is inclusive or not
    
    upperIsInclusive - flag that indicates if upper bound is inclusive or not
- Method Detail
  - contains
```
public boolean contains(double number)
```
    Checks is a number is contained in the range.
  - hashCode
```
public int hashCode()
```
    Hash code includes bound and the flags that indicate if the bounds are inclusive or not.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Two ranges are equal if their bounds are equal and the flags that indicate if the bounds are inclusive or not are equal, too. Empty ranges are considered equal regardless for there specific bounds.
    
    Overrides:
    
    equals in class java.lang.Object
  - getLower
```
public double getLower()
```
    Get lower bound.
  - getUpper
```
public double getUpper()
```
    Get upper bound.
  - isLowerInclusive
```
public boolean isLowerInclusive()
```
    Get flag that indicates if the lower bound is inclusive.
  - isUpperInclusive
```
public boolean isUpperInclusive()
```
    Get flag that indicates if the upper bound is inclusive.
  - isEmpty
```
public boolean isEmpty()
```
    Checks if a range is empty.
  - isSingleton
```
public boolean isSingleton()
```
    Returns whether this range is a singleton (i.e. contains of a single point/number).
  - size
```
public double size()
```
    Returns the size of the range. In case of empty ranges this returns 0. Note that inclusiveness of bound is not relevant for this method.
  - toString
```
public java.lang.String toString()
```
    This forwards to format(null);.
    
    Overrides:
    
    toString in class java.lang.Object
  - format
```
public java.lang.String format(java.text.NumberFormat numberFormat)
```
    String representation contains the bounds and brackets that indicate if the bounds are inclusive or exclusive.
    
    Parameters:
    
    numberFormat - number format used for formatting the numbers. If this is null, no special formatting is applied.
  - overlaps
```
public boolean overlaps(Range other)
```
    Returns whether this range has a non-empty intersection with another range.
  - compareTo
```
public int compareTo(Range other)
```
    Compares by lower values.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Range>
  - contains
```
public boolean contains(Range other)
```
    Determines whether the other range is fully contained in this range.
  - union
```
public Range union(Range other)
```
    Calculates the union of this range with another range. The union is defined by the smaller lower bound and the higher upper bound of the two ranges.

Class Range

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Range

Range

Method Detail

contains

hashCode

equals

getLower

getUpper

isLowerInclusive

isUpperInclusive

isEmpty

isSingleton

size

toString

format

overlaps

compareTo

contains

union