JTOOLS::JRange< T, JComparator_t > Class Template Reference

Range of values. More...

#include <JRange.hh>

Inheritance diagram for JTOOLS::JRange< T, JComparator_t >:

Public Types
typedef std::pair< T, T >	pair_type
typedef JRange< T, JComparator_t >	range_type
typedef JLANG::JClass< T > ::argument_type	argument_type
typedef T	key_type
typedef T	mapped_type

Public Member Functions
	JRange ()
	Default constructor. More...
	JRange (const pair_type &pair)
	Constructor. More...
	JRange (argument_type x, argument_type y)
	Constructor. More...
	JRange (argument_type x)
	Constructor. More...
template<class R >
	JRange (R first, R second)
	Constructor. More...
template<class JElement_t , class JAllocator_t >
	JRange (const array_type< JElement_t, JAllocator_t > &buffer)
	Constructor. More...
	operator pair_type () const
	Type conversion operator. More...
const range_type &	getRange () const
	Get range. More...
void	setRange (const range_type &range)
	Set range. More...
void	setRange (argument_type x, argument_type y)
	Set lower and upper limit. More...
template<class R >
void	setRange (R first, R second)
	Set range. More...
template<class JElement_t , class JAllocator_t >
void	setRange (const array_type< JElement_t, JAllocator_t > &buffer)
	Set lower and upper limit according to input data. More...
T	getLowerLimit () const
	Get lower limit. More...
T	getUpperLimit () const
	Get upper limit. More...
void	setLowerLimit (argument_type x)
	Set lower limit. More...
void	setUpperLimit (argument_type y)
	Set upper limit. More...
void	fixLowerLimit (argument_type x)
	Fix lower limit. More...
void	fixUpperLimit (argument_type y)
	Fix upper limit. More...
bool	equals (const range_type &range) const
	Equal method. More...
T	getLength () const
	Get length (difference between upper and lower limit). More...
void	setLength (argument_type length)
	Set length (difference between upper and lower limit). More...
bool	is_valid () const
	Check validity of range. More...
bool	in_range (argument_type x) const
	Test whether value is inside range. More...
bool	operator() (argument_type x) const
	Test whether value is inside range. More...
T	constrain (argument_type x) const
	Constrain value to range. More...
T	mod (argument_type x) const
	Modulo value with respect to range. More...
bool	overlap (const range_type &range) const
	Test overlap with given range. More...
range_type	include (argument_type x)
	Include given value to range. More...
range_type &	join (const range_type &range)
	Join ranges. More...
range_type &	combine (const range_type &range)
	Combine ranges. More...
range_type &	add (argument_type x)
	Add offset. More...
range_type &	sub (argument_type x)
	Subtract offset. More...
range_type &	add (const range_type &range)
	Add offsets. More...
range_type &	sub (const range_type &range)
	Subtract offsets. More...
range_type &	mul (const double factor)
	Multiply range. More...
range_type &	div (const double factor)
	Divide range. More...
T	getN (const double R) const
	Get expected number of occurances of given rate within this interval. More...
const key_type &	getKey () const
const mapped_type &	getValue () const
mapped_type &	getValue ()
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Static Public Member Functions
static T	getMinimum ()
	Get minimum possible value. More...
static T	getMaximum ()
	Get maximum possible value. More...

Public Attributes
JComparator_t	compare
	Function object. More...
T	first
T	second

Static Public Attributes
static const JRange< T, JComparator_t >	DEFAULT_RANGE
	Default range. More...

Protected Member Functions
template<class R >
void	setRange (R first, R second, const JLANG::JBool< false > &option)
	Set range. More...
template<class R >
void	setRange (R first, R second, const JLANG::JBool< true > &option)
	Set range. More...

Detailed Description

template<class T, class JComparator_t = std::less<T>>
class JTOOLS::JRange< T, JComparator_t >

Range of values.

Definition at line 38 of file JRange.hh.

Member Typedef Documentation

template<class T, class JComparator_t = std::less<T>>

typedef std::pair<T,T> JTOOLS::JRange< T, JComparator_t >::pair_type

Definition at line 45 of file JRange.hh.

template<class T, class JComparator_t = std::less<T>>

typedef JRange<T, JComparator_t> JTOOLS::JRange< T, JComparator_t >::range_type

Definition at line 46 of file JRange.hh.

template<class T, class JComparator_t = std::less<T>>

typedef JLANG::JClass<T>::argument_type JTOOLS::JRange< T, JComparator_t >::argument_type

Definition at line 47 of file JRange.hh.

typedef T JTOOLS::JPair< T , T >::key_type

inherited

Definition at line 32 of file JPair.hh.

typedef T JTOOLS::JPair< T , T >::mapped_type

inherited

Definition at line 33 of file JPair.hh.

Constructor & Destructor Documentation

template<class T, class JComparator_t = std::less<T>>

JTOOLS::JRange< T, JComparator_t >::JRange ( )

inline

Default constructor.

This range corresponds to the maximal possible range.

Definition at line 54 of file JRange.hh.

             :
      JPair<T,T>(getMinimum(), getMaximum())
    {}

template<class T, class JComparator_t = std::less<T>>

JTOOLS::JRange< T, JComparator_t >::JRange ( const pair_type &  pair )

inline

Constructor.

Parameters

pair

pair

Definition at line 64 of file JRange.hh.

                                  :
      JPair<T,T>(pair.first, pair.second)
    {}

template<class T, class JComparator_t = std::less<T>>

JTOOLS::JRange< T, JComparator_t >::JRange ( argument_type  x, argument_type  y  )

inline

Constructor.

Parameters

x	lower limit
y	upper limit

Definition at line 75 of file JRange.hh.

                            :
      JPair<T,T>(x, y)
    {}

template<class T, class JComparator_t = std::less<T>>

JTOOLS::JRange< T, JComparator_t >::JRange ( argument_type  x )

inline

Constructor.

Parameters

x	lower and upper limit

Definition at line 86 of file JRange.hh.

                            :
      JPair<T,T>(x, x)
    {}

template<class T, class JComparator_t = std::less<T>>

template<class R >

JTOOLS::JRange< T, JComparator_t >::JRange ( R  first, R  second  )

inline

Constructor.

The arguments could be values or iterators.

Parameters

first	first
second	second

Definition at line 99 of file JRange.hh.

                              :
      JPair<T,T>()
    {
      setRange(first, second);
    }

template<class T, class JComparator_t = std::less<T>>

template<class JElement_t , class JAllocator_t >

JTOOLS::JRange< T, JComparator_t >::JRange ( const array_type< JElement_t, JAllocator_t > &  buffer )

inline

Constructor.

Parameters

buffer

input data

Definition at line 112 of file JRange.hh.

                                                               :
      JPair<T,T>()
    {
      setRange(buffer);
    }

Member Function Documentation

template<class T, class JComparator_t = std::less<T>>

JTOOLS::JRange< T, JComparator_t >::operator pair_type ( ) const

inline

Type conversion operator.

Returns

piar

Definition at line 124 of file JRange.hh.

    {
      return pair_type(getLowerLimit(), getUpperLimit());
    }

template<class T, class JComparator_t = std::less<T>>

const range_type& JTOOLS::JRange< T, JComparator_t >::getRange ( ) const

inline

Get range.

Returns

range

Definition at line 135 of file JRange.hh.

    {
      return static_cast<const range_type&>(*this);
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setRange ( const range_type &  range )

inline

Set range.

Parameters

range

range

Definition at line 146 of file JRange.hh.

    {
      static_cast<range_type&>(*this) = range;
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setRange ( argument_type  x, argument_type  y  )

inline

Set lower and upper limit.

Parameters

x	lower limit
y	upper limit

Definition at line 158 of file JRange.hh.

    {
      this->first  = x;
      this->second = y;
    }

template<class T, class JComparator_t = std::less<T>>

template<class R >

void JTOOLS::JRange< T, JComparator_t >::setRange ( R  first, R  second  )

inline

Set range.

The arguments could be values or iterators.

Parameters

first	first
second	second

Definition at line 173 of file JRange.hh.

    {
      using namespace JLANG;
      
      setRange(first, second, JBool<is_iterator<R>::value>());
    }

template<class T, class JComparator_t = std::less<T>>

template<class JElement_t , class JAllocator_t >

void JTOOLS::JRange< T, JComparator_t >::setRange ( const array_type< JElement_t, JAllocator_t > &  buffer )

inline

Set lower and upper limit according to input data.

Parameters

buffer

input data

Definition at line 187 of file JRange.hh.

    {
      setRange(getMaximum(), getMinimum());

      for (typename array_type<JElement_t, JAllocator_t>::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
        include(*i);
      }
    }

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getLowerLimit ( ) const

inline

Get lower limit.

Returns

lower limit

Definition at line 202 of file JRange.hh.

    {
      return this->first;
    }

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getUpperLimit ( ) const

inline

Get upper limit.

Returns

upper limit

Definition at line 213 of file JRange.hh.

    {
      return this->second;
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setLowerLimit ( argument_type  x )

inline

Set lower limit.

Parameters

x	lower limit

Definition at line 224 of file JRange.hh.

    {
      this->first  = x;
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setUpperLimit ( argument_type  y )

inline

Set upper limit.

Parameters

y	upper limit

Definition at line 235 of file JRange.hh.

    {
      this->second = y;
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::fixLowerLimit ( argument_type  x )

inline

Fix lower limit.

The range is shifted to the given lower limit.

Parameters

x	lower limit

Definition at line 248 of file JRange.hh.

    {
      this->second += x - this->first;
      this->first   = x;
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::fixUpperLimit ( argument_type  y )

inline

Fix upper limit.

The range is shifted to the given upper limit.

Parameters

y	upper limit

Definition at line 262 of file JRange.hh.

    {
      this->first  += y - this->second;
      this->second  = y;
    }

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::equals ( const range_type &  range ) const

inline

Equal method.

Parameters

range

range

Returns

true if this module range equal to given module range; else false

Definition at line 275 of file JRange.hh.

    {
      return (!this->compare(this->getLowerLimit(), range.getLowerLimit()) &&
              !this->compare(range.getLowerLimit(), this->getLowerLimit()) &&
              !this->compare(this->getUpperLimit(), range.getUpperLimit()) &&
              !this->compare(range.getUpperLimit(), this->getUpperLimit()));
    }

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getLength ( ) const

inline

Get length (difference between upper and lower limit).

Returns

length

Definition at line 289 of file JRange.hh.

    {
      return getUpperLimit() - getLowerLimit();
    }

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setLength ( argument_type  length )

inline

Set length (difference between upper and lower limit).

Parameters

length

length

Definition at line 300 of file JRange.hh.

    {
      setUpperLimit(getLowerLimit() + length);
    }

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::is_valid ( ) const

inline

Check validity of range.

Returns

true if lower limit less than or equal to upper limit; else false

Definition at line 311 of file JRange.hh.

    {
      return !compare(getUpperLimit(), getLowerLimit());
    }

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::in_range ( argument_type  x ) const

inline

Test whether value is inside range.

Parameters

x

value

Returns

true if lower limit <= value <= upper limit; else false

Definition at line 323 of file JRange.hh.

    {
      return (!compare(x, getLowerLimit()) && 
              !compare(getUpperLimit(), x));
    }

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::operator() ( argument_type  x ) const

inline

Test whether value is inside range.

Parameters

x

value

Returns

true if lower limit <= value <= upper limit; else false

Definition at line 336 of file JRange.hh.

    {
      return in_range(x);
    }

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::constrain ( argument_type  x ) const

inline

Constrain value to range.

This method returns the original value if it is in this range, else lower limit if value < lower limit or upper limit if value > upper limit.

Parameters

x

value

Returns

lower limit <= x <= upper limit

Definition at line 350 of file JRange.hh.

    {
      if (compare(x, getLowerLimit())) { return getLowerLimit(); }
      if (compare(getUpperLimit(), x)) { return getUpperLimit(); }

      return x;
    }

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::mod ( argument_type  x ) const

inline

Modulo value with respect to range.

Parameters

x

value

Returns

lower limit <= x <= upper limit

Definition at line 365 of file JRange.hh.

    {
      if      (compare(x, getLowerLimit()))
        return x + getLength() * floor((getUpperLimit() - x) / getLength());
      else if (compare(getUpperLimit(), x))
        return x - getLength() * floor((x - getLowerLimit()) / getLength());
      else
        return x;
    }

template<class T, class JComparator_t = std::less<T>>

bool JTOOLS::JRange< T, JComparator_t >::overlap ( const range_type &  range ) const

inline

Test overlap with given range.

The result is equivalent to join(range).is_valid().

Parameters

range

range

Returns

true if there is a non-zero overlap; else false

Definition at line 383 of file JRange.hh.

    {  
      return (compare(getLowerLimit(), range.getUpperLimit()) &&
              compare(range.getLowerLimit(), getUpperLimit()));
    }

template<class T, class JComparator_t = std::less<T>>

range_type JTOOLS::JRange< T, JComparator_t >::include ( argument_type  x )

inline

Include given value to range.

The new lower limit is the minimim of the original lower limit and given value and
the new upper limit is the maximum of the original upper limit and given value;

Parameters

x

value

Returns

range

Definition at line 398 of file JRange.hh.

    {
      if (compare(x, getLowerLimit())) { setLowerLimit(x); }
      if (compare(getUpperLimit(), x)) { setUpperLimit(x); }

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::join ( const range_type &  range )

inline

Join ranges.

The new lower limit is the maximim of the two lower limits and
the new upper limit is the minimum of the two upper limits.
This operation results in an equal or smaller range and may result in an unphysical range (i.e. lower limit > upper limit).

Parameters

range

range

Definition at line 416 of file JRange.hh.

    {  
      if (compare(getLowerLimit(), range.getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
      if (compare(range.getUpperLimit(), getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }

      return *this;      
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::combine ( const range_type &  range )

inline

Combine ranges.

The new lower limit is the minimim of the two lower limits and
the new upper limit is the maximum of the two upper limits.
This operation results in an equal or larger range.

Parameters

range

range

Definition at line 433 of file JRange.hh.

    {  
      if (compare(range.getLowerLimit(), getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
      if (compare(getUpperLimit(), range.getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::add ( argument_type  x )

inline

Add offset.

Parameters

x

offset

Definition at line 447 of file JRange.hh.

    { 
      this->first  += x;
      this->second += x;

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::sub ( argument_type  x )

inline

Subtract offset.

Parameters

x

offset

Definition at line 461 of file JRange.hh.

    { 
      this->first  -= x;
      this->second -= x;

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::add ( const range_type &  range )

inline

Add offsets.

The new lower limit is the sum of the two lower limits and
the new upper limit is the sum of the two upper limits.

Parameters

range

offset

Definition at line 477 of file JRange.hh.

    { 
      this->first  += range.getLowerLimit();
      this->second += range.getUpperLimit();

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::sub ( const range_type &  range )

inline

Subtract offsets.

The new lower limit is the difference of the two lower limits and
the new upper limit is the difference of the two upper limits.

Parameters

range

offset

Definition at line 493 of file JRange.hh.

    { 
      this->first  -= range.getLowerLimit();
      this->second -= range.getUpperLimit();

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::mul ( const double  factor )

inline

Multiply range.

Parameters

factor

factor

Definition at line 507 of file JRange.hh.

    { 
      this->first  *= factor;
      this->second *= factor;

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

range_type& JTOOLS::JRange< T, JComparator_t >::div ( const double  factor )

inline

Divide range.

Parameters

factor

factor

Definition at line 521 of file JRange.hh.

    { 
      this->first  /= factor;
      this->second /= factor;

      return *this;
    }

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getN ( const double  R ) const

inline

Get expected number of occurances of given rate within this interval.

Parameters

R

rate

Returns

expectation value

Definition at line 536 of file JRange.hh.

    {
      return R * (getUpperLimit() - getLowerLimit());
    }

template<class T, class JComparator_t = std::less<T>>

static T JTOOLS::JRange< T, JComparator_t >::getMinimum ( )

inlinestatic

Get minimum possible value.

Returns

minimum possible value

Definition at line 547 of file JRange.hh.

    { 
      return JMATH::JLimits<T>::min();
    }

template<class T, class JComparator_t = std::less<T>>

static T JTOOLS::JRange< T, JComparator_t >::getMaximum ( )

inlinestatic

Get maximum possible value.

Returns

maximum possible value

Definition at line 558 of file JRange.hh.

    { 
      return JMATH::JLimits<T>::max();
    }

template<class T, class JComparator_t = std::less<T>>

template<class R >

void JTOOLS::JRange< T, JComparator_t >::setRange ( R  first, R  second, const JLANG::JBool< false > &  option  )

inlineprotected

Set range.

Parameters

first	first
second	second
option	false

Definition at line 589 of file JRange.hh.

    {
      setRange((argument_type) first, (argument_type) second);
    }

template<class T, class JComparator_t = std::less<T>>

template<class R >

void JTOOLS::JRange< T, JComparator_t >::setRange ( R  first, R  second, const JLANG::JBool< true > &  option  )

inlineprotected

Set range.

Parameters

first	first
second	second
option	true

Definition at line 603 of file JRange.hh.

    {
      setRange(getMaximum(), getMinimum());

      for (R i = first; i != second; ++i) {
        include(*i);
      }
    }

const key_type& JTOOLS::JPair< T , T >::getKey ( ) const

inlineinherited

Definition at line 123 of file JPair.hh.

{ return this->first; }

const mapped_type& JTOOLS::JPair< T , T >::getValue ( ) const

inlineinherited

Definition at line 124 of file JPair.hh.

{ return this->second; }

mapped_type& JTOOLS::JPair< T , T >::getValue ( )

inlineinherited

Definition at line 126 of file JPair.hh.

{ return this->second; }

template<class JFirst_t, class JSecond_t = JNullType>

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 357 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
    }

Member Data Documentation

template<class T, class JComparator_t = std::less<T>>

const JRange< T, JComparator_t > JTOOLS::JRange< T, JComparator_t >::DEFAULT_RANGE

static

Default range.

This range corresponds to an unphysical range.

Definition at line 568 of file JRange.hh.

template<class T, class JComparator_t = std::less<T>>

JComparator_t JTOOLS::JRange< T, JComparator_t >::compare

Function object.

Parameters

first	first argument
second	second argument

Returns

true if first < second; else false

Definition at line 578 of file JRange.hh.

T JTOOLS::JPair< T , T >::first

inherited

Definition at line 128 of file JPair.hh.

T JTOOLS::JPair< T , T >::second

inherited

Definition at line 129 of file JPair.hh.

---

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

• JRange.hh