JTOOLS::JSplineFunctionalMap< JKey_t, JValue_t, JDistance_t > Struct Template Reference

Type definition of a spline interpolation based on a JMap implementation. More...

#include <JFunctionalMap_t.hh>

Inheritance diagram for JTOOLS::JSplineFunctionalMap< JKey_t, JValue_t, JDistance_t >:

Public Types
typedef JMap< JKey_t, JValue_t, JDistance_t >	collection_type
typedef JFunction< JKey_t, JResultType< JValue_t > ::result_type >	function_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::distance_type	distance_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 function_type::argument_type	argument_type
typedef function_type::result_type	result_type
typedef function_type::JExceptionHandler	exceptionhandler_type
typedef JResultType < ordinate_type >::result_type	data_type
typedef JSplineFunction1D < JSplineElement2D < argument_type, data_type > , JMapCollection< JMap > ::template collection_type, result_type >	JSplineFunction1D_t
typedef JKey_t	key_type
typedef JValue_t	mapped_type
typedef JCollection < JElement2D< JKey_t, JValue_t > , JDistance_t >	container_type
typedef JCollectionElementTransformer < value_type >	transformer_type
typedef std::pair < const_iterator, bool >	pair_type
typedef JFunctional< JKey_t, JResultType< JValue_t > ::result_type >	functional_type
typedef JSupervisor	supervisor_type

Public Member Functions
virtual result_type	evaluate (const argument_type *pX) const override
	Recursive interpolation method implementation. More...
JMap &	add (const JMap &map)
	Add map. 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...
JMap &	sub (const JMap &map)
	Subtract map. 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...
JMap &	mul (const double value)
	Scale contents. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...
JMap &	div (const double value)
	Scale contents. More...
virtual void	clear () override
	Clear. More...
virtual const ordinate_type &	get (typename JClass< abscissa_type >::argument_type x) const override
	Get ordinate value. More...
virtual ordinate_type &	get (typename JClass< abscissa_type >::argument_type x) override
	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 override
	Get number of elements. More...
virtual abscissa_type	getX (int index) const override
	Get abscissa value. More...
virtual abscissa_type	getXmin () const override
	Get minimal abscissa value. More...
virtual abscissa_type	getXmax () const override
	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...
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...
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...
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...
JSupervisor	getSupervisor () const
	Get supervisor. More...
const JExceptionHandler &	getExceptionHandler () const
	Get exception handler. More...
void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions. More...

Static Public Member Functions
static result_type	getValue (const JFunctional &function, const argument_type *pX)
	Recursive function value evaluation. More...
static JClass< result_type > ::argument_type	getValue (typename JClass< result_type >::argument_type value, const argument_type *pX)
	Termination of recursive function value evaluation. 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...
JSupervisor	supervisor

Detailed Description

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>
struct JTOOLS::JSplineFunctionalMap< JKey_t, JValue_t, JDistance_t >

Type definition of a spline interpolation based on a JMap implementation.

Definition at line 28 of file JFunctionalMap_t.hh.

Member Typedef Documentation

typedef JMap <JKey_t, JValue_t, JDistance_t> JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::collection_type

inherited

Definition at line 793 of file JSpline.hh.

typedef JFunction<JKey_t, JResultType< JValue_t >::result_type > JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::function_type

inherited

Definition at line 794 of file JSpline.hh.

typedef collection_type::abscissa_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::abscissa_type

inherited

Definition at line 796 of file JSpline.hh.

typedef collection_type::ordinate_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::ordinate_type

inherited

Definition at line 797 of file JSpline.hh.

typedef collection_type::value_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::value_type

inherited

Definition at line 798 of file JSpline.hh.

typedef collection_type::distance_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::distance_type

inherited

Definition at line 799 of file JSpline.hh.

typedef collection_type::const_iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::const_iterator

inherited

Definition at line 801 of file JSpline.hh.

typedef collection_type::const_reverse_iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::const_reverse_iterator

inherited

Definition at line 802 of file JSpline.hh.

typedef collection_type::iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::iterator

inherited

Definition at line 803 of file JSpline.hh.

typedef collection_type::reverse_iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::reverse_iterator

inherited

Definition at line 804 of file JSpline.hh.

typedef function_type::argument_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::argument_type

inherited

Definition at line 806 of file JSpline.hh.

typedef function_type::result_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::result_type

inherited

Definition at line 807 of file JSpline.hh.

typedef function_type::JExceptionHandler JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::exceptionhandler_type

inherited

Definition at line 808 of file JSpline.hh.

typedef JResultType<ordinate_type>::result_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::data_type

inherited

Definition at line 810 of file JSpline.hh.

typedef JSplineFunction1D<JSplineElement2D<argument_type, data_type>, JMapCollection<JMap >::template collection_type, result_type> JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::JSplineFunction1D_t

inherited

Definition at line 813 of file JSpline.hh.

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

typedef JKey_t JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::key_type

inherited

Definition at line 36 of file JMap.hh.

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

typedef JValue_t JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::mapped_type

inherited

Definition at line 37 of file JMap.hh.

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

typedef JCollection<JElement2D<JKey_t, JValue_t>, JDistance_t> JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::container_type

inherited

Definition at line 39 of file JMap.hh.

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

inherited

Definition at line 96 of file JCollection.hh.

typedef std::pair<const_iterator, bool> JTOOLS::JCollection< JElement2D< JKey_t, JValue_t > , JDistance_t >::pair_type

inherited

Definition at line 97 of file JCollection.hh.

typedef JFunctional<JKey_t , JResultType< JValue_t >::result_type > JTOOLS::JFunction< JKey_t , JResultType< JValue_t >::result_type >::functional_type

inherited

Definition at line 321 of file JFunctional.hh.

typedef JSupervisor JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::supervisor_type

inherited

Definition at line 89 of file JFunctional.hh.

Member Function Documentation

virtual result_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap , JResultType< JValue_t >::result_type , JDistance_t >::evaluate ( const argument_type *  pX ) const

inlineoverridevirtualinherited

Recursive interpolation method implementation.

Parameters

pX	pointer to abscissa values

Returns

function value

Implements JTOOLS::JFunctional< JKey_t, JResultType< JValue_t >::result_type >.

Definition at line 829 of file JSpline.hh.

    {
      const argument_type x = *pX;

      ++pX;  // next argument value

      const_iterator p = this->begin();

      for (typename JSplineFunction1D_t::iterator q = buffer.begin(); q != buffer.end(); ++q, ++p) {
        q->getY() = JFunction<argument_type, data_type>::getValue(p->getY(), pX);
      }

      buffer.compile();

      return buffer(x);
    }

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

JMap& JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::add ( const JMap< JKey_t, JValue_t, JDistance_t > &  map )

inlineinherited

Add map.

Parameters

map

map

Returns

this map

Definition at line 60 of file JMap.hh.

    {
      static_cast<container_type&>(*this).add(static_cast<const container_type&>(map));

      return *this;
    }

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

inlineinherited

Add collection.

Parameters

collection

collection

Returns

this collection

Definition at line 452 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, JValue_t > , JDistance_t >::add ( typename JClass< ordinate_type >::argument_type  value )

inlineinherited

Add offset.

Parameters

value

offset

Returns

this collection

Definition at line 600 of file JCollection.hh.

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

      return *this;
    }

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

inlineinherited

Add function.

Parameters

function

function

Returns

this collection

Definition at line 633 of file JCollection.hh.

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

      return *this;
    }

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

JMap& JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::sub ( const JMap< JKey_t, JValue_t, JDistance_t > &  map )

inlineinherited

Subtract map.

Parameters

map

map

Returns

this map

Definition at line 74 of file JMap.hh.

    {
      static_cast<container_type&>(*this).sub(static_cast<const container_type&>(map));

      return *this;
    }

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

inlineinherited

Subtract collection.

Parameters

collection

collection

Returns

this collection

Definition at line 508 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, JValue_t > , JDistance_t >::sub ( typename JClass< ordinate_type >::argument_type  value )

inlineinherited

Subtract offset.

Parameters

value

offset

Returns

this collection

Definition at line 616 of file JCollection.hh.

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

      return *this;
    }

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

inlineinherited

Subtract function.

Parameters

function

function

Returns

this collection

Definition at line 650 of file JCollection.hh.

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

      return *this;
    }

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

JMap& JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::mul ( const double  value )

inlineinherited

Scale contents.

Parameters

value

multiplication factor

Returns

this map

Definition at line 88 of file JMap.hh.

    {
      static_cast<container_type&>(*this).mul(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 354 of file JMath.hh.

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

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

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

template<class JKey_t, class JValue_t, class JDistance_t = JDistance<JKey_t>>

JMap& JTOOLS::JMap< JKey_t, JValue_t, JDistance_t >::div ( const double  value )

inlineinherited

Scale contents.

Parameters

value

division factor

Returns

this map

Definition at line 101 of file JMap.hh.

    {
      static_cast<container_type&>(*this).div(value);

      return *this;
    }

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

inlineoverridevirtualinherited

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 150 of file JCollection.hh.

    {
      container_type::clear();
    }

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

inlineoverridevirtualinherited

Get ordinate value.

Parameters

x	abscissa value

Returns

ordinate value

Definition at line 162 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, JValue_t > , JDistance_t >::get ( typename JClass< abscissa_type >::argument_type  x )

inlineoverridevirtualinherited

Get ordinate value.

Parameters

x	abscissa value

Returns

ordinate value

Definition at line 180 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, JMATH::getZero<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::JHashMap< JKey_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JTOOLS::JTOOLS::JHashMap< int, JDETECTOR::JModuleAddress > >, JTOOLS::JHashMap< JHead_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JModuleAnalogueSignalProcessor >, JTOOLS::JHashMap< int, int >, JTOOLS::JHashMap< key_type, value_type >, JTOOLS::JHashMap< JACOUSTICS::JEKey, JACOUSTICS::JMODEL::JEmission >, JTOOLS::JHashMap< int, function_type >, JTOOLS::JHashMap< int, JGEOMETRY3D::JQuaternion3D >, JTOOLS::JHashMap< JHead_t, JHashMap< JTail_t, JValue_t, JEvaluator_t >, JEvaluator_t >, JTOOLS::JHashMap< int, JString >, JTOOLS::JHashMap< int, JDETECTOR::JLocation >, JTOOLS::JHashMap< JEKey, JEmission >, JTOOLS::JCollection< JElement_t, JDistance_t >, 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< int, JTOOLS::JTOOLS::JHashMap< int, JDETECTOR::JModuleAddress > >, JTOOLS::JHashMap< JHead_t, JValue_t, JEvaluator_t >, JTOOLS::JHashMap< int, JModuleAnalogueSignalProcessor >, JTOOLS::JHashMap< int, int >, JTOOLS::JHashMap< key_type, value_type >, JTOOLS::JHashMap< JACOUSTICS::JEKey, JACOUSTICS::JMODEL::JEmission >, JTOOLS::JHashMap< int, function_type >, JTOOLS::JHashMap< int, JGEOMETRY3D::JQuaternion3D >, JTOOLS::JHashMap< JHead_t, JHashMap< JTail_t, JValue_t, JEvaluator_t >, JEvaluator_t >, JTOOLS::JHashMap< int, JString >, JTOOLS::JHashMap< int, JDETECTOR::JLocation >, JTOOLS::JHashMap< JEKey, JEmission >, and JTOOLS::JGarbageCollection< JKey_t, JValue_t >.

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

inlineoverridevirtualinherited

Get number of elements.

Returns

number of elements

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 197 of file JCollection.hh.

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

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

inlineoverridevirtualinherited

Get abscissa value.

Parameters

index

index

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 209 of file JCollection.hh.

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

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

inlineoverridevirtualinherited

Get minimal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 220 of file JCollection.hh.

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

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

inlineoverridevirtualinherited

Get maximal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 231 of file JCollection.hh.

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

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

inlineinherited

Get ordinate value.

Parameters

index

index

Returns

ordinate value

Definition at line 244 of file JCollection.hh.

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

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

inlineinherited

Get ordinate value.

Parameters

index

index

Returns

ordinate value

Definition at line 256 of file JCollection.hh.

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

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

inlineinherited

Transform collection.

Parameters

transformer

element transformer

Definition at line 267 of file JCollection.hh.

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

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

inlineinherited

Sort elements.

Definition at line 280 of file JCollection.hh.

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

const_iterator JTOOLS::JCollection< JElement2D< JKey_t, JValue_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 292 of file JCollection.hh.

    {
      return std::lower_bound(this->begin(), this->end(), x, compare);
    }

iterator JTOOLS::JCollection< JElement2D< JKey_t, JValue_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 304 of file JCollection.hh.

    {
      return std::lower_bound(this->begin(), this->end(), x, compare);
    }

pair_type JTOOLS::JCollection< JElement2D< JKey_t, JValue_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 316 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, JValue_t > , JDistance_t >::configure ( const JAbstractCollection< abscissa_type > &  bounds )

inlineinherited

Configure collection.

Parameters

bounds

abscissa values

Definition at line 332 of file JCollection.hh.

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

void JTOOLS::JCollection< JElement2D< JKey_t, JValue_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 344 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, JValue_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 365 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, JValue_t > , JDistance_t >::is_compatible ( const JCollection< JElement2D< JKey_t, JValue_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 394 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, JValue_t > , JDistance_t >::negate ( )

inlineinherited

Negate collection.

Returns

this collection

Definition at line 436 of file JCollection.hh.

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

      return *this;
    }

const JComparator& JTOOLS::JCollection< JElement2D< JKey_t, JValue_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, JValue_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 72 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;
    }

static result_type JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::getValue ( const JFunctional< JKey_t, JResultType< JValue_t >::result_type > &  function, const argument_type *  pX  )

inlinestaticinherited

Recursive function value evaluation.

Parameters

function	function
pX	pointer to abscissa values

Definition at line 107 of file JFunctional.hh.

    {
      return function.evaluate(pX);
    }

static JClass<result_type>::argument_type JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::getValue ( typename JClass< result_type >::argument_type  value, const argument_type *  pX  )

inlinestaticinherited

Termination of recursive function value evaluation.

Parameters

value	result
pX	pointer to abscissa values

Definition at line 121 of file JFunctional.hh.

    {
      return value;
    }

JSupervisor JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns

supervisor

Definition at line 281 of file JFunctional.hh.

    {
      return supervisor;
    }

const JExceptionHandler& JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::getExceptionHandler ( ) const

inlineinherited

Get exception handler.

Returns

exception handler

Definition at line 292 of file JFunctional.hh.

    {
      return *supervisor;
    }

void JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::setExceptionHandler ( const JSupervisor &  supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor

supervisor

Definition at line 303 of file JFunctional.hh.

    {
      this->supervisor = supervisor;
    }

Member Data Documentation

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

inherited

Function object for distance evaluation.

Definition at line 773 of file JCollection.hh.

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

protectedinherited

Function object for comparison.

Definition at line 780 of file JCollection.hh.

JSupervisor JTOOLS::JFunctional< JKey_t , JResultType< JValue_t >::result_type >::supervisor

protectedinherited

Definition at line 310 of file JFunctional.hh.

---

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

• JFunctionalMap_t.hh