q3::IntegerVector3D Struct Reference

Integer 3-vector for Miller indices / FFT grid indices. More...

#include <integer_vector_3d.hpp>

Public Member Functions
	IntegerVector3D ()=default
constexpr	IntegerVector3D (int x_component, int y_component, int z_component)
bool	operator== (const IntegerVector3D &other) const
int &	operator[] (int component_index)
int	operator[] (int component_index) const

Public Attributes
int	x {}
int	y {}
int	z {}

Detailed Description

Integer 3-vector for Miller indices / FFT grid indices.

Definition at line 14 of file integer_vector_3d.hpp.

Constructor & Destructor Documentation

IntegerVector3D() [1/2]

q3::IntegerVector3D::IntegerVector3D ( )

default

IntegerVector3D() [2/2]

constexpr q3::IntegerVector3D::IntegerVector3D ( int  x_component, int  y_component, int  z_component  )

inlineconstexpr

Definition at line 17 of file integer_vector_3d.hpp.

Member Function Documentation

operator==()

bool q3::IntegerVector3D::operator== ( const IntegerVector3D &  other ) const

inline

Definition at line 25 of file integer_vector_3d.hpp.

References x, y, and z.

operator[]() [1/2]

int & q3::IntegerVector3D::operator[] ( int  component_index )

inline

Definition at line 22 of file integer_vector_3d.hpp.

operator[]() [2/2]

int q3::IntegerVector3D::operator[] ( int  component_index ) const

inline

Definition at line 19 of file integer_vector_3d.hpp.

Member Data Documentation

x

int q3::IntegerVector3D::x {}

Definition at line 15 of file integer_vector_3d.hpp.

Referenced by q3::MillerIndexLookup::build(), q3::complex_field_from_reciprocal_space(), q3::PlanewaveBlochOverlapCalculator::compute(), q3::MillerIndexLookup::find(), q3::GVectorsGrid::generate(), q3::KPointNeighborShells::neighbor_kpoint_index(), operator==(), q3::lattice_fourier_transform::internal::phase(), q3::internal::wannier_payload::read(), q3::Wannier90FormatReader::read_overlaps(), q3::MaximallyLocalizedGaugeChoice::require_supported(), q3::KPointStencil::two_point_axis_direction(), q3::Wannier90FormatWriter::write_neighbor_list(), and q3::Wannier90FormatWriter::write_overlaps().

y

int q3::IntegerVector3D::y {}

Definition at line 15 of file integer_vector_3d.hpp.

Referenced by q3::MillerIndexLookup::build(), q3::complex_field_from_reciprocal_space(), q3::PlanewaveBlochOverlapCalculator::compute(), q3::MillerIndexLookup::find(), q3::KPointNeighborShells::neighbor_kpoint_index(), operator==(), q3::lattice_fourier_transform::internal::phase(), q3::internal::wannier_payload::read(), q3::Wannier90FormatReader::read_overlaps(), q3::MaximallyLocalizedGaugeChoice::require_supported(), q3::KPointStencil::two_point_axis_direction(), q3::Wannier90FormatWriter::write_neighbor_list(), and q3::Wannier90FormatWriter::write_overlaps().

z

int q3::IntegerVector3D::z {}

Definition at line 15 of file integer_vector_3d.hpp.

Referenced by q3::MillerIndexLookup::build(), q3::complex_field_from_reciprocal_space(), q3::PlanewaveBlochOverlapCalculator::compute(), q3::MillerIndexLookup::find(), q3::KPointNeighborShells::neighbor_kpoint_index(), operator==(), q3::lattice_fourier_transform::internal::phase(), q3::internal::wannier_payload::read(), q3::Wannier90FormatReader::read_overlaps(), q3::MaximallyLocalizedGaugeChoice::require_supported(), q3::KPointStencil::two_point_axis_direction(), q3::Wannier90FormatWriter::write_neighbor_list(), and q3::Wannier90FormatWriter::write_overlaps().

---

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

• src/layer_0_core/types/integer_vector_3d.hpp