JTOOLS::JHistogramGridMap_t< JKey_t, JHistogram_t, JDistance_t > Struct Template Reference

Type definition of a JHistogramMap based on JGridMap implementation. More...

#include <JHistogramMap_t.hh>

Inheritance diagram for JTOOLS::JHistogramGridMap_t< JKey_t, JHistogram_t, JDistance_t >:

Public Types
typedef JGridMap< JKey_t, JHistogram_t, JDistance_t >	collection_type
typedef JHistogram< JKey_t, typename JHistogram_t::contents_type >	histogram_type
typedef collection_type::abscissa_type	abscissa_type
typedef collection_type::ordinate_type	ordinate_type
typedef collection_type::value_type	value_type
typedef collection_type::const_iterator	const_iterator
typedef collection_type::const_reverse_iterator	const_reverse_iterator
typedef collection_type::iterator	iterator
typedef collection_type::reverse_iterator	reverse_iterator
typedef histogram_type::contents_type	contents_type
typedef JKey_t	key_type
typedef JHistogram_t	mapped_type
typedef collection_type::pair_type	pair_type
typedef JDistance_t	distance_type
typedef std::vector< value_type >	container_type
typedef JCollectionElementTransformer < value_type >	transformer_type

Public Member Functions
virtual void	evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)
	Fill histogram. More...
virtual void	evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)=0
	Histogram filling. More...
JHistogramMap &	mul (typename JLANG::JClass< contents_type >::argument_type factor)
	Scale contents. More...
JCollection &	mul (const double value)
	Scale contents. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...
JHistogram &	mul (const double value)
	Scale histogram. More...
JHistogramMap &	div (typename JLANG::JClass< contents_type >::argument_type factor)
	Scale contents. More...
JCollection &	div (const double value)
	Scale contents. More...
JHistogram &	div (double value)
	Scale histogram. More...
int	getIndex (typename JClass< abscissa_type >::argument_type x) const
	Get index of given abscissa value. More...
const_iterator	lower_bound (typename JClass< abscissa_type >::argument_type x) const
	Get first position of element i, where x >= i->getX(). More...
iterator	lower_bound (typename JClass< abscissa_type >::argument_type x)
	Get first position of element i, where x >= i->getX(). More...
virtual void	clear ()
	Clear. More...
virtual const ordinate_type &	get (typename JClass< abscissa_type >::argument_type x) const
	Get ordinate value. More...
virtual ordinate_type &	get (typename JClass< abscissa_type >::argument_type x)
	Get ordinate value. More...
virtual const mapped_type &	get (typename JClass< key_type >::argument_type key) const =0
	Get mapped value. More...
virtual mapped_type &	get (typename JClass< key_type >::argument_type key)=0
	Get mapped value. More...
virtual int	getSize () const
	Get number of elements. More...
virtual abscissa_type	getX (int index) const
	Get abscissa value. More...
virtual abscissa_type	getXmin () const
	Get minimal abscissa value. More...
virtual abscissa_type	getXmax () const
	Get maximal abscissa value. More...
const ordinate_type &	getY (int index) const
	Get ordinate value. More...
ordinate_type &	getY (int index)
	Get ordinate value. More...
void	transform (const transformer_type &transformer)
	Transform collection. More...
void	sort ()
	Sort elements. More...
pair_type	insert (const value_type &element)
	Insert element. More...
void	configure (const JAbstractCollection< abscissa_type > &bounds)
	Configure collection. More...
void	configure (const JAbstractCollection< abscissa_type > &bounds, typename JClass< ordinate_type >::argument_type value)
	Configure collection. More...
void	configure (const JAbstractCollection< abscissa_type > &bounds, const JFunction1D_t &function)
	Configure collection. More...
bool	is_compatible (const JCollection &collection) const
	Test whether collections are compatible. More...
JCollection &	negate ()
	Negate collection. More...
JCollection &	add (const JCollection &collection)
	Add collection. More...
JCollection &	add (typename JClass< ordinate_type >::argument_type value)
	Add offset. More...
JCollection &	add (const JFunction1D_t &function)
	Add function. More...
JHistogram &	add (const JHistogram &histogram)
	Add histogram. More...
JCollection &	sub (const JCollection &collection)
	Subtract collection. More...
JCollection &	sub (typename JClass< ordinate_type >::argument_type value)
	Subtract offset. More...
JCollection &	sub (const JFunction1D_t &function)
	Subtract function. More...
JHistogram &	sub (const JHistogram &histogram)
	Subtract histogram. More...
const JComparator &	getComparator () const
	Get comparator. More...
const mapped_type &	operator[] (typename JClass< key_type >::argument_type key) const
	Get mapped value. More...
mapped_type &	operator[] (typename JClass< key_type >::argument_type key)
	Get mapped value. More...
void	put (typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
	Put pair-wise element (key,value) into collection. More...
bool	is_equal (const JAbstractCollection &collection) const
	Test whether abstract collections are equal. More...
const contents_type &	getUnderflow () const
	Get contents below lower limit. More...
const contents_type &	getOverflow () const
	Get contents above upper limit. More...
const contents_type &	getIntegral () const
	Get contents above upper limit. More...

Public Attributes
JDistance_t	getDistance
	Function object for distance evaluation. More...

Protected Member Functions
void	resize (typename container_type::size_type size)
	Resize collection. More...

Protected Attributes
JComparator	compare
	Function object for comparison. More...
contents_type	underflow
contents_type	overflow
contents_type	integral

Detailed Description

template<class JKey_t, class JHistogram_t, class JDistance_t = JDistance<JKey_t>>
struct JTOOLS::JHistogramGridMap_t< JKey_t, JHistogram_t, JDistance_t >

Type definition of a JHistogramMap based on JGridMap implementation.

Definition at line 34 of file JHistogramMap_t.hh.

Member Typedef Documentation

typedef JGridMap <JKey_t , JHistogram_t , JDistance_t> JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::collection_type

inherited

Definition at line 34 of file JHistogramMap.hh.

typedef JHistogram<JKey_t , typename JHistogram_t ::contents_type> JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::histogram_type

inherited

Definition at line 35 of file JHistogramMap.hh.

typedef collection_type::abscissa_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::abscissa_type

inherited

Definition at line 37 of file JHistogramMap.hh.

typedef collection_type::ordinate_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::ordinate_type

inherited

Definition at line 38 of file JHistogramMap.hh.

typedef collection_type::value_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::value_type

inherited

Definition at line 39 of file JHistogramMap.hh.

typedef collection_type::const_iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::const_iterator

inherited

Definition at line 41 of file JHistogramMap.hh.

typedef collection_type::const_reverse_iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::const_reverse_iterator

inherited

Definition at line 42 of file JHistogramMap.hh.

typedef collection_type::iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::iterator

inherited

Definition at line 43 of file JHistogramMap.hh.

typedef collection_type::reverse_iterator JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::reverse_iterator

inherited

Definition at line 44 of file JHistogramMap.hh.

typedef histogram_type::contents_type JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::contents_type

inherited

Definition at line 47 of file JHistogramMap.hh.

typedef JKey_t JTOOLS::JGridMap< JKey_t, JHistogram_t , JDistance_t >::key_type

inherited

Definition at line 31 of file JGridMap.hh.

typedef JHistogram_t JTOOLS::JGridMap< JKey_t, JHistogram_t , JDistance_t >::mapped_type

inherited

Definition at line 32 of file JGridMap.hh.

typedef collection_type::pair_type JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::pair_type

inherited

Definition at line 46 of file JGridCollection.hh.

typedef JDistance_t JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::distance_type

inherited

Definition at line 84 of file JCollection.hh.

typedef std::vector<value_type> JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::container_type

inherited

Definition at line 88 of file JCollection.hh.

typedef JCollectionElementTransformer<value_type> JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::transformer_type

inherited

Definition at line 95 of file JCollection.hh.

Member Function Documentation

virtual void JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::evaluate ( const abscissa_type *  pX, typename JLANG::JClass< contents_type >::argument_type  w  )

inlinevirtualinherited

Fill histogram.

Parameters

pX	pointer to abscissa values
w	weight

Definition at line 63 of file JHistogramMap.hh.

    {
      const abscissa_type x = *pX;

      iterator p = this->lower_bound(x);

      this->integral  += w;

      if      (p == this->begin()) 
        this->underflow += w;
      else if (p == this->end()) 
        this->overflow  += w;
      else 
        (--p)->getY().evaluate(++pX, w);
    }    

virtual void JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::evaluate ( const abscissa_type *  pX, typename JLANG::JClass< contents_type >::argument_type  w  )

pure virtualinherited

Histogram filling.

Parameters

pX	pointer to abscissa values
w	weight

JHistogramMap& JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::mul ( typename JLANG::JClass< contents_type >::argument_type  factor )

inlineinherited

Scale contents.

Parameters

factor

multiplication factor

Returns

this histogram

Definition at line 87 of file JHistogramMap.hh.

    {
      collection_type::mul(factor);
      histogram_type ::mul(factor);

      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::mul ( const double  value )

inlineinherited

Scale contents.

Parameters

value

multiplication factor

Returns

this collection

Definition at line 569 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() *= value;
      }

      return *this;
    }

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

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

JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::mul ( const double  value )

inlineinherited

Scale histogram.

Parameters

value

multiplication factor

Returns

this histogram

Definition at line 101 of file JHistogram.hh.

    {
      this->underflow *= value;
      this->overflow  *= value;
      this->integral  *= value;

      return *this;
    }

JHistogramMap& JTOOLS::JHistogramMap< JKey_t , JHistogram_t , JGridMap , JDistance_t >::div ( typename JLANG::JClass< contents_type >::argument_type  factor )

inlineinherited

Scale contents.

Parameters

factor

division factor

Returns

this histogram

Definition at line 102 of file JHistogramMap.hh.

    {
      collection_type::div(factor);
      histogram_type ::div(factor);

      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::div ( const double  value )

inlineinherited

Scale contents.

Parameters

value

division factor

Returns

this collection

Definition at line 585 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() /= value;
      }

      return *this;
    }

JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::div ( double  value )

inlineinherited

Scale histogram.

Parameters

value

division factor

Returns

this histogram

Definition at line 117 of file JHistogram.hh.

    {
      this->underflow /= value;
      this->overflow  /= value;
      this->integral  /= value;

      return *this;
    }

int JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getIndex ( typename JClass< abscissa_type >::argument_type  x ) const

inlineinherited

Get index of given abscissa value.

For values within the range of this collection, the index starts at zero and ends at number of elements minus one. Note that the index could be less than zero or larger than (or equal to) the number of elements, if the given abscissa value is outside the range of this collection.

Parameters

x	abscissa value

Returns

index

Definition at line 66 of file JGridCollection.hh.

    {
      return (int) ((this->size() - 1) * (x - this->begin()->getX()) / (this->rbegin()->getX() - this->begin()->getX()));
    }

const_iterator JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::lower_bound ( typename JClass< abscissa_type >::argument_type  x ) const

inlineinherited

Get first position of element i, where x >= i->getX().

Parameters

x	abscissa value

Returns

position of corresponding element

Definition at line 78 of file JGridCollection.hh.

    {
      const int index = getIndex(x) + 1;

      if      (index <= 0)
        return this->begin();
      else if (index >= (int) this->size())
        return this->end();
      else
        return this->begin() + index;
    }

iterator JTOOLS::JGridCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::lower_bound ( typename JClass< abscissa_type >::argument_type  x )

inlineinherited

Get first position of element i, where x >= i->getX().

Parameters

x	abscissa value

Returns

position of corresponding element

Definition at line 97 of file JGridCollection.hh.

    {
      const int index = getIndex(x) + 1;

      if      (index <= 0)
        return this->begin();
      else if (index >= (int) this->size())
        return this->end();
      else
        return this->begin() + index;
    }

virtual void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::clear ( )

inlinevirtualinherited

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 149 of file JCollection.hh.

    {
      container_type::clear();
    }

virtual const ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x ) const

inlinevirtualinherited

Get ordinate value.

Parameters

x	abscissa value

Returns

ordinate value

Definition at line 161 of file JCollection.hh.

    {
      const_iterator i = this->lower_bound(x);

      if (i == this->end() || this->getDistance(x, i->getX()) > distance_type::precision) {
        THROW(JValueOutOfRange, "Invalid abscissa value " << x);
      }

      return i->getY();
    }

virtual ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x )

inlinevirtualinherited

Get ordinate value.

Parameters

x	abscissa value

Returns

ordinate value

Definition at line 179 of file JCollection.hh.

    {
      iterator i = this->lower_bound(x);

      if (i == this->end() || this->getDistance(x, i->getX()) > distance_type::precision) {
        i = container_type::insert(i, value_type(x, ordinate_type()));
      }

      return i->getY();
    }

template<class JKey_t, class JValue_t>

virtual const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::get ( typename JClass< key_type >::argument_type  key ) const

pure virtualinherited

Get mapped value.

Parameters

key

key

Returns

value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< JHead_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JModuleSignalProcessor >, JTOOLS::JHashMap< JEKey, JEmitter >, JTOOLS::JHashMap< int, JString >, JTOOLS::JHashMap< JHead_t, JHashMap< JTail_t, JValue_t, JEvaluator_t >, JEvaluator_t >, JTOOLS::JHashMap< JACOUSTICS::JEKey, JACOUSTICS::JModel::JEmitter >, JTOOLS::JHashMap< int, JFloor >, and JTOOLS::JGarbageCollection< JKey_t, JValue_t >.

template<class JKey_t, class JValue_t>

virtual mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::get ( typename JClass< key_type >::argument_type  key )

pure virtualinherited

Get mapped value.

Parameters

key

key

Returns

value

Implemented in JTOOLS::JCollection< JElement_t, JDistance_t >, JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< JHead_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JModuleSignalProcessor >, JTOOLS::JHashMap< JEKey, JEmitter >, JTOOLS::JHashMap< int, JString >, JTOOLS::JHashMap< JHead_t, JHashMap< JTail_t, JValue_t, JEvaluator_t >, JEvaluator_t >, JTOOLS::JHashMap< JACOUSTICS::JEKey, JACOUSTICS::JModel::JEmitter >, JTOOLS::JHashMap< int, JFloor >, and JTOOLS::JGarbageCollection< JKey_t, JValue_t >.

virtual int JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getSize ( ) const

inlinevirtualinherited

Get number of elements.

Returns

number of elements

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 196 of file JCollection.hh.

    {
      return (int) this->size();
    }

virtual abscissa_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getX ( int  index ) const

inlinevirtualinherited

Get abscissa value.

Parameters

index

index

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 208 of file JCollection.hh.

    {
      return this->at(index).getX();
    }

virtual abscissa_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getXmin ( ) const

inlinevirtualinherited

Get minimal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 219 of file JCollection.hh.

    {
      return this->begin()->getX();
    }

virtual abscissa_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getXmax ( ) const

inlinevirtualinherited

Get maximal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 230 of file JCollection.hh.

    {
      return this->rbegin()->getX();
    }

const ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getY ( int  index ) const

inlineinherited

Get ordinate value.

Parameters

index

index

Returns

ordinate value

Definition at line 243 of file JCollection.hh.

    {
      return this->at(index).getY();
    }

ordinate_type& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getY ( int  index )

inlineinherited

Get ordinate value.

Parameters

index

index

Returns

ordinate value

Definition at line 255 of file JCollection.hh.

    {
      return this->at(index).getY();
    }

void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::transform ( const transformer_type &  transformer )

inlineinherited

Transform collection.

Parameters

transformer

element transformer

Definition at line 266 of file JCollection.hh.

    {
      collection_type buffer;

      this->swap(buffer);

      for (const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
        this->insert(transformer(*i));
      }
    }

void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sort ( )

inlineinherited

Sort elements.

Definition at line 281 of file JCollection.hh.

    {
      std::sort(this->begin(), this->end(), compare);
    }

pair_type JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::insert ( const value_type &  element )

inlineinherited

Insert element.

Parameters

element

element

Returns

(iterator, status), where status is true if inserted; else false

Definition at line 317 of file JCollection.hh.

    {
      iterator i = this->lower_bound(element.getX());

      if (i == this->end() || this->getDistance(element.getX(), i->getX()) > 0.0)
        return pair_type(container_type::insert(i, element), true);
      else
        return pair_type(this->end(), false);
    }

void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds )

inlineinherited

Configure collection.

Parameters

bounds

abscissa values

Definition at line 333 of file JCollection.hh.

    {
      configure(bounds, JMATH::getZero<ordinate_type>());
    }

void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds, typename JClass< ordinate_type >::argument_type  value  )

inlineinherited

Configure collection.

Parameters

bounds	abscissa values
value	ordinate value

Definition at line 345 of file JCollection.hh.

    {
      this->resize(bounds.getSize());

      for (iterator i = this->begin(); i != this->end(); ++i) {

        const abscissa_type x = bounds.getX(std::distance(this->begin(),i));

        *i = value_type(x,value);
      }
    }

void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds, const JFunction1D_t &  function  )

inlineinherited

Configure collection.

Parameters

bounds	abscissa values
function	function

Definition at line 366 of file JCollection.hh.

    {
      using namespace JLANG;

      collection_type* out = (is_identical(*this, function) ? new collection_type() : this);

      for (int i = 0; i != bounds.getSize(); ++i) {

        const abscissa_type x = bounds.getX(i);

        out->put(x, function(x));
      }

      if (is_identical(*this, function)) {
        
        this->swap(*out);

        delete out;
      }
    }

bool JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::is_compatible ( const JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > &  collection ) const

inlineinherited

Test whether collections are compatible.

Parameters

collection

collection

Returns

true if collections are compatible; else false

Definition at line 395 of file JCollection.hh.

    {
      if (this->empty() || collection.empty()) {

        return true;

      } else {

        const double precision = JDistance<abscissa_type>::precision;
        
        const_iterator p = this->begin();
        const_iterator q = collection.begin();
        
        if        (getDistance(p->getX(), q->getX()) > precision) { 

          do { 
            ++p; 
          } while (p != this->end()      && getDistance(p->getX(), q->getX()) > precision); 

        } else if (getDistance(q->getX(), p->getX()) > precision) { 

          do { 
            ++q; 
          } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision); 
        }

        for ( ; p != this->end() && q != collection.end(); ++p, ++q) {
          if (fabs(getDistance(p->getX(), q->getX())) > precision) {
            return false;
          }
        }

        return true;
      }
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::negate ( )

inlineinherited

Negate collection.

Returns

this collection

Definition at line 437 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() = -i->getY();
      }

      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::add ( const JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > &  collection )

inlineinherited

Add collection.

Parameters

collection

collection

Returns

this collection

Definition at line 453 of file JCollection.hh.

    {
      if (!collection.empty()) {

        if (this->empty()) {

          for (const_iterator i = collection.begin(); i != collection.end(); ++i) {
            this->put(i->getX(), +i->getY());
          }

        } else if (this->is_compatible(collection)) {

          const double precision = JDistance<abscissa_type>::precision;

          iterator       p = this->begin();
          const_iterator q = collection.begin();

          if        (getDistance(p->getX(), q->getX()) > precision) { 

            do {
              ++p; 
            } while (p != this->end()      && getDistance(p->getX(), q->getX()) > precision); 

          } else if (getDistance(q->getX(), p->getX()) > precision) { 

            do { 
              ++q; 
            } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision); 
          }

          const_iterator i = q;

          for ( ; p != this->end() && i != collection.end(); ++p, ++i) {
            p->getY() += i->getY();
          }

          for ( ; i != collection.end(); ++i) {
            this->put(i->getX(), +i->getY());
          }

          for (i = collection.begin(); i != q; ++i) {
            this->put(i->getX(), +i->getY());
          }
        }
      }
      
      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::add ( typename JClass< ordinate_type >::argument_type  value )

inlineinherited

Add offset.

Parameters

value

offset

Returns

this collection

Definition at line 601 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() += value;
      }

      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::add ( const JFunction1D_t &  function )

inlineinherited

Add function.

Parameters

function

function

Returns

this collection

Definition at line 634 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() += function(i->getX());
      }

      return *this;
    }

JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::add ( const JHistogram< JKey_t, JHistogram_t::contents_type > &  histogram )

inlineinherited

Add histogram.

Parameters

histogram

histogram

Returns

this histogram

Definition at line 69 of file JHistogram.hh.

    {
      this->underflow += histogram.underflow;
      this->overflow  += histogram.overflow;
      this->integral  += histogram.integral;

      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sub ( const JCollection< JElement2D< JKey_t, JHistogram_t >, JDistance_t > &  collection )

inlineinherited

Subtract collection.

Parameters

collection

collection

Returns

this collection

Definition at line 509 of file JCollection.hh.

    {
      if (!collection.empty()) {

        if (this->empty()) {

          for (const_iterator i = collection.begin(); i != collection.end(); ++i) {
            this->put(i->getX(), -i->getY());
          }

        } else if (this->is_compatible(collection)) {

          const double precision = JDistance<abscissa_type>::precision;

          iterator       p = this->begin();
          const_iterator q = collection.begin();

          if        (getDistance(p->getX(), q->getX()) > precision) { 

            do {
              ++p; 
            } while (p != this->end()      && getDistance(p->getX(), q->getX()) > precision); 

          } else if (getDistance(q->getX(), p->getX()) > precision) { 

            do { 
              ++q; 
            } while (q != collection.end() && getDistance(q->getX(), p->getX()) > precision); 
          }

          const_iterator i = q;

          for ( ; p != this->end() && i != collection.end(); ++p, ++i) {
            p->getY() -= i->getY();
          }

          for ( ; i != collection.end(); ++i) {
            this->put(i->getX(), -i->getY());
          }

          for (i = collection.begin(); i != q; ++i) {
            this->put(i->getX(), -i->getY());
          }

        } else {

          throw JException("JCollection::add() collections incompatible.");
        }
      }
      
      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sub ( typename JClass< ordinate_type >::argument_type  value )

inlineinherited

Subtract offset.

Parameters

value

offset

Returns

this collection

Definition at line 617 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() -= value;
      }

      return *this;
    }

JCollection& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::sub ( const JFunction1D_t &  function )

inlineinherited

Subtract function.

Parameters

function

function

Returns

this collection

Definition at line 651 of file JCollection.hh.

    {
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() -= function(i->getX());
      }

      return *this;
    }

JHistogram& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::sub ( const JHistogram< JKey_t, JHistogram_t::contents_type > &  histogram )

inlineinherited

Subtract histogram.

Parameters

histogram

histogram

Returns

this histogram

Definition at line 85 of file JHistogram.hh.

    {
      this->underflow -= histogram.underflow;
      this->overflow  -= histogram.overflow;
      this->integral  -= histogram.integral;

      return *this;
    }

const JComparator& JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getComparator ( ) const

inlineinherited

Get comparator.

Returns

comparator

Definition at line 764 of file JCollection.hh.

    {
      return compare;
    }

void JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::resize ( typename container_type::size_type  size )

inlineprotectedinherited

Resize collection.

Parameters

size

size

Definition at line 788 of file JCollection.hh.

    {
      container_type::resize(size);
    }

template<class JKey_t, class JValue_t>

const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type  key ) const

inlineinherited

Get mapped value.

Parameters

key

key

Returns

value

Definition at line 73 of file JMappableCollection.hh.

    {
      return get(key);
    }

template<class JKey_t, class JValue_t>

mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type  key )

inlineinherited

Get mapped value.

Parameters

key

key

Returns

value

Definition at line 85 of file JMappableCollection.hh.

    {
      return get(key);
    }

template<class JKey_t, class JValue_t>

void JTOOLS::JMappableCollection< JKey_t, JValue_t >::put ( typename JClass< key_type >::argument_type  key, typename JClass< mapped_type >::argument_type  value  )

inlineinherited

Put pair-wise element (key,value) into collection.

Parameters

key	key
value	value

Definition at line 97 of file JMappableCollection.hh.

    {
      get(key) = value;
    }

template<class JAbscissa_t>

bool JTOOLS::JAbstractCollection< JAbscissa_t >::is_equal ( const JAbstractCollection< JAbscissa_t > &  collection ) const

inlineinherited

Test whether abstract collections are equal.

Parameters

collection

abstract collection

Returns

true if collections are equals; else false

Definition at line 69 of file JAbstractCollection.hh.

    {
      if (this->getSize() == collection.getSize()) {

        for (int i = 0; i != this->getSize(); ++i) {

          if (this->getX(i) != collection.getX(i)) {
            return false;
          }
        }

        return true;
      }

      return false;
    }

const contents_type& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::getUnderflow ( ) const

inlineinherited

Get contents below lower limit.

Returns

contents

Definition at line 132 of file JHistogram.hh.

    {
      return underflow;
    }

const contents_type& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::getOverflow ( ) const

inlineinherited

Get contents above upper limit.

Returns

contents

Definition at line 143 of file JHistogram.hh.

    {
      return overflow;
    }

const contents_type& JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::getIntegral ( ) const

inlineinherited

Get contents above upper limit.

Returns

contents

Definition at line 154 of file JHistogram.hh.

    {
      return integral;
    }

Member Data Documentation

JDistance_t JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::getDistance

inherited

Function object for distance evaluation.

Definition at line 773 of file JCollection.hh.

JComparator JTOOLS::JCollection< JElement2D< JKey_t, JHistogram_t > , JDistance_t >::compare

protectedinherited

Function object for comparison.

Definition at line 780 of file JCollection.hh.

contents_type JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::underflow

protectedinherited

Definition at line 195 of file JHistogram.hh.

contents_type JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::overflow

protectedinherited

Definition at line 196 of file JHistogram.hh.

contents_type JTOOLS::JHistogram< JKey_t , JHistogram_t::contents_type >::integral

protectedinherited

Definition at line 197 of file JHistogram.hh.

---

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

• JHistogramMap_t.hh