lsst.sphgeom
20.0.0-3-gd2e950e
|
#include <Interval.h>
Public Member Functions | |
Interval () | |
This constructor creates an empty interval. | |
Interval (Scalar x) | |
This constructor creates a closed interval containing only x. | |
Interval (Scalar x, Scalar y) | |
This constructor creates an interval from the given endpoints. | |
bool | operator== (Interval const &i) const |
bool | operator!= (Interval const &i) const |
bool | operator== (Scalar x) const |
A closed interval is equal to a point x if both endpoints equal x. | |
bool | operator!= (Scalar x) const |
Scalar | getA () const |
Scalar | getB () const |
bool | isEmpty () const |
isEmpty returns true if this interval does not contain any points. | |
Scalar | getCenter () const |
Scalar | getSize () const |
Interval & | dilateBy (Scalar x) |
Interval & | erodeBy (Scalar x) |
Derived | dilatedBy (Scalar x) const |
Derived | erodedBy (Scalar x) const |
bool | contains (Scalar x) const |
bool | contains (Interval const &x) const |
bool | isDisjointFrom (Scalar x) const |
bool | isDisjointFrom (Interval const &x) const |
bool | intersects (Scalar x) const |
bool | intersects (Interval const &x) const |
bool | isWithin (Scalar x) const |
bool | isWithin (Interval const &x) const |
Relationship | relate (Scalar x) const |
Relationship | relate (Interval const &x) const |
Interval & | clipTo (Scalar x) |
Interval & | clipTo (Interval const &x) |
Derived | clippedTo (Scalar x) const |
Derived | clippedTo (Interval const &x) const |
Interval & | expandTo (Scalar x) |
Interval & | expandTo (Interval const &x) |
Derived | expandedTo (Scalar x) const |
Derived | expandedTo (Interval const &x) const |
Interval
represents a closed interval of the real numbers by its upper and lower bounds. It is parameterized by the Scalar type, which must be constructible from a double.
An interval with identical upper and lower bounds contains a single point, and is equal to that scalar bound.
An interval with an upper bound less than its lower bound is empty (contains no points), as are intervals with NaN as either bound.
|
inline |
clippedTo
returns the intersection of this interval and x.
|
inline |
clipTo
shrinks this interval until all its points are in x.
|
inline |
contains
returns true if the intersection of this interval and x is equal to x.
|
inline |
For positive x, dilateBy
morphologically dilates this interval by [-x,x], which is equivalent to the taking the Minkowski sum with [-x,x]. For negative x, it morphologically erodes this interval by [x,-x]. If x is zero or NaN, or this interval is empty, there is no effect.
|
inline |
expandedTo
returns the smallest interval containing the union of this interval and x.
|
inline |
expandTo
minimally expands this interval to contain x.
|
inline |
getA
returns the lower endpoint of this interval. The return value for empty intervals is arbitrary.
|
inline |
getB
returns the upper endpoint of this interval. The return value for empty intervals is arbitrary.
|
inline |
getCenter
returns the center of this interval. It is arbitrary for empty intervals.
|
inline |
getSize
returns the size (length, width) of this interval. It is zero for single-point intervals, and NaN or negative for empty intervals.
|
inline |
intersects
returns true if the intersection of this interval and x is non-empty.
|
inline |
isDisjointFrom
returns true if the intersection of this interval and x is empty.
|
inline |
isWithin
returns true if the intersection of this interval and x is this interval.
|
inline |
Two closed intervals are equal if their endpoints are the same, or both are empty.
Relationship lsst::sphgeom::Interval< Derived, Scalar >::relate | ( | Scalar | x | ) | const |
relate
returns a bitset S describing the spatial relationships between this interval and x. For each relation that holds, the bitwise AND of S and the corresponding Relationship will be non-zero.