RealRange (CML Euclid 2.9 API)

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

All Implemented Interfaces:

Comparable<RealRange>, EuclidConstants
```
public class RealRange
extends Object
implements EuclidConstants, Comparable<RealRange>
```
maximum and minimum values Contains two doubles 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 RealRange it becomes initialised.

Author:

(C) P. Murray-Rust, 1996

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RealRange.Direction

Nested Classes
Modifier and Type	Class and Description
`static class`	`RealRange.Direction`

Field Summary

Fields
Modifier and Type Field and Description

protected double maxval
maximum of range

protected double 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

Fields
Modifier and Type	Field and Description
`protected double`	`maxval` maximum of range
`protected double`	`minval` minimum of range

Constructor Summary

Constructors
Constructor and Description
`RealRange()` creates invalid range from POSITIVE_INFINITY to NEGATIVE_INFINITY
`RealRange(double minv, double maxv)` initialise with min and max values; if minv > maxv create inValid RealRange
`RealRange(double minv, double maxv, boolean normalize)` initialise with min and max values; if minv > maxv create inValid RealRange
`RealRange(IntRange ir)` from an IntRange
`RealRange(RealRange r)` copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(double x)` add a value to a range
`int`	`compareTo(RealRange realRange)` comparees on min values
`boolean`	`contains(double f)` synonym for includes()
`static List<RealRange>`	`createRealRangeList(List<String> tokens)` creates a list of RealRanges from {...} syntax.
`double`	`distanceOutside(double d)` gets minimum signed translation required to move point into range If range=(-1, 10) -3 returns 2 -1 returns 0 3 returns 0 10 returns 0 12 returns -2
`boolean`	`equals(Object o)` use with care as uses ==
`void`	`extendBothEndsBy(double tolerance)` subtracts tolerance from min and adds to max if tolerance is negative adds and subtracts if this would result in maxval < minval sets them to mean
`void`	`extendLowerEndBy(double tolerance)` extend minval
`void`	`extendUpperEndBy(double tolerance)` extend maxval
`RealRange`	`format(Integer decimalPlaces)`
`double`	`getMax()` get maximum value (NEGATIVE_INFINITY if inValid)
`double`	`getMidPoint()` get centroid value (NEGATIVE_INFINITY if inValid)
`double`	`getMin()` get minimum value (POSITIVE_INFINITY if inValid)
`double`	`getRandomVariate()` return a number uniformaly distributed within the range.
`double`	`getRange()` get range (NaN if invalid)
`static RealRange`	`getRange(String s)`
`RealRange`	`getRangeExtendedBy(double minExtend, double maxExtend)` makes new RealRange extended by deltaMin and deltaMax.
`Double`	`getScaleTo(RealRange range)` get scale to convert this range to same extent as other.
`int`	`hashCode()`
`boolean`	`includes(double f)` is a double within a RealRange If inValid, return false
`boolean`	`includes(RealRange r2)` does one range include another
`RealRange`	`intersectionWith(RealRange r2)` intersect two ranges and take the range common to both; return null if no overlap
`boolean`	`intersectsWith(RealRange r2)`
`static boolean`	`isEqual(RealRange range0, RealRange range1, double eps)`
`boolean`	`isEqualTo(RealRange r)` Deprecated.
`boolean`	`isEqualTo(RealRange r, double eps)` invalid ranges return false
`boolean`	`isLessThan(RealRange range)` compares ranges independent of origin.
`boolean`	`isValid()` a Range is only valid if its maxval is not less than its minval; this tests for uninitialised ranges
`void`	`normalize()` if min > max swap them
`static RealRange`	`parseCurlyBracketString(String token)` interprets a String as an RealRange.
`RealRange`	`plus(RealRange r2)` combine two ranges if both valid; takes greatest limits of both, else returns InValid
`RealRange`	`plusEquals(RealRange r2)`
`void`	`setRange(double minv, double maxv)` sets range.
`String`	`toString()` to string.

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

- Field Detail
  - maxval
```
protected double maxval
```
    maximum of range
  - minval
```
protected double minval
```
    minimum of range
- Constructor Detail
  - RealRange
```
public RealRange()
```
    creates invalid range from POSITIVE_INFINITY to NEGATIVE_INFINITY
  - RealRange
```
public RealRange(double minv,
                 double maxv)
```
    initialise with min and max values; if minv > maxv create inValid RealRange
    
    Parameters:
    
    minv -
    
    maxv -
  - RealRange
```
public RealRange(double minv,
                 double maxv,
                 boolean normalize)
```
    initialise with min and max values; if minv > maxv create inValid RealRange
    
    Parameters:
    
    minv -
    
    maxv -
    
    normalize - swap params if min > max
  - RealRange
```
public RealRange(RealRange r)
```
    copy constructor
    
    Parameters:
    
    r -
  - RealRange
```
public RealRange(IntRange ir)
```
    from an IntRange
    
    Parameters:
    
    ir -
- Method Detail
  - setRange
```
public void setRange(double minv,
                     double maxv)
```
    sets range. overwrites any previous info
    
    Parameters:
    
    minv -
    
    maxv -
  - getRange
```
public static RealRange getRange(String s)
```
  - equals
```
public boolean equals(Object o)
```
    use with care as uses ==
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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
```
@Deprecated
public boolean isEqualTo(RealRange r)
```
    Deprecated.
    
    invalid ranges return false
    
    Parameters:
    
    r -
    
    Returns:
    
    equal
  - isEqualTo
```
public boolean isEqualTo(RealRange r,
                         double eps)
```
    invalid ranges return false
    
    Parameters:
    
    r -
    
    Returns:
    
    equal
  - plus
```
public RealRange plus(RealRange r2)
```
    combine two ranges if both valid; takes greatest limits of both, else returns InValid
    
    Parameters:
    
    r2 -
    
    Returns:
    
    range
  - plusEquals
```
public RealRange plusEquals(RealRange r2)
```
  - intersectsWith
```
public boolean intersectsWith(RealRange r2)
```
  - intersectionWith
```
public RealRange intersectionWith(RealRange r2)
```
    intersect two ranges and take the range common to both; return null if no overlap
    
    Parameters:
    
    r2 -
    
    Returns:
    
    range
  - getMin
```
public double getMin()
```
    get minimum value (POSITIVE_INFINITY if inValid)
    
    Returns:
    
    min
  - getMax
```
public double getMax()
```
    get maximum value (NEGATIVE_INFINITY if inValid)
    
    Returns:
    
    max
  - getMidPoint
```
public double getMidPoint()
```
    get centroid value (NEGATIVE_INFINITY if inValid)
    
    Returns:
    
    centroid
  - getRange
```
public double getRange()
```
    get range (NaN if invalid)
    
    Returns:
    
    range
  - includes
```
public boolean includes(RealRange r2)
```
    does one range include another
    
    Parameters:
    
    r2 -
    
    Returns:
    
    includes
  - includes
```
public boolean includes(double f)
```
    is a double within a RealRange If inValid, return false
    
    Parameters:
    
    f -
    
    Returns:
    
    includes
  - contains
```
public boolean contains(double f)
```
    synonym for includes()
    
    Parameters:
    
    f -
    
    Returns:
    
    includes
  - add
```
public void add(double x)
```
    add a value to a range
    
    Parameters:
    
    x -
  - getRandomVariate
```
public double getRandomVariate()
```
    return a number uniformaly distributed within the range.
    
    Returns:
    
    number.
  - getScaleTo
```
public Double getScaleTo(RealRange range)
```
    get scale to convert this range to same extent as other.
    
    Parameters:
    
    range - to scale to
    
    Returns:
    
    scale or Double.NaN
  - normalize
```
public void normalize()
```
    if min > max swap them
  - distanceOutside
```
public double distanceOutside(double d)
```
    gets minimum signed translation required to move point into range If range=(-1, 10) -3 returns 2 -1 returns 0 3 returns 0 10 returns 0 12 returns -2
    
    Parameters:
    
    d -
    
    Returns:
    
    0 if in or on range and if null returns Double.NaN
  - toString
```
public String toString()
```
    to string. format: "NULL" or EC.S_LBRAK+minval+S_COMMA+maxval+S_RBRAK;
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - format
```
public RealRange format(Integer decimalPlaces)
```
  - compareTo
```
public int compareTo(RealRange realRange)
```
    comparees on min values
    
    Specified by:
    
    compareTo in interface Comparable<RealRange>
    
    Parameters:
    
    realRange -
    
    Returns:
  - extendBothEndsBy
```
public void extendBothEndsBy(double tolerance)
```
    subtracts tolerance from min and adds to max if tolerance is negative adds and subtracts if this would result in maxval < minval sets them to mean
    
    Parameters:
    
    tolerance -
  - extendLowerEndBy
```
public void extendLowerEndBy(double tolerance)
```
    extend minval
    
    Parameters:
    
    tolerance - if negative cannot get larger than maxval
  - extendUpperEndBy
```
public void extendUpperEndBy(double tolerance)
```
    extend maxval
    
    Parameters:
    
    tolerance - if negative cannot get lower than minval
  - getRangeExtendedBy
```
public RealRange getRangeExtendedBy(double minExtend,
                                    double maxExtend)
```
    makes new RealRange 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
  - parseCurlyBracketString
```
public static RealRange parseCurlyBracketString(String token)
```
    interprets a String as an RealRange. {m,n} is interpreted as RealRange(m,n) {*,n} is interpreted as RealRange(any,n) {m,*} is interpreted as RealRange(m,any) {*,*} is interpreted as RealRange(any,any) {m} is interpreted as RealRange(m,m) {*} is interpreted as RealRange(any,any)
    
    Parameters:
    
    token -
    
    Returns:
    
    null if cannot create a valid RealRange
  - createRealRangeList
```
public static List<RealRange> createRealRangeList(List<String> tokens)
```
    creates a list of RealRanges from {...} syntax. uses parseCurlyBracketString()
    
    Parameters:
    
    tokens -
    
    Returns:
  - isEqual
```
public static boolean isEqual(RealRange range0,
                              RealRange range1,
                              double eps)
```
  - isLessThan
```
public boolean isLessThan(RealRange range)
```
    compares ranges independent of origin.
    
    Parameters:
    
    range -
    
    Returns:

Class RealRange

Nested Class Summary

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maxval

minval

Constructor Detail

RealRange

RealRange

RealRange

RealRange

RealRange

Method Detail

setRange

getRange

equals

hashCode

isValid

isEqualTo

isEqualTo

plus

plusEquals

intersectsWith

intersectionWith

getMin

getMax

getMidPoint

getRange

includes

includes

contains

add

getRandomVariate

getScaleTo

normalize

distanceOutside

toString

format

compareTo

extendBothEndsBy

extendLowerEndBy

extendUpperEndBy

getRangeExtendedBy

parseCurlyBracketString

createRealRangeList

isEqual

isLessThan