#include <ReciprocalLatticeVectorBindings.h>

Public Member Functions
	PyReciprocalLatticeVector (const Lattice &lattice)

	PyReciprocalLatticeVector (const VectorDimD &cartesianCoordinates, const Lattice &lattice)

	PyReciprocalLatticeVector (const VectorDimI &integerCoordinates, const Lattice &lattice)

	PyReciprocalLatticeVector (const PyReciprocalLatticeVector &)=default

	PyReciprocalLatticeVector (const ReciprocalLatticeVector &rlv)

PyReciprocalLatticeVector	operator+ (const PyReciprocalLatticeVector &other) const

PyReciprocalLatticeVector	operator- (const PyReciprocalLatticeVector &other) const

PyReciprocalLatticeVector	operator+= (const PyReciprocalLatticeVector &other)

PyReciprocalLatticeVector	operator-= (const PyReciprocalLatticeVector &other)

PyReciprocalLatticeVector	operator* (const IntScalarType &scalar) const

VectorDimD	cartesian () const

VectorDimI	integerCoordinates () const

IntScalarType	dot (const PyLatticeVector< dim > &other) const

IntScalarType	planeIndexOfPoint (const VectorDimD &p)

IntScalarType	planeIndexOfPoint (const gbLAB::LatticeVector< dim > &p) const

IntScalarType	closestPlaneIndexOfPoint (const VectorDimD &p) const

template<int dm = dim>
std::enable_if< dm==2, PyLatticeDirection< dm > >::type	cross (const PyReciprocalLatticeVector< dm > &other)

template<int dm = dim>
std::enable_if< dm==3, PyLatticeDirection< dm > >::type	cross (const PyReciprocalLatticeVector< dm > &other)

Data Fields
ReciprocalLatticeVector	rlv

Private Types
using	Lattice = gbLAB::Lattice< dim >

using	ReciprocalLatticeVector = gbLAB::ReciprocalLatticeVector< dim >

using	IntScalarType = long long int

using	MatrixDimD = Eigen::Matrix< double, dim, dim >

using	VectorDimD = Eigen::Matrix< double, dim, 1 >

using	VectorDimI = Eigen::Matrix< IntScalarType, dim, 1 >

using	MatrixDimI = Eigen::Matrix< IntScalarType, dim, dim >

Detailed Description

template<int dim>
class pyoilab::PyReciprocalLatticeVector< dim >

Definition at line 22 of file ReciprocalLatticeVectorBindings.h.

Member Typedef Documentation

◆ IntScalarType

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::IntScalarType = long long int

private

Definition at line 26 of file ReciprocalLatticeVectorBindings.h.

◆ Lattice

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::Lattice = gbLAB::Lattice<dim>

private

Definition at line 23 of file ReciprocalLatticeVectorBindings.h.

◆ MatrixDimD

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::MatrixDimD = Eigen::Matrix<double, dim, dim>

private

Definition at line 27 of file ReciprocalLatticeVectorBindings.h.

◆ MatrixDimI

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::MatrixDimI = Eigen::Matrix<IntScalarType, dim, dim>

private

Definition at line 30 of file ReciprocalLatticeVectorBindings.h.

◆ ReciprocalLatticeVector

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::ReciprocalLatticeVector = gbLAB::ReciprocalLatticeVector<dim>

private

Definition at line 24 of file ReciprocalLatticeVectorBindings.h.

◆ VectorDimD

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::VectorDimD = Eigen::Matrix<double, dim, 1>

private

Definition at line 28 of file ReciprocalLatticeVectorBindings.h.

◆ VectorDimI

template<int dim>

using pyoilab::PyReciprocalLatticeVector< dim >::VectorDimI = Eigen::Matrix<IntScalarType, dim, 1>

private

Definition at line 29 of file ReciprocalLatticeVectorBindings.h.

Constructor & Destructor Documentation

◆ PyReciprocalLatticeVector() [1/5]

template<int dim>

pyoilab::PyReciprocalLatticeVector< dim >::PyReciprocalLatticeVector ( const Lattice & lattice )

inline

Definition at line 34 of file ReciprocalLatticeVectorBindings.h.

◆ PyReciprocalLatticeVector() [2/5]

template<int dim>

pyoilab::PyReciprocalLatticeVector< dim >::PyReciprocalLatticeVector	(	const VectorDimD &	cartesianCoordinates,
		const Lattice &	lattice
	)

inline

Definition at line 36 of file ReciprocalLatticeVectorBindings.h.

◆ PyReciprocalLatticeVector() [3/5]

template<int dim>

pyoilab::PyReciprocalLatticeVector< dim >::PyReciprocalLatticeVector	(	const VectorDimI &	integerCoordinates,
		const Lattice &	lattice
	)

inline

Definition at line 40 of file ReciprocalLatticeVectorBindings.h.

◆ PyReciprocalLatticeVector() [4/5]

template<int dim>

pyoilab::PyReciprocalLatticeVector< dim >::PyReciprocalLatticeVector ( const PyReciprocalLatticeVector< dim > & )

default

◆ PyReciprocalLatticeVector() [5/5]

template<int dim>

pyoilab::PyReciprocalLatticeVector< dim >::PyReciprocalLatticeVector ( const ReciprocalLatticeVector & rlv )

inline

Definition at line 46 of file ReciprocalLatticeVectorBindings.h.

Member Function Documentation

◆ cartesian()

template<int dim>

VectorDimD pyoilab::PyReciprocalLatticeVector< dim >::cartesian ( ) const

inline

Definition at line 70 of file ReciprocalLatticeVectorBindings.h.

◆ closestPlaneIndexOfPoint()

template<int dim>

IntScalarType pyoilab::PyReciprocalLatticeVector< dim >::closestPlaneIndexOfPoint ( const VectorDimD & p ) const

inline

Definition at line 90 of file ReciprocalLatticeVectorBindings.h.

◆ cross() [1/2]

template<int dim>

template<int dm = dim>

std::enable_if< dm==2, PyLatticeDirection< dm > >::type pyoilab::PyReciprocalLatticeVector< dim >::cross ( const PyReciprocalLatticeVector< dm > & other )

inline

Definition at line 96 of file ReciprocalLatticeVectorBindings.h.

◆ cross() [2/2]

template<int dim>

template<int dm = dim>

std::enable_if< dm==3, PyLatticeDirection< dm > >::type pyoilab::PyReciprocalLatticeVector< dim >::cross ( const PyReciprocalLatticeVector< dm > & other )

inline

Definition at line 101 of file ReciprocalLatticeVectorBindings.h.

◆ dot()

template<int dim>

IntScalarType pyoilab::PyReciprocalLatticeVector< dim >::dot ( const PyLatticeVector< dim > & other ) const

inline

Definition at line 78 of file ReciprocalLatticeVectorBindings.h.

◆ integerCoordinates()

template<int dim>

VectorDimI pyoilab::PyReciprocalLatticeVector< dim >::integerCoordinates ( ) const

inline

Definition at line 74 of file ReciprocalLatticeVectorBindings.h.

◆ operator*()

template<int dim>

PyReciprocalLatticeVector pyoilab::PyReciprocalLatticeVector< dim >::operator* ( const IntScalarType & scalar ) const

inline

Definition at line 66 of file ReciprocalLatticeVectorBindings.h.

◆ operator+()

template<int dim>

PyReciprocalLatticeVector pyoilab::PyReciprocalLatticeVector< dim >::operator+ ( const PyReciprocalLatticeVector< dim > & other ) const

inline

Definition at line 48 of file ReciprocalLatticeVectorBindings.h.

◆ operator+=()

template<int dim>

PyReciprocalLatticeVector pyoilab::PyReciprocalLatticeVector< dim >::operator+= ( const PyReciprocalLatticeVector< dim > & other )

inline

Definition at line 56 of file ReciprocalLatticeVectorBindings.h.

◆ operator-()

template<int dim>

PyReciprocalLatticeVector pyoilab::PyReciprocalLatticeVector< dim >::operator- ( const PyReciprocalLatticeVector< dim > & other ) const

inline

Definition at line 52 of file ReciprocalLatticeVectorBindings.h.

◆ operator-=()

template<int dim>

PyReciprocalLatticeVector pyoilab::PyReciprocalLatticeVector< dim >::operator-= ( const PyReciprocalLatticeVector< dim > & other )

inline

Definition at line 61 of file ReciprocalLatticeVectorBindings.h.

◆ planeIndexOfPoint() [1/2]

template<int dim>

IntScalarType pyoilab::PyReciprocalLatticeVector< dim >::planeIndexOfPoint ( const gbLAB::LatticeVector< dim > & p ) const

inline

Definition at line 86 of file ReciprocalLatticeVectorBindings.h.

◆ planeIndexOfPoint() [2/2]

template<int dim>

IntScalarType pyoilab::PyReciprocalLatticeVector< dim >::planeIndexOfPoint ( const VectorDimD & p )

inline

Definition at line 82 of file ReciprocalLatticeVectorBindings.h.

Field Documentation

◆ rlv

template<int dim>

ReciprocalLatticeVector pyoilab::PyReciprocalLatticeVector< dim >::rlv

Definition at line 32 of file ReciprocalLatticeVectorBindings.h.

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

include/Bindings/PyLatticeModule.h
include/Bindings/ReciprocalLatticeVectorBindings.h

Public Member Functions

Data Fields

Private Types

Detailed Description

Member Typedef Documentation

◆ IntScalarType

◆ Lattice

◆ MatrixDimD

◆ MatrixDimI

◆ ReciprocalLatticeVector

◆ VectorDimD

◆ VectorDimI

Constructor & Destructor Documentation

◆ PyReciprocalLatticeVector() [1/5]

◆ PyReciprocalLatticeVector() [2/5]

◆ PyReciprocalLatticeVector() [3/5]

◆ PyReciprocalLatticeVector() [4/5]

◆ PyReciprocalLatticeVector() [5/5]

Member Function Documentation

◆ cartesian()

◆ closestPlaneIndexOfPoint()

◆ cross() [1/2]

◆ cross() [2/2]

◆ dot()

◆ integerCoordinates()

◆ operator*()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ planeIndexOfPoint() [1/2]

◆ planeIndexOfPoint() [2/2]

Field Documentation

◆ rlv