RangeMZ Struct Reference

#include <OpenMS/KERNEL/RangeManager.h>

Inheritance diagram for RangeMZ:

Collaboration diagram for RangeMZ:

Public Member Functions
	RangeMZ ()=default
	RangeMZ (const double min, const double max)
void	extendMZ (const double value)
	extend the range such that it includes the given value More...
bool	containsMZ (const double value) const
	is value within [min, max]? More...
bool	containsMZ (const RangeBase &inner_range) const
	is the range inner_range within [min, max] of this range? More...
Accessors for min and max
We use accessors, to keep range consistent (i.e. ensure that min <= max)
void	setMinMZ (const double min)
	sets the minimum (and the maximum, if uninitialized) More...
void	setMaxMZ (const double max)
	sets the maximum (and the minimum, if uninitialized) More...
double	getMinMZ () const
	only useful if isEmpty() returns false More...
double	getMaxMZ () const
	only useful if isEmpty() returns false More...
Public Member Functions inherited from RangeBase
	RangeBase ()=default
	Ctor: initialize with empty range. More...
	RangeBase (const double min, const double max)
void	clear ()
	make the range empty, i.e. isEmpty() will be true More...
bool	isEmpty () const
	is the range empty (i.e. default constructed or cleared using clear())? More...
bool	contains (const double value) const
	is value within [min, max]? More...
bool	contains (const RangeBase &inner_range) const
	is the range inner_range within [min, max]? More...
void	extend (const RangeBase &other)
	ensure the range includes the range of other More...
void	extend (const double value)
	extend the range such that it includes the given value More...
void	scaleBy (const double factor)
	Scale the range of the dimension by a factor. A factor > 1 increases the range; factor < 1 decreases it. More...
void	assign (const RangeBase &rhs)
bool	operator== (const RangeBase &rhs) const
void	setMin (const double min)
	sets the minimum (and the maximum, if uninitialized) More...
void	setMax (const double max)
	sets the maximum (and the minimum, if uninitialized) More...
double	getMin () const
	only useful if isEmpty() returns false More...
double	getMax () const
	only useful if isEmpty() returns false More...

Static Public Attributes
static const MSDim	DIM = MSDim::MZ

Additional Inherited Members
Protected Attributes inherited from RangeBase
double	min_ = std::numeric_limits<double>::max()
double	max_ = -std::numeric_limits<double>::max()

Constructor & Destructor Documentation

RangeMZ() [1/2]

RangeMZ ( )

default

RangeMZ() [2/2]

RangeMZ ( const double  min, const double  max  )

inline

Member Function Documentation

containsMZ() [1/2]

bool containsMZ ( const double  value ) const

inline

is value within [min, max]?

References RangeBase::contains().

containsMZ() [2/2]

bool containsMZ ( const RangeBase &  inner_range ) const

inline

is the range inner_range within [min, max] of this range?

References RangeBase::contains().

extendMZ()

void extendMZ ( const double  value )

inline

extend the range such that it includes the given value

getMaxMZ()

double getMaxMZ ( ) const

inline

only useful if isEmpty() returns false

getMinMZ()

double getMinMZ ( ) const

inline

only useful if isEmpty() returns false

setMaxMZ()

void setMaxMZ ( const double  max )

inline

sets the maximum (and the minimum, if uninitialized)

setMinMZ()

void setMinMZ ( const double  min )

inline

sets the minimum (and the maximum, if uninitialized)

Member Data Documentation

DIM

const MSDim DIM = MSDim::MZ

static