shammath::LatticeHCP< Tvec >::Iterator Class Reference

Iterator utility to generate the lattice. More...

#include <shammath/include/shammath/crystalLattice.hpp>

Public Member Functions
	Iterator (Tscal dr, std::array< i32, dim > coord_min, std::array< i32, dim > coord_max)
bool	is_done ()
Tvec	next ()
std::vector< Tvec >	next_n (u64 nmax)
void	skip (u64 n)

Detailed Description

template<class Tvec>
class shammath::LatticeHCP< Tvec >::Iterator

Iterator utility to generate the lattice.

Definition at line 205 of file crystalLattice.hpp.

Constructor & Destructor Documentation

Iterator()

template<class Tvec >

shammath::LatticeHCP< Tvec >::Iterator::Iterator ( Tscal  dr, std::array< i32, dim >  coord_min, std::array< i32, dim >  coord_max  )

inline

Definition at line 216 of file crystalLattice.hpp.

Member Function Documentation

is_done()

template<class Tvec >

bool shammath::LatticeHCP< Tvec >::Iterator::is_done ( )

inline

Definition at line 234 of file crystalLattice.hpp.

next()

template<class Tvec >

Tvec shammath::LatticeHCP< Tvec >::Iterator::next ( )

inline

Definition at line 236 of file crystalLattice.hpp.

next_n()

template<class Tvec >

std::vector< Tvec > shammath::LatticeHCP< Tvec >::Iterator::next_n ( u64  nmax )

inline

Definition at line 264 of file crystalLattice.hpp.

skip()

template<class Tvec >

void shammath::LatticeHCP< Tvec >::Iterator::skip ( u64  n )

inline

Definition at line 277 of file crystalLattice.hpp.

---

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

• shammath/include/shammath/crystalLattice.hpp