JTOOLS::JMultiGrid< N, JAbscissa_t > Struct Template Reference

Simple data structure for an abstract multidimensional map of equidistant elements. More...

#include <JMultiGrid.hh>

Inheritance diagram for JTOOLS::JMultiGrid< N, JAbscissa_t >:

Public Types
typedef JAbscissa_t	abscissa_type
typedef JMultiKey< N-1, abscissa_type >	key_type

Public Member Functions
	JMultiGrid ()
	Default constructor. More...
	JMultiGrid (const JGrid< abscissa_type > &bounds)
	Constructor. More...
bool	set (unsigned int index, const JGrid< abscissa_type > &bounds)
	Set bounds. More...
virtual const JGrid < abscissa_type > &	operator() (const key_type &key) const override
	Get abscissa values as a function of given key. More...

Protected Attributes
JGrid< JAbscissa_t >	bounds

Detailed Description

template<unsigned int N, class JAbscissa_t>
struct JTOOLS::JMultiGrid< N, JAbscissa_t >

Simple data structure for an abstract multidimensional map of equidistant elements.

This class implements the JAbstractMultiMap interface.

Definition at line 24 of file JMultiGrid.hh.

Member Typedef Documentation

template<unsigned int N, class JAbscissa_t >

typedef JAbscissa_t JTOOLS::JMultiGrid< N, JAbscissa_t >::abscissa_type

Definition at line 28 of file JMultiGrid.hh.

template<unsigned int N, class JAbscissa_t >

typedef JMultiKey<N - 1, abscissa_type> JTOOLS::JMultiGrid< N, JAbscissa_t >::key_type

Definition at line 29 of file JMultiGrid.hh.

Constructor & Destructor Documentation

template<unsigned int N, class JAbscissa_t >

JTOOLS::JMultiGrid< N, JAbscissa_t >::JMultiGrid ( )

inline

Default constructor.

Definition at line 37 of file JMultiGrid.hh.

                 :
      JMultiGrid<N - 1, JAbscissa_t>()
    {}

template<unsigned int N, class JAbscissa_t >

JTOOLS::JMultiGrid< N, JAbscissa_t >::JMultiGrid ( const JGrid< abscissa_type > &  bounds )

inline

Constructor.

Parameters

bounds

bounds

Definition at line 47 of file JMultiGrid.hh.

                                                   :
      JMultiGrid<N - 1, JAbscissa_t>(bounds)
    {
      this->bounds = bounds;
    }

Member Function Documentation

template<unsigned int N, class JAbscissa_t >

bool JTOOLS::JMultiGrid< N, JAbscissa_t >::set ( unsigned int  index, const JGrid< abscissa_type > &  bounds  )

inline

Set bounds.

Parameters

index	index of dimension
bounds	bounds

Returns

true if correctly set; else false

Definition at line 61 of file JMultiGrid.hh.

    {
      if        (index == N - 1) {

        this->bounds = bounds;

      } else if (index <  N - 1) {

        return static_cast<JMultiGrid<N - 1, abscissa_type>&>(*this).set(index, bounds);
      }
      
      return false;
    }

template<unsigned int N, class JAbscissa_t >

virtual const JGrid<abscissa_type>& JTOOLS::JMultiGrid< N, JAbscissa_t >::operator() ( const key_type &  key ) const

inlineoverridevirtual

Get abscissa values as a function of given key.

Parameters

key

key

Returns

abscissa values

Implements JTOOLS::JAbstractMultiMap< N, JAbscissa_t >.

Definition at line 82 of file JMultiGrid.hh.

    {
      return bounds;
    }

Member Data Documentation

template<unsigned int N, class JAbscissa_t >

JGrid<JAbscissa_t> JTOOLS::JMultiGrid< N, JAbscissa_t >::bounds

protected

Definition at line 88 of file JMultiGrid.hh.

---

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

• JMultiGrid.hh