LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | List of all members
util::GridContainerBase3D< DATUM, IXMAN > Class Template Reference

Base class for a container of data arranged on a 3D-grid. More...

#include "GridContainers.h"

Inheritance diagram for util::GridContainerBase3D< DATUM, IXMAN >:
util::GridContainerBase2D< DATUM, IXMAN > util::GridContainerBase1D< DATUM, IXMAN > util::details::GridContainerBase< DATUM, IXMAN >

Public Types

using Datum_t = DATUM
 type of contained datum More...
 
using Indexer_t = IXMAN
 
using Grid_t = GridContainerBase< Datum_t, Indexer_t >
 this type More...
 
using CellIndex_t = typename Indexer_t::CellIndex_t
 type of index for direct access to the cell More...
 
using CellIndexOffset_t = typename Indexer_t::CellIndexOffset_t
 type of difference between indices More...
 
using CellDimIndex_t = typename Indexer_t::CellDimIndex_t
 type of difference between indices More...
 
using CellID_t = typename Indexer_t::CellID_t
 type of cell coordinate (x, y, z) More...
 
using Cell_t = std::vector< Datum_t >
 type of a single cell container More...
 
using Cells_t = std::vector< Cell_t >
 type of container holding all cells More...
 
using const_iterator = typename Cells_t::const_iterator
 type of iterator to all cells More...
 

Public Member Functions

Indexer_t const & indexManager () const
 Returns the index manager of the grid. More...
 
Data structure
size_t sizeZ () const
 Returns the size of the container in the third dimension (z) More...
 
bool hasZ (typename Base_t::CellDimIndex_t index) const
 Returns whether the specified x index is valid. More...
 
Data structure
size_t sizeY () const
 Returns the size of the container in the second dimension (y) More...
 
bool hasY (typename Base_t::CellDimIndex_t index) const
 Returns whether the specified x index is valid. More...
 
Data structure
bool hasX (typename Base_t::CellDimIndex_t index) const
 Returns whether the specified x index is valid. More...
 
size_t sizeX () const
 Returns the size of the container in the first dimension (x) More...
 
Data structure
size_t size () const
 Returns the total size of the container. More...
 
bool has (CellIndexOffset_t index) const
 Returns whether the specified index is valid. More...
 
Data access
CellIndex_t index (CellID_t const &id) const
 Return the index of the element from its cell coordinates (no check!) More...
 
CellIndexOffset_t indexOffset (CellID_t const &origin, CellID_t const &cellID) const
 Returns the difference in index from two cells. More...
 
Cell_t & operator[] (CellID_t const &id)
 Returns a reference to the specified cell. More...
 
Cell_t const & operator[] (CellID_t const &id) const
 Returns a constant reference to the specified cell. More...
 
Cell_t & operator[] (CellIndex_t index)
 Returns a reference to to the cell with specified index. More...
 
Cell_t const & operator[] (CellIndex_t index) const
 Returns a constant reference to the cell with specified index. More...
 
Data insertion
void insert (CellID_t const &cellID, Datum_t const &elem)
 Copies an element into the specified cell. More...
 
void insert (CellID_t const &cellID, Datum_t &&elem)
 Moves an element into the specified cell. More...
 
void insert (CellIndex_t index, Datum_t const &elem)
 Copies an element into the cell with the specified index. More...
 
void insert (CellIndex_t index, Datum_t &&elem)
 Moves an element into the cell with the specified index. More...
 

Static Public Member Functions

static constexpr unsigned int dims ()
 

Protected Member Functions

Cell_t & cell (CellID_t const &cellID)
 Returns a reference to the specified cell. More...
 
Cell_t const & cell (CellID_t const &cellID) const
 Returns a constant reference to the specified cell. More...
 

Protected Attributes

Indexer_t indices
 manager of the indices of the container More...
 
Cells_t data
 organised collection of points More...
 

Private Types

using Base_t = GridContainerBase2D< DATUM, IXMAN >
 

Detailed Description

template<typename DATUM, typename IXMAN>
class util::GridContainerBase3D< DATUM, IXMAN >

Base class for a container of data arranged on a 3D-grid.

Template Parameters
DATUMtype of datum to be contained
IXMANtype of the grid index manager

Definition at line 233 of file GridContainers.h.

Member Typedef Documentation

template<typename DATUM, typename IXMAN>
using util::GridContainerBase3D< DATUM, IXMAN >::Base_t = GridContainerBase2D<DATUM, IXMAN>
private

Definition at line 234 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::Cell_t = std::vector<Datum_t>
inherited

type of a single cell container

Definition at line 66 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::CellDimIndex_t = typename Indexer_t::CellDimIndex_t
inherited

type of difference between indices

Definition at line 60 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::CellID_t = typename Indexer_t::CellID_t
inherited

type of cell coordinate (x, y, z)

Definition at line 63 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::CellIndex_t = typename Indexer_t::CellIndex_t
inherited

type of index for direct access to the cell

Definition at line 54 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::CellIndexOffset_t = typename Indexer_t::CellIndexOffset_t
inherited

type of difference between indices

Definition at line 57 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::Cells_t = std::vector<Cell_t>
inherited

type of container holding all cells

Definition at line 69 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::const_iterator = typename Cells_t::const_iterator
inherited

type of iterator to all cells

Definition at line 72 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::Datum_t = DATUM
inherited

type of contained datum

Definition at line 45 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::Grid_t = GridContainerBase<Datum_t, Indexer_t>
inherited

this type

Definition at line 48 of file GridContainers.h.

template<typename DATUM, typename IXMAN>
using util::details::GridContainerBase< DATUM, IXMAN >::Indexer_t = IXMAN
inherited

Definition at line 46 of file GridContainers.h.

Member Function Documentation

template<typename DATUM, typename IXMAN>
Cell_t& util::details::GridContainerBase< DATUM, IXMAN >::cell ( CellID_t const &  cellID)
inlineprotectedinherited

Returns a reference to the specified cell.

Definition at line 147 of file GridContainers.h.

Referenced by util::details::GridContainerBase< PointIter, IXMAN >::insert(), and util::details::GridContainerBase< PointIter, IXMAN >::operator[]().

148  { return data[index(cellID)]; }
util::details::GridContainerBase::data
Cells_t data
organised collection of points
Definition: GridContainers.h:144
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
Cell_t const& util::details::GridContainerBase< DATUM, IXMAN >::cell ( CellID_t const &  cellID) const
inlineprotectedinherited

Returns a constant reference to the specified cell.

Definition at line 151 of file GridContainers.h.

152  { return data[index(cellID)]; }
util::details::GridContainerBase::data
Cells_t data
organised collection of points
Definition: GridContainers.h:144
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
static constexpr unsigned int util::details::GridContainerBase< DATUM, IXMAN >::dims ( )
inlinestaticinherited

Definition at line 51 of file GridContainers.h.

51 { return IXMAN::dims(); }
template<typename DATUM, typename IXMAN>
bool util::details::GridContainerBase< DATUM, IXMAN >::has ( CellIndexOffset_t  index) const
inlineinherited

Returns whether the specified index is valid.

Definition at line 87 of file GridContainers.h.

87 { return indices.has(index); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
bool util::GridContainerBase1D< DATUM, IXMAN >::hasX ( typename Base_t::CellDimIndex_t  index) const
inlineinherited

Returns whether the specified x index is valid.

Definition at line 180 of file GridContainers.h.

181  { return Base_t::indices.hasX(index); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
bool util::GridContainerBase2D< DATUM, IXMAN >::hasY ( typename Base_t::CellDimIndex_t  index) const
inlineinherited

Returns whether the specified x index is valid.

Definition at line 216 of file GridContainers.h.

217  { return Base_t::indices.hasY(index); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
bool util::GridContainerBase3D< DATUM, IXMAN >::hasZ ( typename Base_t::CellDimIndex_t  index) const
inline

Returns whether the specified x index is valid.

Definition at line 249 of file GridContainers.h.

250  { return Base_t::indices.hasZ(index); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
CellIndex_t util::details::GridContainerBase< DATUM, IXMAN >::index ( CellID_t const &  id) const
inlineinherited

Return the index of the element from its cell coordinates (no check!)

Definition at line 95 of file GridContainers.h.

Referenced by util::details::GridContainerBase< PointIter, IXMAN >::cell(), util::details::GridContainerBase< PointIter, IXMAN >::insert(), and util::details::GridContainerBase< PointIter, IXMAN >::operator[]().

95 { return indices[id]; }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
template<typename DATUM, typename IXMAN>
Indexer_t const& util::details::GridContainerBase< DATUM, IXMAN >::indexManager ( ) const
inlineinherited

Returns the index manager of the grid.

Definition at line 138 of file GridContainers.h.

138 { return indices; }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
template<typename DATUM, typename IXMAN>
CellIndexOffset_t util::details::GridContainerBase< DATUM, IXMAN >::indexOffset ( CellID_t const &  origin,
CellID_t const &  cellID 
) const
inlineinherited

Returns the difference in index from two cells.

Definition at line 99 of file GridContainers.h.

Referenced by util::details::GridContainerBase< PointIter, IXMAN >::index().

100  { return indices.offset(origin, cellID); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
geo::origin
constexpr Point origin()
Returns a origin position with a point of the specified type.
Definition: geo_vectors.h:230
template<typename DATUM, typename IXMAN>
void util::details::GridContainerBase< DATUM, IXMAN >::insert ( CellID_t const &  cellID,
Datum_t const &  elem 
)
inlineinherited

Copies an element into the specified cell.

Definition at line 120 of file GridContainers.h.

121  { cell(cellID).push_back(elem); }
util::details::GridContainerBase::cell
Cell_t & cell(CellID_t const &cellID)
Returns a reference to the specified cell.
Definition: GridContainers.h:147
template<typename DATUM, typename IXMAN>
void util::details::GridContainerBase< DATUM, IXMAN >::insert ( CellID_t const &  cellID,
Datum_t &&  elem 
)
inlineinherited

Moves an element into the specified cell.

Definition at line 124 of file GridContainers.h.

125  { cell(cellID).push_back(std::move(elem)); }
util::details::GridContainerBase::cell
Cell_t & cell(CellID_t const &cellID)
Returns a reference to the specified cell.
Definition: GridContainers.h:147
template<typename DATUM, typename IXMAN>
void util::details::GridContainerBase< DATUM, IXMAN >::insert ( CellIndex_t  index,
Datum_t const &  elem 
)
inlineinherited

Copies an element into the cell with the specified index.

Definition at line 128 of file GridContainers.h.

129  { data[index].push_back(elem); }
util::details::GridContainerBase::data
Cells_t data
organised collection of points
Definition: GridContainers.h:144
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
void util::details::GridContainerBase< DATUM, IXMAN >::insert ( CellIndex_t  index,
Datum_t &&  elem 
)
inlineinherited

Moves an element into the cell with the specified index.

Definition at line 132 of file GridContainers.h.

133  { data[index].push_back(std::move(elem)); }
util::details::GridContainerBase::data
Cells_t data
organised collection of points
Definition: GridContainers.h:144
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
Cell_t& util::details::GridContainerBase< DATUM, IXMAN >::operator[] ( CellID_t const &  id)
inlineinherited

Returns a reference to the specified cell.

Definition at line 103 of file GridContainers.h.

103 { return cell(id); }
util::details::GridContainerBase::cell
Cell_t & cell(CellID_t const &cellID)
Returns a reference to the specified cell.
Definition: GridContainers.h:147
template<typename DATUM, typename IXMAN>
Cell_t const& util::details::GridContainerBase< DATUM, IXMAN >::operator[] ( CellID_t const &  id) const
inlineinherited

Returns a constant reference to the specified cell.

Definition at line 106 of file GridContainers.h.

106 { return cell(id); }
util::details::GridContainerBase::cell
Cell_t & cell(CellID_t const &cellID)
Returns a reference to the specified cell.
Definition: GridContainers.h:147
template<typename DATUM, typename IXMAN>
Cell_t& util::details::GridContainerBase< DATUM, IXMAN >::operator[] ( CellIndex_t  index)
inlineinherited

Returns a reference to to the cell with specified index.

Definition at line 109 of file GridContainers.h.

109 { return data[index]; }
util::details::GridContainerBase::data
Cells_t data
organised collection of points
Definition: GridContainers.h:144
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
Cell_t const& util::details::GridContainerBase< DATUM, IXMAN >::operator[] ( CellIndex_t  index) const
inlineinherited

Returns a constant reference to the cell with specified index.

Definition at line 112 of file GridContainers.h.

112 { return data[index]; }
util::details::GridContainerBase::data
Cells_t data
organised collection of points
Definition: GridContainers.h:144
util::details::GridContainerBase::index
CellIndex_t index(CellID_t const &id) const
Return the index of the element from its cell coordinates (no check!)
Definition: GridContainers.h:95
template<typename DATUM, typename IXMAN>
size_t util::details::GridContainerBase< DATUM, IXMAN >::size ( ) const
inlineinherited

Returns the total size of the container.

Definition at line 84 of file GridContainers.h.

84 { return indices.size(); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
template<typename DATUM, typename IXMAN>
size_t util::GridContainerBase1D< DATUM, IXMAN >::sizeX ( ) const
inlineinherited

Returns the size of the container in the first dimension (x)

Definition at line 184 of file GridContainers.h.

184 { return Base_t::indices.sizeX(); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
template<typename DATUM, typename IXMAN>
size_t util::GridContainerBase2D< DATUM, IXMAN >::sizeY ( ) const
inlineinherited

Returns the size of the container in the second dimension (y)

Definition at line 213 of file GridContainers.h.

213 { return Base_t::indices.sizeY(); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142
template<typename DATUM, typename IXMAN>
size_t util::GridContainerBase3D< DATUM, IXMAN >::sizeZ ( ) const
inline

Returns the size of the container in the third dimension (z)

Definition at line 246 of file GridContainers.h.

246 { return Base_t::indices.sizeZ(); }
util::details::GridContainerBase::indices
Indexer_t indices
manager of the indices of the container
Definition: GridContainers.h:142

Member Data Documentation

template<typename DATUM, typename IXMAN>
Cells_t util::details::GridContainerBase< DATUM, IXMAN >::data
protectedinherited

organised collection of points

Definition at line 144 of file GridContainers.h.

Referenced by util::details::GridContainerBase< PointIter, IXMAN >::insert(), and util::details::GridContainerBase< PointIter, IXMAN >::operator[]().

template<typename DATUM, typename IXMAN>
Indexer_t util::details::GridContainerBase< DATUM, IXMAN >::indices
protectedinherited

manager of the indices of the container

Definition at line 142 of file GridContainers.h.

Referenced by util::details::GridContainerBase< PointIter, IXMAN >::has(), util::details::GridContainerBase< PointIter, IXMAN >::index(), util::details::GridContainerBase< PointIter, IXMAN >::indexManager(), util::details::GridContainerBase< PointIter, IXMAN >::indexOffset(), and util::details::GridContainerBase< PointIter, IXMAN >::size().

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