Type definition of range. More...

#include <JRange_t.hh>

Inheritance diagram for JRECONSTRUCTION::JRange_t:

Public Types
typedef std::pair< double, double >	pair_type

typedef JRange< double, std::less< double > >	range_type

typedef JLANG::JClass< double >::argument_type	argument_type

typedef double	key_type

typedef double	mapped_type

Public Member Functions
	JRange_t ()
	Default constructor.

	JRange_t (double x, double y)
	Constructor.

	operator pair_type () const
	Type conversion operator.

const range_type &	getRange () const
	Get range.

void	setRange (const range_type &range)
	Set range.

void	setRange (argument_type x, argument_type y)
	Set lower and upper limit.

void	setRange (R first, R second)
	Set range.

void	setRange (const array_type< JElement_t, JAllocator_t > &buffer)
	Set lower and upper limit according to input data.

double	getLowerLimit () const
	Get lower limit.

double	getUpperLimit () const
	Get upper limit.

void	setLowerLimit (argument_type x)
	Set lower limit.

void	setUpperLimit (argument_type y)
	Set upper limit.

void	fixLowerLimit (argument_type x)
	Fix lower limit.

void	fixUpperLimit (argument_type y)
	Fix upper limit.

bool	equals (const range_type &range) const
	Equal method.

double	getLength () const
	Get length (difference between upper and lower limit).

void	setLength (argument_type length)
	Set length (difference between upper and lower limit).

bool	is_valid () const
	Check validity of range.

bool	in_range (argument_type x) const
	Test whether value is inside range.

bool	operator() (argument_type x) const
	Test whether value is inside range.

double	constrain (argument_type x) const
	Constrain value to range.

double	mod (argument_type x) const
	Modulo value with respect to range.

bool	overlap (const range_type &range) const
	Test overlap with given range.

range_type &	include (argument_type x)
	Include given value to range.

range_type &	join (const range_type &range)
	Join ranges.

range_type &	combine (const range_type &range)
	Combine ranges.

range_type &	add (argument_type x)
	Add offset.

range_type &	add (const range_type &range)
	Add offsets.

range_type &	sub (argument_type x)
	Subtract offset.

range_type &	sub (const range_type &range)
	Subtract offsets.

range_type &	mul (const double factor)
	Multiply range.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

range_type &	div (const double factor)
	Divide range.

const key_type &	getKey () const

const mapped_type &	getValue () const

mapped_type &	getValue ()

Static Public Member Functions
static double	getMinimum ()
	Get minimum possible value.

static double	getMaximum ()
	Get maximum possible value.

static JRange< double, std::less< double > >	DEFAULT_RANGE ()
	Default range.

Public Attributes
std::less< double >	compare
	Function object for comparisons.

double	first

double	second

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

void	setRange (R first, R second, const JLANG::JBool< true > &option)
	Set range.

Detailed Description

Type definition of range.

Definition at line 18 of file JRange_t.hh.

Member Typedef Documentation

◆ pair_type

std::pair<double,double> JTOOLS::JRange< double, std::less<double> >::pair_type

inherited

Definition at line 45 of file JRange.hh.

◆ range_type

JRange<double, std::less<double>> JTOOLS::JRange< double, std::less<double> >::range_type

inherited

Definition at line 46 of file JRange.hh.

◆ argument_type

JLANG::JClass<double>::argument_type JTOOLS::JRange< double, std::less<double> >::argument_type

inherited

Definition at line 47 of file JRange.hh.

◆ key_type

double JTOOLS::JPair< double, double >::key_type

inherited

Definition at line 32 of file JPair.hh.

◆ mapped_type

double JTOOLS::JPair< double, double >::mapped_type

inherited

Definition at line 33 of file JPair.hh.

Constructor & Destructor Documentation

◆ JRange_t() [1/2]

JRECONSTRUCTION::JRange_t::JRange_t ( )

inline

Default constructor.

Definition at line 24 of file JRange_t.hh.

               :
      JTOOLS::JRange<double>()
    {}

◆ JRange_t() [2/2]

JRECONSTRUCTION::JRange_t::JRange_t	(	double	x,
		double	y )

inline

Constructor.

Parameters

x	lower limit
y	upper limit

Definition at line 35 of file JRange_t.hh.

                       :
      JTOOLS::JRange<double>(x, y)
    {}

Member Function Documentation

◆ operator pair_type()

JTOOLS::JRange< double, std::less<double> >::operator pair_type ( ) const

inlineinherited

Type conversion operator.

Returns: piar

Definition at line 124 of file JRange.hh.

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

◆ getRange()

const range_type & JTOOLS::JRange< double, std::less<double> >::getRange ( ) const

inlineinherited

Get range.

Returns: range

Definition at line 135 of file JRange.hh.

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

◆ setRange() [1/6]

void JTOOLS::JRange< double, std::less<double> >::setRange ( const range_type & range )

inlineinherited

Set range.

Parameters

range range

Definition at line 146 of file JRange.hh.

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

◆ setRange() [2/6]

void JTOOLS::JRange< double, std::less<double> >::setRange	(	argument_type	x,
		argument_type	y )

inlineinherited

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;
    }

◆ setRange() [3/6]

void JTOOLS::JRange< double, std::less<double> >::setRange	(	R	first,
		R	second )

inlineinherited

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>());
    }

◆ setRange() [4/6]

void JTOOLS::JRange< double, std::less<double> >::setRange ( const array_type< JElement_t, JAllocator_t > & buffer )

inlineinherited

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);
      }
    }

◆ setRange() [5/6]

void JTOOLS::JRange< double, std::less<double> >::setRange	(	R	first,
		R	second,
		const JLANG::JBool< false > &	option )

inlineprotectedinherited

Set range.

Parameters

first	first
second	second
option	false

Definition at line 576 of file JRange.hh.

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

◆ setRange() [6/6]

void JTOOLS::JRange< double, std::less<double> >::setRange	(	R	first,
		R	second,
		const JLANG::JBool< true > &	option )

inlineprotectedinherited

Set range.

Parameters

first	first
second	second
option	true

Definition at line 590 of file JRange.hh.

    {
      setRange(getMaximum(), getMinimum());
 
      for (R i = first; i != second; ++i) {
        include(*i);
      }
    }

◆ getLowerLimit()

double JTOOLS::JRange< double, std::less<double> >::getLowerLimit ( ) const

inlineinherited

Get lower limit.

Returns: lower limit

Definition at line 202 of file JRange.hh.

    {
      return this->first;
    }

◆ getUpperLimit()

double JTOOLS::JRange< double, std::less<double> >::getUpperLimit ( ) const

inlineinherited

Get upper limit.

Returns: upper limit

Definition at line 213 of file JRange.hh.

    {
      return this->second;
    }

◆ setLowerLimit()

void JTOOLS::JRange< double, std::less<double> >::setLowerLimit ( argument_type x )

inlineinherited

Set lower limit.

Parameters

x	lower limit

Definition at line 224 of file JRange.hh.

    {
      this->first  = x;
    }

◆ setUpperLimit()

void JTOOLS::JRange< double, std::less<double> >::setUpperLimit ( argument_type y )

inlineinherited

Set upper limit.

Parameters

y	upper limit

Definition at line 235 of file JRange.hh.

    {
      this->second = y;
    }

◆ fixLowerLimit()

void JTOOLS::JRange< double, std::less<double> >::fixLowerLimit ( argument_type x )

inlineinherited

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;
    }

◆ fixUpperLimit()

void JTOOLS::JRange< double, std::less<double> >::fixUpperLimit ( argument_type y )

inlineinherited

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;
    }

◆ equals()

bool JTOOLS::JRange< double, std::less<double> >::equals ( const range_type & range ) const

inlineinherited

Equal method.

Parameters

range range

Returns: true if this range is equal to given 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()));
    }

◆ getLength()

double JTOOLS::JRange< double, std::less<double> >::getLength ( ) const

inlineinherited

Get length (difference between upper and lower limit).

Returns: length

Definition at line 289 of file JRange.hh.

    {
      return getUpperLimit() - getLowerLimit();
    }

◆ setLength()

void JTOOLS::JRange< double, std::less<double> >::setLength ( argument_type length )

inlineinherited

Set length (difference between upper and lower limit).

Parameters

length length

Definition at line 300 of file JRange.hh.

    {
      setUpperLimit(getLowerLimit() + length);
    }

◆ is_valid()

bool JTOOLS::JRange< double, std::less<double> >::is_valid ( ) const

inlineinherited

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());
    }

◆ in_range()

bool JTOOLS::JRange< double, std::less<double> >::in_range ( argument_type x ) const

inlineinherited

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));
    }

◆ operator()()

bool JTOOLS::JRange< double, std::less<double> >::operator() ( argument_type x ) const

inlineinherited

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);
    }

◆ constrain()

double JTOOLS::JRange< double, std::less<double> >::constrain ( argument_type x ) const

inlineinherited

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;
    }

◆ mod()

double JTOOLS::JRange< double, std::less<double> >::mod ( argument_type x ) const

inlineinherited

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;
    }

◆ overlap()

bool JTOOLS::JRange< double, std::less<double> >::overlap ( const range_type & range ) const

inlineinherited

Test overlap with given range.

Parameters

range range

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

Definition at line 382 of file JRange.hh.

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

◆ include()

range_type & JTOOLS::JRange< double, std::less<double> >::include ( argument_type x )

inlineinherited

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 397 of file JRange.hh.

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

◆ join()

range_type & JTOOLS::JRange< double, std::less<double> >::join ( const range_type & range )

inlineinherited

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 415 of file JRange.hh.

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

◆ combine()

range_type & JTOOLS::JRange< double, std::less<double> >::combine ( const range_type & range )

inlineinherited

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 432 of file JRange.hh.

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

◆ add() [1/2]

range_type & JTOOLS::JRange< double, std::less<double> >::add ( argument_type x )

inlineinherited

Add offset.

Parameters

x offset

Definition at line 446 of file JRange.hh.

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

◆ add() [2/2]

range_type & JTOOLS::JRange< double, std::less<double> >::add ( const range_type & range )

inlineinherited

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 476 of file JRange.hh.

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

◆ sub() [1/2]

range_type & JTOOLS::JRange< double, std::less<double> >::sub ( argument_type x )

inlineinherited

Subtract offset.

Parameters

x offset

Definition at line 460 of file JRange.hh.

    { 
      this->first  -= x;
      this->second -= x;
 
      return *this;
    }

◆ sub() [2/2]

range_type & JTOOLS::JRange< double, std::less<double> >::sub ( const range_type & range )

inlineinherited

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 492 of file JRange.hh.

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

◆ mul() [1/2]

range_type & JTOOLS::JRange< double, std::less<double> >::mul ( const double factor )

inlineinherited

Multiply range.

Parameters

factor factor

Definition at line 506 of file JRange.hh.

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

◆ mul() [2/2]

template<class JFirst_t , class JSecond_t >

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 354 of file JMath.hh.

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

◆ div()

range_type & JTOOLS::JRange< double, std::less<double> >::div ( const double factor )

inlineinherited

Divide range.

Parameters

factor factor

Definition at line 520 of file JRange.hh.

    { 
      this->first  /= factor;
      this->second /= factor;
 
      return *this;
    }

◆ getMinimum()

static double JTOOLS::JRange< double, std::less<double> >::getMinimum ( )

inlinestaticinherited

Get minimum possible value.

Returns: minimum possible value

Definition at line 534 of file JRange.hh.

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

◆ getMaximum()

static double JTOOLS::JRange< double, std::less<double> >::getMaximum ( )

inlinestaticinherited

Get maximum possible value.

Returns: maximum possible value

Definition at line 545 of file JRange.hh.

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

◆ DEFAULT_RANGE()

static JRange< double, std::less<double> > JTOOLS::JRange< double, std::less<double> >::DEFAULT_RANGE ( )

inlinestaticinherited

Default range.

This range corresponds to an unphysical range.

Definition at line 555 of file JRange.hh.

    {
      return JRange<T, JComparator_t>(JRange<T, JComparator_t>::getMaximum(), 
                                      JRange<T, JComparator_t>::getMinimum());
    }

◆ getKey()

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

inlineinherited

Definition at line 123 of file JPair.hh.

123{ return this->first; }

◆ getValue() [1/2]

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

inlineinherited

Definition at line 124 of file JPair.hh.

124{ return this->second; }

◆ getValue() [2/2]

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

inlineinherited

Definition at line 126 of file JPair.hh.

126{ return this->second; }

Member Data Documentation

◆ compare

std::less<double> JTOOLS::JRange< double, std::less<double> >::compare

inherited

Function object for comparisons.

Definition at line 565 of file JRange.hh.

◆ first

double JTOOLS::JPair< double, double >::first

inherited

Definition at line 128 of file JPair.hh.

◆ second

double JTOOLS::JPair< double, double >::second

inherited

Definition at line 129 of file JPair.hh.

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

JRange_t.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ pair_type

◆ range_type

◆ argument_type

◆ key_type

◆ mapped_type

Constructor & Destructor Documentation

◆ JRange_t() [1/2]

◆ JRange_t() [2/2]

Member Function Documentation

◆ operator pair_type()

◆ getRange()

◆ setRange() [1/6]

◆ setRange() [2/6]

◆ setRange() [3/6]

◆ setRange() [4/6]

◆ setRange() [5/6]

◆ setRange() [6/6]

◆ getLowerLimit()

◆ getUpperLimit()

◆ setLowerLimit()

◆ setUpperLimit()

◆ fixLowerLimit()

◆ fixUpperLimit()

◆ equals()

◆ getLength()

◆ setLength()

◆ is_valid()

◆ in_range()

◆ operator()()

◆ constrain()

◆ mod()

◆ overlap()

◆ include()

◆ join()

◆ combine()

◆ add() [1/2]

◆ add() [2/2]

◆ sub() [1/2]

◆ sub() [2/2]

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ getMinimum()

◆ getMaximum()

◆ DEFAULT_RANGE()

◆ getKey()

◆ getValue() [1/2]

◆ getValue() [2/2]

Member Data Documentation

◆ compare

◆ first

◆ second