IntRange (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.IntRange

All Implemented Interfaces:

Comparable<IntRange>, EuclidConstants
```
public class IntRange
extends Object
implements EuclidConstants, Comparable<IntRange>
```
maximum and minimum values Contains two ints representing the minimum and maximum of an allowed or observed range.
Default is range with low > high; this can be regarded as the uninitialised state. If points are added to a default IntRange it becomes initialised.

Author:

(C) P. Murray-Rust, 1996

Field Summary

Fields
Modifier and Type	Field and Description
`static org.xmlcml.euclid.IntRangeComparator`	`ASCENDING_MIN_COMPARATOR`
`protected int`	`maxval` maximum of range
`protected int`	`minval` minimum of range

Fields inherited from interface org.xmlcml.euclid.EuclidConstants
C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Constructor Summary

Constructors
Constructor and Description
`IntRange()` creates invalid range from MAX_VALUE to MIN_VALUE
`IntRange(int minv, int maxv)` initialise with min and max values; if minv > maxv create inValid IntRange
`IntRange(IntRange r)` copy constructor
`IntRange(RealRange r)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int x)` add a value to a range
`boolean`	`canJoin(IntRange range, int tolerance)` can two ranges be joined at a common point? (1,5) and (5,10) can be joined.
`int`	`compareTo(IntRange intRange)` comparees on min values
`boolean`	`contains(int f)` synonym for includes()
`static List<IntRange>`	`createIntRangeList(List<String> tokens)` creates a list of IntRanges from {...} syntax.
`boolean`	`equals(Object o)`
`int`	`getMax()` get maximum value (MIN_VALUE if inValid)
`int`	`getMidPoint()` mid point of range.
`int`	`getMin()` get minimum value (MAX_VALUE if inValid)
`int`	`getRange()` get range (MIN_VALUE if invalid)
`IntRange`	`getRangeExtendedBy(int minExtend, int maxExtend)` makes new IntRange extended by deltaMin and deltaMax.
`int`	`hashCode()`
`boolean`	`includes(int f)` is a int within a IntRange
`boolean`	`includes(IntRange r2)` does one range include another
`IntRange`	`intersectionWith(IntRange r2)` intersect two ranges and take the range common to both; return invalid range if no overlap
`boolean`	`intersectsWith(IntRange r2)`
`boolean`	`isEqualTo(IntRange r)` invalid ranges return false
`boolean`	`isValid()` a Range is only valid if its maxval is not less than its minval; this tests for uninitialised ranges
`static List<IntRange>`	`joinRanges(List<IntRange> rangeList, int tolerance)` joins intRanges A and B when A.getMax() == B.getMin().
`static IntRange`	`parseCurlyBracketString(String token)` interprets a String as an IntRange.
`IntRange`	`plus(IntRange r2)` combine two ranges if both valid; takes greatest limits of both, else returns InValid
`void`	`setMax(int max)`
`void`	`setMin(int min)`
`String`	`toString()` to string
`boolean`	`touches(IntRange range)` do ranges touch but not overlap? range from [a,b] inclusive touches [c,a-1] or [b+1,c] ([a,b] overlaps with [b,c])

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

- Field Detail
  - ASCENDING_MIN_COMPARATOR
```
public static final org.xmlcml.euclid.IntRangeComparator ASCENDING_MIN_COMPARATOR
```
  - maxval
```
protected int maxval
```
    maximum of range
  - minval
```
protected int minval
```
    minimum of range
- Constructor Detail
  - IntRange
```
public IntRange()
```
    creates invalid range from MAX_VALUE to MIN_VALUE
  - IntRange
```
public IntRange(int minv,
                int maxv)
```
    initialise with min and max values; if minv > maxv create inValid IntRange
    
    Parameters:
    
    minv -
    
    maxv -
  - IntRange
```
public IntRange(IntRange r)
```
    copy constructor
    
    Parameters:
    
    r -
  - IntRange
```
public IntRange(RealRange r)
```
    Parameters:
    
    r -
- Method Detail
  - isValid
```
public boolean isValid()
```
    a Range is only valid if its maxval is not less than its minval; this tests for uninitialised ranges
    
    Returns:
    
    valid
  - isEqualTo
```
public boolean isEqualTo(IntRange r)
```
    invalid ranges return false
    
    Parameters:
    
    r -
    
    Returns:
    
    equals
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - plus
```
public IntRange plus(IntRange r2)
```
    combine two ranges if both valid; takes greatest limits of both, else returns InValid
    
    Parameters:
    
    r2 -
    
    Returns:
    
    range
  - intersectsWith
```
public boolean intersectsWith(IntRange r2)
```
  - intersectionWith
```
public IntRange intersectionWith(IntRange r2)
```
    intersect two ranges and take the range common to both; return invalid range if no overlap
    
    Parameters:
    
    r2 -
    
    Returns:
    
    range
  - getMin
```
public int getMin()
```
    get minimum value (MAX_VALUE if inValid)
    
    Returns:
    
    min
  - getMax
```
public int getMax()
```
    get maximum value (MIN_VALUE if inValid)
    
    Returns:
    
    max
  - getRange
```
public int getRange()
```
    get range (MIN_VALUE if invalid)
    
    Returns:
    
    range
  - includes
```
public boolean includes(IntRange r2)
```
    does one range include another
    
    Parameters:
    
    r2 -
    
    Returns:
    
    includes
  - includes
```
public boolean includes(int f)
```
    is a int within a IntRange
    
    Parameters:
    
    f -
    
    Returns:
    
    includes If inValid, return false
  - contains
```
public boolean contains(int f)
```
    synonym for includes()
    
    Parameters:
    
    f -
    
    Returns:
    
    includes
  - add
```
public void add(int x)
```
    add a value to a range
    
    Parameters:
    
    x -
  - toString
```
public String toString()
```
    to string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - compareTo
```
public int compareTo(IntRange intRange)
```
    comparees on min values
    
    Specified by:
    
    compareTo in interface Comparable<IntRange>
    
    Parameters:
    
    intRange -
    
    Returns:
  - getRangeExtendedBy
```
public IntRange getRangeExtendedBy(int minExtend,
                                   int maxExtend)
```
    makes new IntRange extended by deltaMin and deltaMax. the effect is for positive numbers to increase the range. if extensions are negative they are applied, but may result in invalid range (this is not checked at this stage).
    Does not alter this.
    
    Parameters:
    
    minExtend - subtracted from min
    
    maxExtend - added to max
  - touches
```
public boolean touches(IntRange range)
```
    do ranges touch but not overlap? range from [a,b] inclusive touches [c,a-1] or [b+1,c] ([a,b] overlaps with [b,c])
    
    Parameters:
    
    range -
    
    Returns:
  - getMidPoint
```
public int getMidPoint()
```
    mid point of range.
    
    Returns:
  - parseCurlyBracketString
```
public static IntRange parseCurlyBracketString(String token)
```
    interprets a String as an IntRange. {m,n} is interpreted as IntRange(m,n) {*,n} is interpreted as IntRange(any,n) {m,*} is interpreted as IntRange(m,any) {*,*} is interpreted as IntRange(any,any) {m} is interpreted as IntRange(m,m) {*} is interpreted as IntRange(any,any)
    
    Parameters:
    
    token -
    
    Returns:
    
    null if cannot create a valid IntRange
  - createIntRangeList
```
public static List<IntRange> createIntRangeList(List<String> tokens)
```
    creates a list of IntRanges from {...} syntax. uses parseCurlyBracketString()
    
    Parameters:
    
    tokens -
    
    Returns:
  - joinRanges
```
public static List<IntRange> joinRanges(List<IntRange> rangeList,
                                        int tolerance)
```
    joins intRanges A and B when A.getMax() == B.getMin(). Ranges must either "join" within a tolerance or be disjoint. Overlapping ranges will throw an RuntimeException. (1,5), (5,10), (10,15) creates (1,15) (1,5), (5,10), (15,20), (20, 25) creates (1,10) (15, 25) (1,5), (15,20) creates (1,5) (15, 20) (1,5) (2,10) (5, 12) throws an Exception
    
    Parameters:
    
    rangeList - can be in any order, not altered
    
    tolerance - allows for overlap, i.e. (1,5) and (4,10) would "touch" , so would (1,5) and (6,10)
    
    Returns:
    
    List of non-touching joined ranges, sorted by new R.getMin()
  - canJoin
```
public boolean canJoin(IntRange range,
                       int tolerance)
```
    can two ranges be joined at a common point? (1,5) and (5,10) can be joined. Because ranges are sometimes created from real numbers, a tolerance is allowed. This should should normally not be set beyond 1 (1,5) and (6,10) would join with tolerance=1, as would (1,5) and (4,10) (1,5) and (3,10) would not be joinable with tolerance=1
    
    Parameters:
    
    range -
    
    tolerance -
    
    Returns:
  - setMax
```
public void setMax(int max)
```
  - setMin
```
public void setMin(int min)
```

Class IntRange

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASCENDING_MIN_COMPARATOR

maxval

minval

Constructor Detail

IntRange

IntRange

IntRange

IntRange

Method Detail

isValid

isEqualTo

equals

hashCode

plus

intersectsWith

intersectionWith

getMin

getMax

getRange

includes

includes

contains

add

toString

compareTo

getRangeExtendedBy

touches

getMidPoint

parseCurlyBracketString

createIntRangeList

joinRanges

canJoin

setMax

setMin