LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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 = ℝ. More...
 
bool operator== (Interval const &i) const
 Two closed intervals are equal if their endpoints are the same, or both are empty. More...
 
bool operator== (double x) const
 A closed interval is equal to a point x if both endpoints equal x. More...
 
bool operator!= (Interval const &i) const
 
bool operator!= (double x) const
 
double getA () const
 getA returns the lower endpoint of this interval. More...
 
double getB () const
 getB returns the upper endpoint of this interval. More...
 
bool isEmpty () const
 isEmpty returns true if this interval does not contain any points. More...
 
double getCenter () const
 getCenter returns the center of this interval. More...
 
double getSize () const
 getSize returns the size (length, width) of this interval. More...
 
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]. More...
 
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
 
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 39 of file Interval1d.h.

Constructor & Destructor Documentation

◆ Interval1d() [1/4]

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

Definition at line 53 of file Interval1d.h.

53 : Base() {}

◆ Interval1d() [2/4]

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

Definition at line 55 of file Interval1d.h.

55 : Base(x) {}

◆ Interval1d() [3/4]

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

Definition at line 57 of file Interval1d.h.

57 : Base(x, y) {}

◆ Interval1d() [4/4]

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

Definition at line 59 of file Interval1d.h.

59 : 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 183 of file Interval.h.

183 { return Interval(*this).clipTo(x); }

◆ 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 185 of file Interval.h.

185  {
186  return Interval(*this).clipTo(x);
187  }

◆ 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 159 of file Interval.h.

159  {
160  if (x != x) {
161  _a = x;
162  _b = x;
163  } else {
164  _a = std::max(_a, x);
165  _b = std::min(_b, x);
166  }
167  return *this;
168  }

◆ 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 170 of file Interval.h.

170  {
171  if (x.isEmpty()) {
172  *this = x;
173  } else if (!isEmpty()) {
174  _a = std::max(_a, x._a);
175  _b = std::min(_b, x._b);
176  }
177  return *this;
178  }

◆ 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 98 of file Interval.h.

98  {
99  return (_a <= x && x <= _b) || x != x;
100  }

◆ 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 102 of file Interval.h.

102  {
103  if (x.isEmpty()) {
104  return true;
105  } else if (isEmpty()) {
106  return false;
107  }
108  return _a <= x._a && _b >= x._b;
109  }

◆ 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 230 of file Interval.h.

230  {
231  if (x == x && !isEmpty()) {
232  _a = _a - x;
233  _b = _b + x;
234  }
235  return *this;
236  }

◆ dilatedBy()

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

Definition at line 239 of file Interval.h.

239 { return Interval(*this).dilateBy(x); }

◆ empty()

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

Definition at line 43 of file Interval1d.h.

43  {
44  return Interval1d();
45  }

◆ erodeBy()

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

Definition at line 238 of file Interval.h.

238 { return dilateBy(-x); }

◆ erodedBy()

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

Definition at line 240 of file Interval.h.

240 { return Interval(*this).erodeBy(x); }

◆ 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 218 of file Interval.h.

218 { return Interval(*this).expandTo(x); }

◆ 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 220 of file Interval.h.

220  {
221  return Interval(*this).expandTo(x);
222  }

◆ expandTo() [1/2]

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

expandTo minimally expands this interval to contain x.

Definition at line 192 of file Interval.h.

192  {
193  if (isEmpty()) {
194  _a = x;
195  _b = x;
196  } else if (x < _a) {
197  _a = x;
198  } else if (x > _b) {
199  _b = x;
200  }
201  return *this;
202  }

◆ 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 204 of file Interval.h.

204  {
205  if (isEmpty()) {
206  *this = x;
207  } else if (!x.isEmpty()) {
208  _a = std::min(_a, x._a);
209  _b = std::max(_b, x._b);
210  }
211  return *this;
212  }

◆ full()

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

Definition at line 47 of file Interval1d.h.

47  {
48  return Interval1d(-std::numeric_limits<double>::infinity(),
49  std::numeric_limits<double>::infinity());
50  }

◆ getA()

double lsst::sphgeom::Interval< Interval1d , double >::getA
inlineinherited

getA returns the lower endpoint of this interval.

The return value for empty intervals is arbitrary.

Definition at line 76 of file Interval.h.

76 { return _a; }

◆ getB()

double lsst::sphgeom::Interval< Interval1d , double >::getB
inlineinherited

getB returns the upper endpoint of this interval.

The return value for empty intervals is arbitrary.

Definition at line 80 of file Interval.h.

80 { return _b; }

◆ getCenter()

double lsst::sphgeom::Interval< Interval1d , double >::getCenter
inlineinherited

getCenter returns the center of this interval.

It is arbitrary for empty intervals.

Definition at line 89 of file Interval.h.

89 { return 0.5 * (_a + _b); }

◆ getSize()

double lsst::sphgeom::Interval< Interval1d , double >::getSize
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 93 of file Interval.h.

93 { return _b - _a; }

◆ 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 130 of file Interval.h.

130 { return _a <= x && x <= _b; }

◆ 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 132 of file Interval.h.

132  {
133  return !isDisjointFrom(x);
134  }

◆ 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 115 of file Interval.h.

115  {
116  return !intersects(x);
117  }

◆ 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 119 of file Interval.h.

119  {
120  if (isEmpty() || x.isEmpty()) {
121  return true;
122  }
123  return _a > x._b || _b < x._a;
124  }

◆ isEmpty()

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

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

Definition at line 83 of file Interval.h.

83  {
84  return !(_a <= _b); // returns true when _a and/or _b is NaN
85  }

◆ isFull()

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

isFull returns true if this interval = ℝ.

Definition at line 62 of file Interval1d.h.

62  {
63  return getA() == -std::numeric_limits<double>::infinity() &&
64  getB() == std::numeric_limits<double>::infinity();
65  }

◆ 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 140 of file Interval.h.

140  {
141  return (_a == x && _b == x) || isEmpty();
142  }

◆ 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 144 of file Interval.h.

144  {
145  return x.contains(*this);
146  }

◆ operator!=() [1/2]

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

Definition at line 72 of file Interval.h.

72 { return !(*this == x); }

◆ operator!=() [2/2]

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

Definition at line 65 of file Interval.h.

65 { return !(*this == i); }

◆ 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 68 of file Interval.h.

68  {
69  return (_a == x && _b == x) || (x != x && isEmpty());
70  }

◆ 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 61 of file Interval.h.

61  {
62  return (_a == i._a && _b == i._b) || (i.isEmpty() && isEmpty());
63  }

◆ 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 153 of file Interval.h.

249  {
250  if (isEmpty()) {
251  if (x != x) {
252  return CONTAINS | DISJOINT | WITHIN;
253  }
254  return DISJOINT | WITHIN;
255  }
256  if (x != x) {
257  return CONTAINS | DISJOINT;
258  }
259  if (_a == x && _b == x) {
260  return CONTAINS | WITHIN;
261  }
262  if (intersects(x)) {
263  return CONTAINS;
264  }
265  return DISJOINT;
266 }

◆ 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 154 of file Interval.h.

271 {
272  if (isEmpty()) {
273  if (x.isEmpty()) {
274  return CONTAINS | DISJOINT | WITHIN;
275  }
276  return DISJOINT | WITHIN;
277  }
278  if (x.isEmpty()) {
279  return CONTAINS | DISJOINT;
280  }
281  if (_a == x._a && _b == x._b) {
282  return CONTAINS | WITHIN;
283  }
284  if (_a > x._b || _b < x._a) {
285  return DISJOINT;
286  }
287  if (_a <= x._a && _b >= x._b) {
288  return CONTAINS;
289  }
290  if (x._a <= _a && x._b >= _b) {
291  return WITHIN;
292  }
293  return INTERSECTS;
294 }
The documentation for this class was generated from the following file:
y
int y
Definition: SpanSet.cc:49
lsst::sphgeom::Interval1d::Interval1d
Interval1d()
Definition: Interval1d.h:53
base
Definition: __init__.py:1
lsst::sphgeom::Interval< Interval1d, double >::getA
double getA() const
getA returns the lower endpoint of this interval.
Definition: Interval.h:76
lsst::sphgeom::Interval< Interval1d, double >::isEmpty
bool isEmpty() const
isEmpty returns true if this interval does not contain any points.
Definition: Interval.h:83
lsst::sphgeom::Interval< Interval1d, double >::Interval
Interval()
This constructor creates an empty interval.
Definition: Interval.h:51
std::numeric_limits::infinity
T infinity(T... args)
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::sphgeom::Interval< Interval1d, double >::getB
double getB() const
getB returns the upper endpoint of this interval.
Definition: Interval.h:80
lsst::sphgeom::Interval< Interval1d, double >::isDisjointFrom
bool isDisjointFrom(double x) const
Definition: Interval.h:115
std::min
T min(T... args)
lsst::sphgeom::Interval< Interval1d, double >::dilateBy
Interval & dilateBy(double x)
For positive x, dilateBy morphologically dilates this interval by [-x,x], which is equivalent to the ...
Definition: Interval.h:230
std::max
T max(T... args)
lsst::sphgeom::Interval< Interval1d, double >::intersects
bool intersects(double x) const
Definition: Interval.h:130
std::numeric_limits
Generated on Wed Jun 24 2020 18:10:44 for LSSTApplications by   doxygen 1.8.18