Real2Range (CML Euclid 2.9 API)

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

All Implemented Interfaces:

EuclidConstants
```
public class Real2Range
extends Object
implements EuclidConstants
```
2-D double limits Contains two RealRanges. Can therefore be used to describe 2-dimensional limits (for example axes of graphs, rectangles in graphics, limits of a molecule, etc.)
Default is two default/invalid RealRange components. Adding points will create valid ranges.

Author:

(C) P. Murray-Rust, 1996

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Real2Range.BoxDirection

Nested Classes
Modifier and Type	Class and Description
`static class`	`Real2Range.BoxDirection`

Field Summary
- 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
`Real2Range()` constructor.
`Real2Range(Real2Range r)` copy constructor
`Real2Range(Real2 r2a, Real2 r2b)` create from min corner of box and max corner
`Real2Range(RealRange xr, RealRange yr)` initialise with min and max values;

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(Axis.Axis2 ax, RealRange range)` merge range for given axis.
`void`	`add(Real2 p)` add a Real2 to a range
`Double`	`calculateArea()`
`static Real2Range`	`createFrom(String s)` reads in format of toString() ((a,b)(c,d))
`Real2`	`distanceOutside(Real2 p)` gets minimum X and Y translations required to move point into range uses RealRange.distanceOutside() - see this
`Real2Range`	`format(Integer decimalPlaces)`
`static void`	`format(List<Real2Range> boxList, int nplaces)`
`Real2`	`getCentroid()` get yrange
`Real2[]`	`getCorners()` gets lower left and upper right.
`Dimension`	`getDimension()`
`Double`	`getHorizontalVerticalRatio()` aspect ratio
`Real2`	`getMidPoint(Real2Range.BoxDirection direction)` returns midPoint of box edge.
`Real2Range`	`getReal2RangeExtendedInX(double leftSide, double rightSide)` extends XRange.
`Real2Range`	`getReal2RangeExtendedInY(double topExtend, double bottomExtend)` extends XRange.
`RealRange`	`getRealRange(RealRange.Direction direction)`
`Real2Range`	`getTranformedRange(Transform2 t2)` transform range (as copy)
`Double`	`getXMax()`
`Double`	`getXMin()`
`RealRange`	`getXRange()` get xrange
`Double`	`getYMax()`
`Double`	`getYMin()`
`RealRange`	`getYRange()` get yrange
`boolean`	`includes(Real2 p)` is an Real2 within a Real2Range
`boolean`	`includes(Real2Range r)` is one Real2Range completely within another
`Real2Range`	`intersectionWith(Real2Range r2)` intersect two ranges and take the range common to both; return invalid range if no overlap or either is null/invalid
`boolean`	`isContainedInAnyRange(List<Real2Range> r2rList)` iterates through all boxes and return true r2r is contained in any range
`boolean`	`isEqualTo(Real2Range r2)` Deprecated.
`boolean`	`isEqualTo(Real2Range r2, double eps)` is equals to.
`boolean`	`isHorizontal()`
`boolean`	`isLessThan(Real2Range bbox)` compares boxes independent of origin.
`static boolean`	`isNull(Real2Range r2r)`
`boolean`	`isValid()` a Real2Range is valid if both its constituent ranges are
`boolean`	`isVertical()`
`Real2Range`	`plus(Real2Range r2)` merge two ranges and take the maximum extents not sure the logic is right if this is INVALID then replace with r2 if this is VALID and r2 is INVALID return this else return union of the two
`Real2Range`	`plusEquals(Real2Range r2)`
`void`	`setXRange(RealRange xrange)`
`void`	`setYRange(RealRange yrange)`
`String`	`toString()` to string.

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

- Constructor Detail
  - Real2Range
```
public Real2Range()
```
    constructor. Creates INVALID range
  - Real2Range
```
public Real2Range(RealRange xr,
                  RealRange yr)
```
    initialise with min and max values;
    
    Parameters:
    
    xr -
    
    yr -
  - Real2Range
```
public Real2Range(Real2 r2a,
                  Real2 r2b)
```
    create from min corner of box and max corner
    
    Parameters:
    
    r2a -
    
    r2b -
  - Real2Range
```
public Real2Range(Real2Range r)
```
    copy constructor
    
    Parameters:
    
    r -
- Method Detail
  - createFrom
```
public static Real2Range createFrom(String s)
```
    reads in format of toString() ((a,b)(c,d))
    
    Parameters:
    
    s -
  - isValid
```
public boolean isValid()
```
    a Real2Range is valid if both its constituent ranges are
    
    Returns:
    
    valid
  - isEqualTo
```
@Deprecated
public boolean isEqualTo(Real2Range r2)
```
    Deprecated.
    
    is equals to.
    
    Parameters:
    
    r2 -
    
    Returns:
    
    tru if equal
  - isEqualTo
```
public boolean isEqualTo(Real2Range r2,
                         double eps)
```
    is equals to.
    
    Parameters:
    
    r2 -
    
    Returns:
    
    tru if equal
  - plus
```
public Real2Range plus(Real2Range r2)
```
    merge two ranges and take the maximum extents not sure the logic is right if this is INVALID then replace with r2 if this is VALID and r2 is INVALID return this else return union of the two
    
    Parameters:
    
    r2 -
    
    Returns:
    
    range
  - plusEquals
```
public Real2Range plusEquals(Real2Range r2)
```
  - intersectionWith
```
public Real2Range intersectionWith(Real2Range r2)
```
    intersect two ranges and take the range common to both; return invalid range if no overlap or either is null/invalid
    
    Parameters:
    
    r2 -
    
    Returns:
    
    range
  - getXRange
```
public RealRange getXRange()
```
    get xrange
    
    Returns:
    
    range
  - getYRange
```
public RealRange getYRange()
```
    get yrange
    
    Returns:
    
    range
  - setXRange
```
public void setXRange(RealRange xrange)
```
  - setYRange
```
public void setYRange(RealRange yrange)
```
  - getCentroid
```
public Real2 getCentroid()
```
    get yrange
    
    Returns:
    
    range
  - getCorners
```
public Real2[] getCorners()
```
    gets lower left and upper right.
    
    Returns:
    
    minx,miny ... maxx, maxy
  - includes
```
public boolean includes(Real2 p)
```
    is an Real2 within a Real2Range
    
    Parameters:
    
    p -
    
    Returns:
    
    includes
  - includes
```
public boolean includes(Real2Range r)
```
    is one Real2Range completely within another
    
    Parameters:
    
    r -
    
    Returns:
    
    includes
  - add
```
public void add(Real2 p)
```
    add a Real2 to a range
    
    Parameters:
    
    p -
  - add
```
public void add(Axis.Axis2 ax,
                RealRange range)
```
    merge range for given axis.
    
    Parameters:
    
    ax - axis
    
    range -
  - distanceOutside
```
public Real2 distanceOutside(Real2 p)
```
    gets minimum X and Y translations required to move point into range uses RealRange.distanceOutside() - see this
    
    Parameters:
    
    p -
    
    Returns:
    
    null if p == null or has bad coordinates; Real2(0,0) if in or on range, else translations to touch range
  - getTranformedRange
```
public Real2Range getTranformedRange(Transform2 t2)
```
    transform range (as copy)
    
    Parameters:
    
    t2 -
    
    Returns:
    
    new Range
  - toString
```
public String toString()
```
    to string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - format
```
public Real2Range format(Integer decimalPlaces)
```
  - isNull
```
public static boolean isNull(Real2Range r2r)
```
  - isHorizontal
```
public boolean isHorizontal()
```
  - isVertical
```
public boolean isVertical()
```
  - getHorizontalVerticalRatio
```
public Double getHorizontalVerticalRatio()
```
    aspect ratio
    
    Returns:
    
    xrange / yrange
  - getRealRange
```
public RealRange getRealRange(RealRange.Direction direction)
```
  - isContainedInAnyRange
```
public boolean isContainedInAnyRange(List<Real2Range> r2rList)
```
    iterates through all boxes and return true r2r is contained in any range
    
    Parameters:
    
    r2rList -
    
    Returns:
  - getDimension
```
public Dimension getDimension()
```
  - getXMin
```
public Double getXMin()
```
  - getXMax
```
public Double getXMax()
```
  - getYMin
```
public Double getYMin()
```
  - getYMax
```
public Double getYMax()
```
  - getReal2RangeExtendedInX
```
public Real2Range getReal2RangeExtendedInX(double leftSide,
                                           double rightSide)
```
    extends XRange. does not alter this. Uses range.extendBy(). Positive numbers will expand the range
    
    Parameters:
    
    leftSide -
    
    rightSide -
  - getReal2RangeExtendedInY
```
public Real2Range getReal2RangeExtendedInY(double topExtend,
                                           double bottomExtend)
```
    extends XRange. does not alter this. Uses range.extendBy(). Positive numbers will expand the range
    
    Parameters:
    
    topExtend -
    
    bottomExtend -
  - format
```
public static void format(List<Real2Range> boxList,
                          int nplaces)
```
  - calculateArea
```
public Double calculateArea()
```
  - getMidPoint
```
public Real2 getMidPoint(Real2Range.BoxDirection direction)
```
    returns midPoint of box edge.
    
    Parameters:
    
    direction -
    
    Returns:
    
    mid point
  - isLessThan
```
public boolean isLessThan(Real2Range bbox)
```
    compares boxes independent of origin.
    
    Parameters:
    
    bbox -
    
    Returns:

Class Real2Range

Nested Class Summary

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Real2Range

Real2Range

Real2Range

Real2Range

Method Detail

createFrom

isValid

isEqualTo

isEqualTo

plus

plusEquals

intersectionWith

getXRange

getYRange

setXRange

setYRange

getCentroid

getCorners

includes

includes

add

add

distanceOutside

getTranformedRange

toString

format

isNull

isHorizontal

isVertical

getHorizontalVerticalRatio

getRealRange

isContainedInAnyRange

getDimension

getXMin

getXMax

getYMin

getYMax

getReal2RangeExtendedInX

getReal2RangeExtendedInY

format

calculateArea

getMidPoint

isLessThan