LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
lsst::sphgeom::Interval1d Class Reference

Interval1d represents closed intervals of ℝ. More...

#include <Interval1d.h>

Inheritance diagram for lsst::sphgeom::Interval1d:
lsst::sphgeom::Interval< Interval1d, double >

Public Member Functions

 Interval1d ()
 
 Interval1d (double x)
 
 Interval1d (double x, double y)
 
 Interval1d (Base const &base)
 
bool isFull () const
 isFull returns true if this interval = ℝ.
 
bool operator== (Interval const &i) const
 Two closed intervals are equal if their endpoints are the same, or both are empty.
 
bool operator== (double x) const
 A closed interval is equal to a point x if both endpoints equal x.
 
bool operator!= (Interval const &i) const
 
bool operator!= (double x) const
 
double getA () const
 getA returns the lower endpoint of this interval.
 
double getB () const
 getB returns the upper endpoint of this interval.
 
bool isEmpty () const
 isEmpty returns true if this interval does not contain any points.
 
double getCenter () const
 getCenter returns the center of this interval.
 
double getSize () const
 getSize returns the size (length, width) of this interval.
 
Interval & dilateBy (double x)
 For positive x, dilateBy morphologically dilates this interval by [-x,x], which is equivalent to the taking the Minkowski sum with [-x,x].
 
Interval & erodeBy (double x)
 
Interval1d dilatedBy (double x) const
 
Interval1d erodedBy (double x) const
 
bool contains (double x) const
 
bool contains (Interval const &x) const
 
bool isDisjointFrom (double x) const
 
bool isDisjointFrom (Interval const &x) const
 
bool intersects (double x) const
 
bool intersects (Interval const &x) const
 
bool isWithin (double x) const
 
bool isWithin (Interval const &x) const
 
Relationship relate (double x) const
 
Relationship relate (Interval const &x) const
 
Interval & clipTo (double x)
 
Interval & clipTo (Interval const &x)
 
Interval1d clippedTo (double x) const
 
Interval1d clippedTo (Interval const &x) const
 
Interval & expandTo (double x)
 
Interval & expandTo (Interval const &x)
 
Interval1d expandedTo (double x) const
 
Interval1d expandedTo (Interval const &x) const
 

Static Public Member Functions

static Interval1d empty ()
 
static Interval1d full ()
 

Detailed Description

Interval1d represents closed intervals of ℝ.

It can represent both empty and full intervals, as well as single points.

Definition at line 47 of file Interval1d.h.

Constructor & Destructor Documentation

◆ Interval1d() [1/4]

lsst::sphgeom::Interval1d::Interval1d ( )
inline

Definition at line 61 of file Interval1d.h.

61: Base() {}

◆ Interval1d() [2/4]

lsst::sphgeom::Interval1d::Interval1d ( double x)
inlineexplicit

Definition at line 63 of file Interval1d.h.

63: Base(x) {}

◆ Interval1d() [3/4]

lsst::sphgeom::Interval1d::Interval1d ( double x,
double y )
inline

Definition at line 65 of file Interval1d.h.

65: Base(x, y) {}
y
int y
Definition SpanSet.cc:48

◆ Interval1d() [4/4]

lsst::sphgeom::Interval1d::Interval1d ( Base const & base)
inline

Definition at line 67 of file Interval1d.h.

67: Base(base) {}

Member Function Documentation

◆ clippedTo() [1/2]

Interval1d lsst::sphgeom::Interval< Interval1d , double >::clippedTo ( double x) const
inlineinherited

clippedTo returns the intersection of this interval and x.

Definition at line 190 of file Interval.h.

◆ clippedTo() [2/2]

Interval1d lsst::sphgeom::Interval< Interval1d , double >::clippedTo ( Interval< Interval1d, double > const & x) const
inlineinherited

clippedTo returns the intersection of this interval and x.

Definition at line 192 of file Interval.h.

◆ clipTo() [1/2]

Interval & lsst::sphgeom::Interval< Interval1d , double >::clipTo ( double x)
inlineinherited

clipTo shrinks this interval until all its points are in x.

Definition at line 166 of file Interval.h.

◆ clipTo() [2/2]

Interval & lsst::sphgeom::Interval< Interval1d , double >::clipTo ( Interval< Interval1d, double > const & x)
inlineinherited

clipTo shrinks this interval until all its points are in x.

Definition at line 177 of file Interval.h.

◆ contains() [1/2]

bool lsst::sphgeom::Interval< Interval1d , double >::contains ( double x) const
inlineinherited

contains returns true if the intersection of this interval and x is equal to x.

Definition at line 105 of file Interval.h.

◆ contains() [2/2]

bool lsst::sphgeom::Interval< Interval1d , double >::contains ( Interval< Interval1d, double > const & x) const
inlineinherited

contains returns true if the intersection of this interval and x is equal to x.

Definition at line 109 of file Interval.h.

◆ dilateBy()

Interval & lsst::sphgeom::Interval< Interval1d , double >::dilateBy ( double x)
inlineinherited

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.

Definition at line 237 of file Interval.h.

◆ dilatedBy()

Interval1d lsst::sphgeom::Interval< Interval1d , double >::dilatedBy ( double x) const
inlineinherited

Definition at line 246 of file Interval.h.

◆ empty()

static Interval1d lsst::sphgeom::Interval1d::empty ( )
inlinestatic

Definition at line 51 of file Interval1d.h.

51 {
52 return Interval1d();
53 }

◆ erodeBy()

Interval & lsst::sphgeom::Interval< Interval1d , double >::erodeBy ( double x)
inlineinherited

Definition at line 245 of file Interval.h.

◆ erodedBy()

Interval1d lsst::sphgeom::Interval< Interval1d , double >::erodedBy ( double x) const
inlineinherited

Definition at line 247 of file Interval.h.

◆ expandedTo() [1/2]

Interval1d lsst::sphgeom::Interval< Interval1d , double >::expandedTo ( double x) const
inlineinherited

expandedTo returns the smallest interval containing the union of this interval and x.

Definition at line 225 of file Interval.h.

◆ expandedTo() [2/2]

Interval1d lsst::sphgeom::Interval< Interval1d , double >::expandedTo ( Interval< Interval1d, double > const & x) const
inlineinherited

expandedTo returns the smallest interval containing the union of this interval and x.

Definition at line 227 of file Interval.h.

◆ expandTo() [1/2]

Interval & lsst::sphgeom::Interval< Interval1d , double >::expandTo ( double x)
inlineinherited

expandTo minimally expands this interval to contain x.

Definition at line 199 of file Interval.h.

◆ expandTo() [2/2]

Interval & lsst::sphgeom::Interval< Interval1d , double >::expandTo ( Interval< Interval1d, double > const & x)
inlineinherited

expandTo minimally expands this interval to contain x.

Definition at line 211 of file Interval.h.

◆ full()

static Interval1d lsst::sphgeom::Interval1d::full ( )
inlinestatic

Definition at line 55 of file Interval1d.h.

55 {
56 return Interval1d(-std::numeric_limits<double>::infinity(),
57 std::numeric_limits<double>::infinity());
58 }

◆ getA()

double lsst::sphgeom::Interval< Interval1d , double >::getA ( ) const
inlineinherited

getA returns the lower endpoint of this interval.

The return value for empty intervals is arbitrary.

Definition at line 83 of file Interval.h.

◆ getB()

double lsst::sphgeom::Interval< Interval1d , double >::getB ( ) const
inlineinherited

getB returns the upper endpoint of this interval.

The return value for empty intervals is arbitrary.

Definition at line 87 of file Interval.h.

◆ getCenter()

double lsst::sphgeom::Interval< Interval1d , double >::getCenter ( ) const
inlineinherited

getCenter returns the center of this interval.

It is arbitrary for empty intervals.

Definition at line 96 of file Interval.h.

◆ getSize()

double lsst::sphgeom::Interval< Interval1d , double >::getSize ( ) const
inlineinherited

getSize returns the size (length, width) of this interval.

It is zero for single-point intervals, and NaN or negative for empty intervals.

Definition at line 100 of file Interval.h.

◆ intersects() [1/2]

bool lsst::sphgeom::Interval< Interval1d , double >::intersects ( double x) const
inlineinherited

intersects returns true if the intersection of this interval and x is non-empty.

Definition at line 137 of file Interval.h.

◆ intersects() [2/2]

bool lsst::sphgeom::Interval< Interval1d , double >::intersects ( Interval< Interval1d, double > const & x) const
inlineinherited

intersects returns true if the intersection of this interval and x is non-empty.

Definition at line 139 of file Interval.h.

◆ isDisjointFrom() [1/2]

bool lsst::sphgeom::Interval< Interval1d , double >::isDisjointFrom ( double x) const
inlineinherited

isDisjointFrom returns true if the intersection of this interval and x is empty.

Definition at line 122 of file Interval.h.

◆ isDisjointFrom() [2/2]

bool lsst::sphgeom::Interval< Interval1d , double >::isDisjointFrom ( Interval< Interval1d, double > const & x) const
inlineinherited

isDisjointFrom returns true if the intersection of this interval and x is empty.

Definition at line 126 of file Interval.h.

◆ isEmpty()

bool lsst::sphgeom::Interval< Interval1d , double >::isEmpty ( ) const
inlineinherited

isEmpty returns true if this interval does not contain any points.

Definition at line 90 of file Interval.h.

◆ isFull()

bool lsst::sphgeom::Interval1d::isFull ( ) const
inline

isFull returns true if this interval = ℝ.

Definition at line 70 of file Interval1d.h.

70 {
71 return getA() == -std::numeric_limits<double>::infinity() &&
72 getB() == std::numeric_limits<double>::infinity();
73 }
lsst::sphgeom::Interval< Interval1d, double >::getA
double getA() const
getA returns the lower endpoint of this interval.
Definition Interval.h:83
lsst::sphgeom::Interval< Interval1d, double >::getB
double getB() const
getB returns the upper endpoint of this interval.
Definition Interval.h:87
std::numeric_limits::infinity
T infinity(T... args)

◆ isWithin() [1/2]

bool lsst::sphgeom::Interval< Interval1d , double >::isWithin ( double x) const
inlineinherited

isWithin returns true if the intersection of this interval and x is this interval.

Definition at line 147 of file Interval.h.

◆ isWithin() [2/2]

bool lsst::sphgeom::Interval< Interval1d , double >::isWithin ( Interval< Interval1d, double > const & x) const
inlineinherited

isWithin returns true if the intersection of this interval and x is this interval.

Definition at line 151 of file Interval.h.

◆ operator!=() [1/2]

bool lsst::sphgeom::Interval< Interval1d , double >::operator!= ( double x) const
inlineinherited

Definition at line 79 of file Interval.h.

◆ operator!=() [2/2]

bool lsst::sphgeom::Interval< Interval1d , double >::operator!= ( Interval< Interval1d, double > const & i) const
inlineinherited

Definition at line 72 of file Interval.h.

◆ operator==() [1/2]

bool lsst::sphgeom::Interval< Interval1d , double >::operator== ( double x) const
inlineinherited

A closed interval is equal to a point x if both endpoints equal x.

Definition at line 75 of file Interval.h.

◆ operator==() [2/2]

bool lsst::sphgeom::Interval< Interval1d , double >::operator== ( Interval< Interval1d, double > const & i) const
inlineinherited

Two closed intervals are equal if their endpoints are the same, or both are empty.

Definition at line 68 of file Interval.h.

◆ relate() [1/2]

Relationship lsst::sphgeom::Interval< Interval1d , double >::relate ( double x) const
inherited

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.

Definition at line 160 of file Interval.h.

◆ relate() [2/2]

Relationship lsst::sphgeom::Interval< Interval1d , double >::relate ( Interval< Interval1d, double > const & x) const
inherited

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.

Definition at line 161 of file Interval.h.

The documentation for this class was generated from the following file:
Generated on Wed Jun 26 2024 00:58:15 for LSST Applications by doxygen 1.10.0