Reference documentation for deal.II version GIT 6dd81a2340 2022-11-29 05:55:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Private Attributes | List of all members
IndexableGetterFromIndices< Container > Class Template Reference

#include <deal.II/numerics/rtree.h>

Public Types

using IndexableGetter = typename boost::geometry::index::indexable< typename Container::value_type >
using result_type = typename IndexableGetter::result_type
using size_t = typename Container::size_type

Public Member Functions

 IndexableGetterFromIndices (Container const &c)
result_type operator() (size_t i) const

Private Attributes

const Container & container
IndexableGetter getter

Detailed Description

template<typename Container>
class IndexableGetterFromIndices< Container >

A class that may be used as an IndexableGetter template argument for an RTree that stores indices to entries in a Container type.

This class may be used as a proxy to extract an indexable type from compatible containers. For example:

std::vector<std::pair<Point<dim>, double> > point_temperature = fill();
const Point<dim> &p = getter(i); // returns point_temperature[i].first;
IndexableGetter getter
Definition: rtree.h:244
Definition: point.h:111

This class is used by the pack_rtree_of_indices() function to construct an RTree where the leaves are indices pointing to the entries of the container passed to this class.

Definition at line 198 of file rtree.h.

Member Typedef Documentation

◆ IndexableGetter

template<typename Container >
using IndexableGetterFromIndices< Container >::IndexableGetter = typename boost::geometry::index::indexable<typename Container::value_type>

An alias for the boost type that is used to extract a Point, Segment, or BoundingBox from compatible types (pairs, tuples, etc.).

Definition at line 205 of file rtree.h.

◆ result_type

template<typename Container >
using IndexableGetterFromIndices< Container >::result_type = typename IndexableGetter::result_type

An alias to the actual geometrical type.

Definition at line 211 of file rtree.h.

◆ size_t

template<typename Container >
using IndexableGetterFromIndices< Container >::size_t = typename Container::size_type

An alias to the index type.

Definition at line 216 of file rtree.h.

Constructor & Destructor Documentation

◆ IndexableGetterFromIndices()

template<typename Container >
IndexableGetterFromIndices< Container >::IndexableGetterFromIndices ( Container const &  c)

Constructor. Store a const reference to a container.

Definition at line 221 of file rtree.h.

Member Function Documentation

◆ operator()()

template<typename Container >
result_type IndexableGetterFromIndices< Container >::operator() ( size_t  i) const

Implements the IndexableGetter requirements of the rtree class.

Definition at line 229 of file rtree.h.

Member Data Documentation

◆ container

template<typename Container >
const Container& IndexableGetterFromIndices< Container >::container

A const reference to the container.

Definition at line 238 of file rtree.h.

◆ getter

template<typename Container >
IndexableGetter IndexableGetterFromIndices< Container >::getter

An instantiation of the getter that allows easy translation from the container value_type and the actual indexable type.

Definition at line 244 of file rtree.h.

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