faunus
Public Member Functions | List of all members
Faunus::CellList::AbstractSortableCellList< TContainerType, TGridType > Struct Template Referenceabstract

An interface to a cell list that can return cell's members in sorted order. More...

#include <celllist.h>

Inheritance diagram for Faunus::CellList::AbstractSortableCellList< TContainerType, TGridType >:
Inheritance graph
[legend]
Collaboration diagram for Faunus::CellList::AbstractSortableCellList< TContainerType, TGridType >:
Collaboration graph
[legend]

Public Member Functions

virtual const MembersgetSortedMembers (const CellCoord &)=0
 Gets sorted cell members at given cell coordinates.
 
virtual const MembersgetNeighborSortedMembers (const CellCoord &, const CellCoord &)=0
 
- Public Member Functions inherited from Faunus::CellList::AbstractImmutableCellList< TContainerType, TGridType >
virtual const MembersgetMembers (const CellCoord &)=0
 Gets cell members at given cell coordinates.
 
virtual const MembersgetNeighborMembers (const CellCoord &, const CellCoord &)=0
 Gets cell members at given cell coordinates.
 
virtual CellIndex gridSize () const =0
 Get cells count. Valid cell indices are in the range [0, gridSize).
 
virtual std::vector< CellCoordgetCells () const =0
 Gets indicies of non-empty cells. More...
 

Additional Inherited Members

- Public Types inherited from Faunus::CellList::AbstractImmutableCellList< TContainerType, TGridType >
using AbstractCellList = AbstractImmutableCellList< TContainerType, TGridType >
 
using ContainerType = TContainerType
 abstract container types
 
using GridType = TGridType
 abstract grid type
 
using Members = typename Container::MembersOf< ContainerType >
 members type
 
using Member = typename Container::MemberOf< ContainerType >
 member type
 
using CellIndex = typename Grid::IndexOf< GridType >
 grid (cell) index type
 
using CellCoord = typename Grid::CoordOf< GridType >
 grid (cell) coordinates type
 

Detailed Description

template<class TContainerType, class TGridType>
struct Faunus::CellList::AbstractSortableCellList< TContainerType, TGridType >

An interface to a cell list that can return cell's members in sorted order.

Interface is used to efficiently compute differences between cell lists.

Template Parameters
TContainerTypea container type to obtain Member and Members subtypes
TGridTypea grid type to obtain index and coordinates subtypes

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