An interface of a immutable cell list. More...
#include <celllist.h>
Inheritance diagram for Faunus::CellList::AbstractImmutableCellList< TContainerType, TGridType >:
Public Types | |
| 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 | |
Public Member Functions | |
| virtual const Members & | getMembers (const CellCoord &)=0 |
| Gets cell members at given cell coordinates. | |
| virtual const Members & | getNeighborMembers (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< CellCoord > | getCells () const =0 |
| Gets indicies of non-empty cells. More... | |
Detailed Description
template<class TContainerType, class TGridType>
struct Faunus::CellList::AbstractImmutableCellList< TContainerType, TGridType >
An interface of a immutable cell list.
No methods for manipulating (adding, removing) members are provided.
- Template Parameters
-
TContainerType a container type to obtain Member and Members subtypes TGridType a grid type to obtain index and coordinates subtypes
Member Function Documentation
◆ getCells()
template<class TContainerType, class TGridType>
|
pure virtual |
Gets indicies of non-empty cells.
See AbstractContainer interface.
- Todo:
- refactor as an iterator
Implemented in Faunus::CellList::CellListDifference< TCellListMinuend, TCellListSubtrahend >, and Faunus::CellList::CellListBase< TContainer, TGrid >.
The documentation for this struct was generated from the following file:
- src/celllist.h
