lsst::sphgeom::Interval1d Class Reference

Interval1d represents closed intervals of ℝ. More...

#include <Interval1d.h>

Inheritance diagram for lsst::sphgeom::Interval1d:

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

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.

: Base() {}

Interval1d() [2/4]

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

inlineexplicit

Definition at line 55 of file Interval1d.h.

: Base(x) {}

Interval1d() [3/4]

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

inline

Definition at line 57 of file Interval1d.h.

: Base(x, y) {}

Interval1d() [4/4]

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

inline

Definition at line 59 of file Interval1d.h.

: 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.

{ 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.

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

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.

                                {
        if (x != x) {
            _a = x;
            _b = x;
        } else {
            _a = std::max(_a, x);
            _b = std::min(_b, x);
        }
        return *this;
    }

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.

                                          {
        if (x.isEmpty()) {
            *this = x;
        } else if (!isEmpty()) {
            _a = std::max(_a, x._a);
            _b = std::min(_b, x._b);
        }
        return *this;
    }

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.

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

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.

                                            {
        if (x.isEmpty()) {
            return true;
        } else if (isEmpty()) {
            return false;
        }
        return _a <= x._a && _b >= x._b;
    }

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.

                                  {
        if (x == x && !isEmpty()) {
            _a = _a - x;
            _b = _b + x;
        }
        return *this;
    }

dilatedBy()

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

inlineinherited

Definition at line 239 of file Interval.h.

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

empty()

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

inlinestatic

Definition at line 43 of file Interval1d.h.

                              {
        return Interval1d();
    }

erodeBy()

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

inlineinherited

Definition at line 238 of file Interval.h.

{ return dilateBy(-x); }

erodedBy()

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

inlineinherited

Definition at line 240 of file Interval.h.

{ 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.

{ 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.

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

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.

                                  {
        if (isEmpty()) {
            _a = x;
            _b = x;
        } else if (x < _a) {
            _a = x;
        } else if (x > _b) {
            _b = x;
        }
        return *this;
    }

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.

                                            {
        if (isEmpty()) {
            *this = x;
        } else if (!x.isEmpty()) {
            _a = std::min(_a, x._a);
            _b = std::max(_b, x._b);
        }
        return *this;
    }

full()

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

inlinestatic

Definition at line 47 of file Interval1d.h.

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

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

{ return _a; }

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

{ return _b; }

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

{ return 0.5 * (_a + _b); }

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

{ 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.

{ 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.

                                              {
        return !isDisjointFrom(x);
    }

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.

                                        {
        return !intersects(x);
    }

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.

                                                  {
        if (isEmpty() || x.isEmpty()) {
            return true;
        }
        return _a > x._b || _b < x._a;
    }

isEmpty()

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

inlineinherited

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

Definition at line 83 of file Interval.h.

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

isFull()

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

inline

isFull returns true if this interval = ℝ.

Definition at line 62 of file Interval1d.h.

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

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.

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

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.

                                            {
        return x.contains(*this);
    }

operator!=() [1/2]

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

inlineinherited

Definition at line 72 of file Interval.h.

{ 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.

{ 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.

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

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.

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

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.

                                                             {
    if (isEmpty()) {
        if (x != x) {
            return CONTAINS | DISJOINT | WITHIN;
        }
        return DISJOINT | WITHIN;
    }
    if (x != x) {
        return CONTAINS | DISJOINT;
    }
    if (_a == x && _b == x) {
        return CONTAINS | WITHIN;
    }
    if (intersects(x)) {
        return CONTAINS;
    }
    return DISJOINT;
}

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.

{
    if (isEmpty()) {
        if (x.isEmpty()) {
            return CONTAINS | DISJOINT | WITHIN;
        }
        return DISJOINT | WITHIN;
    }
    if (x.isEmpty()) {
        return CONTAINS | DISJOINT;
    }
    if (_a == x._a && _b == x._b) {
        return CONTAINS | WITHIN;
    }
    if (_a > x._b || _b < x._a) {
        return DISJOINT;
    }
    if (_a <= x._a && _b >= x._b) {
        return CONTAINS;
    }
    if (x._a <= _a && x._b >= _b) {
        return WITHIN;
    }
    return INTERSECTS;
}

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/sphgeom/22.0.1-2-gac51dbf+052faf71bd/include/lsst/sphgeom/Interval1d.h