Neighbors< CellRef > Class Template Reference

#include <Cell.hpp>

Public Types
using	value_type = storage_type::value_type
using	iterator = storage_type::iterator
using	const_iterator = storage_type::const_iterator
using	cell_range = boost::iterator_range< iterator >

Public Member Functions
	Neighbors ()=default
	Neighbors (const Neighbors &rhs)
Neighbors &	operator= (const Neighbors &rhs)
	Neighbors (std::span< const CellRef > red_neighbors, std::span< const CellRef > black_neighbors)
cell_range	all ()
	All neighbors.
cell_range	red ()
	Red partition of neighbors.
cell_range	black ()
	Black partition of neighbors.

Detailed Description

template<class CellRef>
class Neighbors< CellRef >

Definition at line 32 of file Cell.hpp.

Member Typedef Documentation

cell_range

template<class CellRef >

using Neighbors< CellRef >::cell_range = boost::iterator_range<iterator>

Definition at line 39 of file Cell.hpp.

const_iterator

template<class CellRef >

using Neighbors< CellRef >::const_iterator = storage_type::const_iterator

Definition at line 38 of file Cell.hpp.

iterator

template<class CellRef >

using Neighbors< CellRef >::iterator = storage_type::iterator

Definition at line 37 of file Cell.hpp.

value_type

template<class CellRef >

using Neighbors< CellRef >::value_type = storage_type::value_type

Definition at line 36 of file Cell.hpp.

Constructor & Destructor Documentation

Neighbors() [1/3]

template<class CellRef >

Neighbors< CellRef >::Neighbors ( )

default

Neighbors() [2/3]

template<class CellRef >

Neighbors< CellRef >::Neighbors ( const Neighbors< CellRef > &  rhs )

inline

Definition at line 52 of file Cell.hpp.

Neighbors() [3/3]

template<class CellRef >

Neighbors< CellRef >::Neighbors ( std::span< const CellRef >  red_neighbors, std::span< const CellRef >  black_neighbors  )

inline

Definition at line 58 of file Cell.hpp.

Member Function Documentation

all()

template<class CellRef >

cell_range Neighbors< CellRef >::all ( )

inline

All neighbors.

Definition at line 69 of file Cell.hpp.

black()

template<class CellRef >

cell_range Neighbors< CellRef >::black ( )

inline

Black partition of neighbors.

An partition of the neighbors so that iterating over all neighbors_black of all cells visits every pair exactly once. Complement of neighbors_red.

Definition at line 85 of file Cell.hpp.

operator=()

template<class CellRef >

Neighbors & Neighbors< CellRef >::operator= ( const Neighbors< CellRef > &  rhs )

inline

Definition at line 53 of file Cell.hpp.

red()

template<class CellRef >

cell_range Neighbors< CellRef >::red ( )

inline

Red partition of neighbors.

An partition of the neighbors so that iterating over all neighbors_red of all cells visits every pair exactly once. Complement of neighbors_black.

Definition at line 77 of file Cell.hpp.

---

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

• Cell.hpp