iCub-main
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
QCPRange Class Reference

Represents the range an axis is encompassing. More...

#include <qcustomplot.h>

Public Member Functions

 QCPRange ()
 Constructs a range with lower and upper set to zero. More...
 
 QCPRange (double lower, double upper)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Constructs a range with the specified lower and upper values. More...
 
bool operator== (const QCPRange &other)
 
bool operator!= (const QCPRange &other)
 
QCPRangeoperator+= (const double &value)
 Adds value to both boundaries of the range. More...
 
QCPRangeoperator-= (const double &value)
 Subtracts value from both boundaries of the range. More...
 
QCPRangeoperator*= (const double &value)
 Multiplies both boundaries of the range by value. More...
 
QCPRangeoperator/= (const double &value)
 Divides both boundaries of the range by value. More...
 
double size () const
 Returns the size of the range, i.e. More...
 
double center () const
 Returns the center of the range, i.e. More...
 
void normalize ()
 Makes sure lower is numerically smaller than upper. More...
 
void expand (const QCPRange &otherRange)
 Expands this range such that otherRange is contained in the new range. More...
 
QCPRange expanded (const QCPRange &otherRange) const
 Returns an expanded range that contains this and otherRange. More...
 
QCPRange sanitizedForLogScale () const
 Returns a sanitized version of the range. More...
 
QCPRange sanitizedForLinScale () const
 Returns a sanitized version of the range. More...
 
bool contains (double value) const
 Returns true when value lies within or exactly on the borders of the range. More...
 

Static Public Member Functions

static bool validRange (double lower, double upper)
 Checks, whether the specified range is within valid bounds, which are defined as QCPRange::maxRange and QCPRange::minRange. More...
 
static bool validRange (const QCPRange &range)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Checks, whether the specified range is within valid bounds, which are defined as QCPRange::maxRange and QCPRange::minRange. More...
 

Public Attributes

double lower
 
double upper
 

Static Public Attributes

static const double minRange = 1e-280
 Minimum range size (upper - lower) the range changing functions will accept. More...
 
static const double maxRange = 1e250
 Maximum values (negative and positive) the range will accept in range-changing functions. More...
 

Friends

const QCPRange operator+ (const QCPRange &, double)
 Adds value to both boundaries of the range. More...
 
const QCPRange operator+ (double, const QCPRange &)
 Adds value to both boundaries of the range. More...
 
const QCPRange operator- (const QCPRange &range, double value)
 Subtracts value from both boundaries of the range. More...
 
const QCPRange operator* (const QCPRange &range, double value)
 Multiplies both boundaries of the range by value. More...
 
const QCPRange operator* (double value, const QCPRange &range)
 Multiplies both boundaries of the range by value. More...
 
const QCPRange operator/ (const QCPRange &range, double value)
 Divides both boundaries of the range by value. More...
 

Detailed Description

Represents the range an axis is encompassing.

contains a lower and upper double value and provides convenience input, output and modification functions.

See also
QCPAxis::setRange

Definition at line 475 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPRange() [1/2]

QCPRange::QCPRange ( )

Constructs a range with lower and upper set to zero.

Definition at line 1310 of file qcustomplot.cpp.

◆ QCPRange() [2/2]

QCPRange::QCPRange ( double  lower,
double  upper 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Constructs a range with the specified lower and upper values.

Definition at line 1319 of file qcustomplot.cpp.

Member Function Documentation

◆ center()

double QCPRange::center ( ) const

Returns the center of the range, i.e.

(upper+lower)*0.5

Definition at line 1337 of file qcustomplot.cpp.

◆ contains()

bool QCPRange::contains ( double  value) const

Returns true when value lies within or exactly on the borders of the range.

Definition at line 1453 of file qcustomplot.cpp.

◆ expand()

void QCPRange::expand ( const QCPRange otherRange)

Expands this range such that otherRange is contained in the new range.

It is assumed that both this range and otherRange are normalized (see normalize).

If otherRange is already inside the current range, this function does nothing.

See also
expanded

Definition at line 1360 of file qcustomplot.cpp.

◆ expanded()

QCPRange QCPRange::expanded ( const QCPRange otherRange) const

Returns an expanded range that contains this and otherRange.

It is assumed that both this range and otherRange are normalized (see normalize).

See also
expand

Definition at line 1375 of file qcustomplot.cpp.

◆ normalize()

void QCPRange::normalize ( )

Makes sure lower is numerically smaller than upper.

If this is not the case, the values are swapped.

Definition at line 1346 of file qcustomplot.cpp.

◆ operator!=()

bool QCPRange::operator!= ( const QCPRange other)
inline

Definition at line 484 of file qcustomplot.h.

◆ operator*=()

QCPRange & QCPRange::operator*= ( const double &  value)
inline

Multiplies both boundaries of the range by value.

Definition at line 488 of file qcustomplot.h.

◆ operator+=()

QCPRange & QCPRange::operator+= ( const double &  value)
inline

Adds value to both boundaries of the range.

Definition at line 486 of file qcustomplot.h.

◆ operator-=()

QCPRange & QCPRange::operator-= ( const double &  value)
inline

Subtracts value from both boundaries of the range.

Definition at line 487 of file qcustomplot.h.

◆ operator/=()

QCPRange & QCPRange::operator/= ( const double &  value)
inline

Divides both boundaries of the range by value.

Definition at line 489 of file qcustomplot.h.

◆ operator==()

bool QCPRange::operator== ( const QCPRange other)
inline

Definition at line 483 of file qcustomplot.h.

◆ sanitizedForLinScale()

QCPRange QCPRange::sanitizedForLinScale ( ) const

Returns a sanitized version of the range.

Sanitized means for linear scales, that lower will always be numerically smaller (or equal) to upper.

Definition at line 1443 of file qcustomplot.cpp.

◆ sanitizedForLogScale()

QCPRange QCPRange::sanitizedForLogScale ( ) const

Returns a sanitized version of the range.

Sanitized means for logarithmic scales, that the range won't span the positive and negative sign domain, i.e. contain zero. Further lower will always be numerically smaller (or equal) to upper.

If the original range does span positive and negative sign domains or contains zero, the returned range will try to approximate the original range as good as possible. If the positive interval of the original range is wider than the negative interval, the returned range will only contain the positive interval, with lower bound set to rangeFac or rangeFac *upper, whichever is closer to zero. Same procedure is used if the negative interval is wider than the positive interval, this time by changing the upper bound.

Definition at line 1394 of file qcustomplot.cpp.

◆ size()

double QCPRange::size ( ) const

Returns the size of the range, i.e.

upper-lower

Definition at line 1329 of file qcustomplot.cpp.

◆ validRange() [1/2]

bool QCPRange::validRange ( const QCPRange range)
static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Checks, whether the specified range is within valid bounds, which are defined as QCPRange::maxRange and QCPRange::minRange.

A valid range means:

  • range bounds within -maxRange and maxRange
  • range size above minRange
  • range size below maxRange

Definition at line 1490 of file qcustomplot.cpp.

◆ validRange() [2/2]

bool QCPRange::validRange ( double  lower,
double  upper 
)
static

Checks, whether the specified range is within valid bounds, which are defined as QCPRange::maxRange and QCPRange::minRange.

A valid range means:

  • range bounds within -maxRange and maxRange
  • range size above minRange
  • range size below maxRange

Definition at line 1466 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ operator* [1/2]

const QCPRange operator* ( const QCPRange range,
double  value 
)
friend

Multiplies both boundaries of the range by value.

Definition at line 571 of file qcustomplot.h.

◆ operator* [2/2]

const QCPRange operator* ( double  value,
const QCPRange range 
)
friend

Multiplies both boundaries of the range by value.

Definition at line 581 of file qcustomplot.h.

◆ operator+ [1/2]

const QCPRange operator+ ( const QCPRange range,
double  value 
)
friend

Adds value to both boundaries of the range.

Definition at line 541 of file qcustomplot.h.

◆ operator+ [2/2]

const QCPRange operator+ ( double  value,
const QCPRange range 
)
friend

Adds value to both boundaries of the range.

Definition at line 551 of file qcustomplot.h.

◆ operator-

const QCPRange operator- ( const QCPRange range,
double  value 
)
friend

Subtracts value from both boundaries of the range.

Definition at line 561 of file qcustomplot.h.

◆ operator/

const QCPRange operator/ ( const QCPRange range,
double  value 
)
friend

Divides both boundaries of the range by value.

Definition at line 591 of file qcustomplot.h.

Member Data Documentation

◆ lower

double QCPRange::lower

Definition at line 478 of file qcustomplot.h.

◆ maxRange

const double QCPRange::maxRange = 1e250
static

Maximum values (negative and positive) the range will accept in range-changing functions.

Larger absolute values would cause errors due to the 11-bit exponent of double precision numbers, corresponding to a maximum magnitude of roughly 1e308. Since the number of planck-volumes in the entire visible universe is only ~1e183, this should be enough.

See also
validRange, minRange

Definition at line 509 of file qcustomplot.h.

◆ minRange

const double QCPRange::minRange = 1e-280
static

Minimum range size (upper - lower) the range changing functions will accept.

Smaller intervals would cause errors due to the 11-bit exponent of double precision numbers, corresponding to a minimum magnitude of roughly 1e-308.

See also
validRange, maxRange

Definition at line 508 of file qcustomplot.h.

◆ upper

double QCPRange::upper

Definition at line 478 of file qcustomplot.h.


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