org.xmlcml.euclid

Class RealInterval

java.lang.Object

org.xmlcml.euclid.RealInterval

All Implemented Interfaces:

EuclidConstants

public class RealInterval
extends Object
implements EuclidConstants

an interval on the real line. may be negative it is allowed for the interval to be of zero length

Author:

pm286

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
RealInterval() constructor.
RealInterval(double x1, double x2) construct from Real2.
RealInterval(RealInterval interval) copy constructor.
RealInterval(RealRange range) constructor from range.

Method Summary

Modifier and Type	Method and Description
double	getLength() get length.
double	midPoint() gets midpoint.
double	offsetTo(RealInterval interval) offset to map one interval onto another.
double	offsetTo(RealInterval interval, double scale) offset to map one interval onto another.
double	scaleTo(RealInterval interval) get scale to other interval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RealInterval

public RealInterval()

constructor. defaults to 0,1

RealInterval

public RealInterval(double x1,
                    double x2)

construct from Real2.

Parameters:

x1 -

x2 -

RealInterval

public RealInterval(RealInterval interval)

copy constructor.

Parameters:

interval -

RealInterval

public RealInterval(RealRange range)

constructor from range. interval direction is therefore always positive

Parameters:

range -

Method Detail

getLength

public double getLength()

get length. could be negative

Returns:

length

scaleTo

public double scaleTo(RealInterval interval)

get scale to other interval. scale is interval.length / this.length

Parameters:

interval -

Returns:

scale may be NaN

offsetTo

public double offsetTo(RealInterval interval)

offset to map one interval onto another. precise mapping

Parameters:

interval -

Returns:

offset applied after scaling

offsetTo

public double offsetTo(RealInterval interval,
                       double scale)

offset to map one interval onto another. maps x1 of each onto eachg other

Parameters:

interval - to map to

scale -

Returns:

offset applied after scaling

midPoint

public double midPoint()

gets midpoint.

Returns:

midpoint