VP1Interval Class Reference

#include <VP1Interval.h>

Collaboration diagram for VP1Interval:

Public Member Functions
	VP1Interval (const double &lower, const double &upper, bool openLower=true, bool openUpper=true, bool excludeRange=false)
	VP1Interval ()
	~VP1Interval ()
void	setOpenLower (bool openLower)
void	setOpenUpper (bool openUpper)
void	setOpen (bool openLower, bool openUpper)
void	setLower (const double &lower)
void	setUpper (const double &upper)
void	setExcludeInterval (bool excludeInterval)
void	set (const double &lower, const double &upper, bool openLower=true, bool openUpper=true, bool excludeRange=false)
void	translate (const double &)
double	lower () const
double	upper () const
double	openLower () const
double	openUpper () const
bool	excludeInterval () const
QString	toString () const
double	length () const
bool	contains (const double &x) const
bool	contains (const VP1Interval &other) const
bool	hasOverlap (const VP1Interval &other) const
bool	contains (const double &x, const double &period) const
bool	hasOverlap (const VP1Interval &other, const double &period) const
bool	isSane () const
bool	isEmpty () const
bool	isAllR () const
bool	noLowerBound () const
bool	noUpperBound () const
bool	excludedByLower (const double &x) const
bool	excludedByUpper (const double &x) const
bool	operator== (const VP1Interval &other) const

Static Public Member Functions
static double	inf ()

Private Member Functions
void	testSanity () const

Private Attributes
double	m_lower
double	m_upper
bool	m_openLower
bool	m_openUpper
bool	m_excludeInterval

Detailed Description

Definition at line 23 of file VP1Interval.h.

Constructor & Destructor Documentation

VP1Interval() [1/2]

VP1Interval::VP1Interval	(	const double &	lower,
		const double &	upper,
		bool	openLower = true,
		bool	openUpper = true,
		bool	excludeRange = false
	)

Definition at line 20 of file VP1Interval.cxx.

  : m_lower(lower), m_upper(upper), m_openLower(openLower), m_openUpper(openUpper), m_excludeInterval(excludeInterval)
{
  testSanity();
}

VP1Interval() [2/2]

VP1Interval::VP1Interval

(

)

~VP1Interval()

VP1Interval::~VP1Interval ( )

inline

Definition at line 29 of file VP1Interval.h.

{};

Member Function Documentation

contains() [1/3]

bool VP1Interval::contains

(

const double &

x

)

const

contains() [2/3]

bool VP1Interval::contains	(	const double &	x,
		const double &	period
	)		const

Definition at line 90 of file VP1Interval.cxx.

{
  if (isEmpty())
    return false;
 
  if (period<=0)
    return period==0;
 
  if (length()>=period)
    return true;
 
  //Translate x a number of periods, so that x is in
  //[lower,lower+period[, and compare:
  return contains(x+period*ceil((m_lower-x)/period));
}

contains() [3/3]

bool VP1Interval::contains

(

const VP1Interval &

other

)

const

Definition at line 61 of file VP1Interval.cxx.

{
  if (!noLowerBound()) {
    if (other.m_lower<m_lower)
      return false;
    if (other.m_lower==m_lower&&!other.m_openLower&&m_openLower)
      return false;
  }
  if (!noUpperBound()) {
    if (other.m_upper>m_upper)
      return false;
    if (other.m_upper==m_upper&&!other.m_openUpper&&m_openUpper)
      return false;
  }
  return true;
}

excludedByLower()

bool VP1Interval::excludedByLower

(

const double &

x

)

const

excludedByUpper()

bool VP1Interval::excludedByUpper

(

const double &

x

)

const

excludeInterval()

bool VP1Interval::excludeInterval

(

)

const

hasOverlap() [1/2]

bool VP1Interval::hasOverlap

(

const VP1Interval &

other

)

const

Definition at line 45 of file VP1Interval.cxx.

{
  if (isEmpty()||other.isEmpty())
    return false;
  if (isAllR()||other.isAllR())
    return true;
  if (m_upper<other.m_lower||other.m_upper<m_lower)
    return false;
  if (m_upper==other.m_lower)
    return !other.openLower() && !openUpper();
  if (other.m_upper==m_lower)
    return !openLower() && !other.openUpper();
  return true;
}

hasOverlap() [2/2]

bool VP1Interval::hasOverlap	(	const VP1Interval &	other,
		const double &	period
	)		const

Definition at line 108 of file VP1Interval.cxx.

{
  if (isEmpty()||other.isEmpty())
    return false;
  if (period<=0)
    return period==0;
  if (length()>=period||other.length()>=period)
    return true;
  //Translate the other interval so that it's lower value is in
  //[lower,lower+period[, and then compare (both the interval and the
  //interval translated -period are necessary):
  const double t(period*ceil((m_lower-other.m_lower)/period));
  const double a(other.m_lower+t), b(other.m_upper+t);
  if (hasOverlap(VP1Interval(a,b,other.m_openLower,other.m_openUpper)))
    return true;
  return hasOverlap(VP1Interval(a-period,b-period,other.m_openLower,other.m_openUpper));
}

inf()

static double VP1Interval::inf ( )

inlinestatic

Definition at line 25 of file VP1Interval.h.

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

isAllR()

bool VP1Interval::isAllR

(

)

const

isEmpty()

bool VP1Interval::isEmpty

(

)

const

isSane()

bool VP1Interval::isSane

(

)

const

length()

double VP1Interval::length

(

)

const

lower()

double VP1Interval::lower

(

)

const

noLowerBound()

bool VP1Interval::noLowerBound

(

)

const

noUpperBound()

bool VP1Interval::noUpperBound

(

)

const

openLower()

double VP1Interval::openLower

(

)

const

openUpper()

double VP1Interval::openUpper

(

)

const

operator==()

bool VP1Interval::operator==

(

const VP1Interval &

other

)

const

set()

void VP1Interval::set	(	const double &	lower,
		const double &	upper,
		bool	openLower = true,
		bool	openUpper = true,
		bool	excludeRange = false
	)

Definition at line 27 of file VP1Interval.cxx.

{
  m_lower = lower;
  m_upper = upper;
  m_openLower = openLower;
  m_openUpper = openUpper;
  m_excludeInterval = excludeInterval;
  testSanity();
}

setExcludeInterval()

void VP1Interval::setExcludeInterval

(

bool

excludeInterval

)

setLower()

void VP1Interval::setLower

(

const double &

lower

)

setOpen()

void VP1Interval::setOpen	(	bool	openLower,
		bool	openUpper
	)

setOpenLower()

void VP1Interval::setOpenLower

(

bool

openLower

)

setOpenUpper()

void VP1Interval::setOpenUpper

(

bool

openUpper

)

setUpper()

void VP1Interval::setUpper

(

const double &

upper

)

testSanity()

void VP1Interval::testSanity ( ) const

private

Definition at line 38 of file VP1Interval.cxx.

{
  if (!isSane())
    VP1Msg::messageDebug("WARNING: VP1Interval is not sane: "+toString());
}

toString()

QString VP1Interval::toString

(

)

const

translate()

void VP1Interval::translate

(

const double &

)

upper()

double VP1Interval::upper

(

)

const

Member Data Documentation

m_excludeInterval

bool VP1Interval::m_excludeInterval

private

Definition at line 83 of file VP1Interval.h.

m_lower

double VP1Interval::m_lower

private

Definition at line 79 of file VP1Interval.h.

m_openLower

bool VP1Interval::m_openLower

private

Definition at line 81 of file VP1Interval.h.

m_openUpper

bool VP1Interval::m_openUpper

private

Definition at line 82 of file VP1Interval.h.

m_upper

double VP1Interval::m_upper

private

Definition at line 80 of file VP1Interval.h.

---

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

• VP1Interval.h
• VP1Interval.cxx