#include <ReciprocalLatticeVector.h>

Inheritance diagram for model::ReciprocalLatticeVector< dim >:

Collaboration diagram for model::ReciprocalLatticeVector< dim >:

Public Types
typedef Eigen::Matrix< long int, dim, 1 >	BaseType
typedef Lattice< dim >	LatticeType
typedef Eigen::Matrix< double, dim, 1 >	VectorDimD
typedef Eigen::Matrix< long int, dim, 1 >	VectorDimI
typedef Eigen::Matrix< double, dim, dim >	MatrixDimD
typedef ReciprocalLatticeVector< dim >	ReciprocalLatticeVectorType
typedef LatticeVector< dim >	LatticeVectorType
typedef LatticeDirection< dim >	LatticeDirectionType
typedef LatticeCore< dim >::VectorDimD	VectorDimD
typedef LatticeCore< dim >::MatrixDimD	MatrixDimD
typedef LatticeCore< dim >::VectorDimI	VectorDimI
typedef LatticeCore< dim >::MatrixDimI	MatrixDimI
Public Types inherited from model::ReciprocalLatticeVectorBase< dim >
typedef LatticeCore< dim >::IntScalarType	IntScalarType
typedef LatticeCore< dim >::VectorDimD	VectorDimD
typedef LatticeCore< dim >::MatrixDimD	MatrixDimD
typedef LatticeCore< dim >::VectorDimI	VectorDimI
typedef LatticeCore< dim >::MatrixDimI	MatrixDimI

Public Member Functions
BaseType &	base ()
const BaseType &	base () const
	ReciprocalLatticeVector (const LatticeType &lat)
	ReciprocalLatticeVector (const VectorDimD &d, const LatticeType &lat)
	ReciprocalLatticeVector (const VectorDimI &d, const LatticeType &lat)
ReciprocalLatticeVectorType	operator+ (const ReciprocalLatticeVectorType &other) const
ReciprocalLatticeVectorType &	operator+= (const ReciprocalLatticeVectorType &other)
ReciprocalLatticeVectorType	operator- (const ReciprocalLatticeVectorType &other) const
ReciprocalLatticeVectorType &	operator-= (const ReciprocalLatticeVectorType &other)
ReciprocalLatticeVectorType	operator* (const long int &scalar) const
long int	dot (const LatticeVectorType &other) const
LatticeDirectionType	cross (const ReciprocalLatticeVectorType &other) const
VectorDimD	cartesian () const
double	planeSpacing () const
VectorDimD	interplaneVector () const
long int	closestPlaneIndexOfPoint (const VectorDimD &P) const
long int	planeIndexOfPoint (const VectorDimD &P) const
long int	planeIndexOfPoint (const LatticeVector< dim > &P) const
	ReciprocalLatticeVector (const Lattice< dim > &lat)
	ReciprocalLatticeVector (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
	ReciprocalLatticeVector (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
Public Member Functions inherited from model::ReciprocalLatticeVectorBase< dim >
	ReciprocalLatticeVectorBase (const Lattice< dim > &lat)
	ReciprocalLatticeVectorBase (const VectorDimD &d, const Lattice< dim > &lat)
template<typename OtherDerived>
	ReciprocalLatticeVectorBase (const Eigen::MatrixBase< OtherDerived > &other, const Lattice< dim > &lat)
	ReciprocalLatticeVectorBase (const ReciprocalLatticeVectorBase< dim > &other)=default
	ReciprocalLatticeVectorBase (ReciprocalLatticeVectorBase< dim > &&other)=default
ReciprocalLatticeVectorBase< dim > &	operator= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim > &	operator= (ReciprocalLatticeVectorBase< dim > &&other)
ReciprocalLatticeVectorBase< dim >	operator+ (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > &	operator+= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim >	operator- (const ReciprocalLatticeVectorBase< dim > &other) const
ReciprocalLatticeVectorBase< dim > &	operator-= (const ReciprocalLatticeVectorBase< dim > &other)
ReciprocalLatticeVectorBase< dim >	operator* (const IntScalarType &scalar) const
IntScalarType	dot (const LatticeVector< dim > &other) const
VectorDimD	cartesian () const
double	planeSpacing () const
VectorDimD	interplaneVector () const
IntScalarType	closestPlaneIndexOfPoint (const VectorDimD &P) const
IntScalarType	planeIndexOfPoint (const VectorDimD &P) const
IntScalarType	planeIndexOfPoint (const LatticeVector< dim > &P) const

Static Public Member Functions
static VectorDimI	d2cov (const VectorDimD &d, const LatticeType &lat)

Public Attributes
const LatticeType &	lattice
Public Attributes inherited from model::ReciprocalLatticeVectorBase< dim >
const Lattice< dim > &	lattice

Static Public Attributes
static constexpr double	roundTol =FLT_EPSILON

Detailed Description

template<int dim>
class model::ReciprocalLatticeVector< dim >

Definition at line 66 of file Lattices_NEW/ReciprocalLatticeVector.h.

Member Typedef Documentation

◆ BaseType

template<int dim>

typedef Eigen::Matrix<long int,dim,1> model::ReciprocalLatticeVector< dim >::BaseType

Definition at line 29 of file Lattices/ReciprocalLatticeVector.h.

◆ LatticeDirectionType

template<int dim>

typedef LatticeDirection<dim> model::ReciprocalLatticeVector< dim >::LatticeDirectionType

Definition at line 41 of file Lattices/ReciprocalLatticeVector.h.

◆ LatticeType

template<int dim>

typedef Lattice<dim> model::ReciprocalLatticeVector< dim >::LatticeType

Definition at line 30 of file Lattices/ReciprocalLatticeVector.h.

◆ LatticeVectorType

template<int dim>

typedef LatticeVector<dim> model::ReciprocalLatticeVector< dim >::LatticeVectorType

Definition at line 40 of file Lattices/ReciprocalLatticeVector.h.

◆ MatrixDimD [1/2]

template<int dim>

typedef Eigen::Matrix<double,dim,dim> model::ReciprocalLatticeVector< dim >::MatrixDimD

Definition at line 38 of file Lattices/ReciprocalLatticeVector.h.

◆ MatrixDimD [2/2]

template<int dim>

typedef LatticeCore<dim>::MatrixDimD model::ReciprocalLatticeVector< dim >::MatrixDimD

Definition at line 72 of file Lattices_NEW/ReciprocalLatticeVector.h.

◆ MatrixDimI

template<int dim>

typedef LatticeCore<dim>::MatrixDimI model::ReciprocalLatticeVector< dim >::MatrixDimI

Definition at line 74 of file Lattices_NEW/ReciprocalLatticeVector.h.

◆ ReciprocalLatticeVectorType

template<int dim>

typedef ReciprocalLatticeVector<dim> model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVectorType

Definition at line 39 of file Lattices/ReciprocalLatticeVector.h.

◆ VectorDimD [1/2]

template<int dim>

typedef Eigen::Matrix< double,dim,1> model::ReciprocalLatticeVector< dim >::VectorDimD

Definition at line 36 of file Lattices/ReciprocalLatticeVector.h.

◆ VectorDimD [2/2]

template<int dim>

typedef LatticeCore<dim>::VectorDimD model::ReciprocalLatticeVector< dim >::VectorDimD

Definition at line 71 of file Lattices_NEW/ReciprocalLatticeVector.h.

◆ VectorDimI [1/2]

template<int dim>

typedef Eigen::Matrix<long int,dim,1> model::ReciprocalLatticeVector< dim >::VectorDimI

Definition at line 37 of file Lattices/ReciprocalLatticeVector.h.

◆ VectorDimI [2/2]

template<int dim>

typedef LatticeCore<dim>::VectorDimI model::ReciprocalLatticeVector< dim >::VectorDimI

Definition at line 73 of file Lattices_NEW/ReciprocalLatticeVector.h.

Constructor & Destructor Documentation

◆ ReciprocalLatticeVector() [1/6]

template<int dim>

model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector ( const LatticeType & lat )

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 30 of file Lattices/ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [2/6]

template<int dim>

model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector	(	const VectorDimD &	d,
		const LatticeType &	lat )

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 39 of file Lattices/ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [3/6]

template<int dim>

model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector	(	const VectorDimI &	d,
		const LatticeType &	lat )

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 49 of file Lattices/ReciprocalLatticeVector.cpp.

◆ ReciprocalLatticeVector() [4/6]

template<int dim>

model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector ( const Lattice< dim > & lat )

◆ ReciprocalLatticeVector() [5/6]

template<int dim>

model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector	(	const VectorDimD &	d,
		const Lattice< dim > &	lat )

◆ ReciprocalLatticeVector() [6/6]

template<int dim>

template<typename OtherDerived>

model::ReciprocalLatticeVector< dim >::ReciprocalLatticeVector	(	const Eigen::MatrixBase< OtherDerived > &	other,
		const Lattice< dim > &	lat )

inline

Parameters

[in] d vector in real space Constructs *this by mapping d to the lattice

Definition at line 80 of file Lattices_NEW/ReciprocalLatticeVector.h.

Member Function Documentation

◆ base() [1/2]

template<int dim>

ReciprocalLatticeVector< dim >::BaseType & model::ReciprocalLatticeVector< dim >::base ( )

Definition at line 18 of file Lattices/ReciprocalLatticeVector.cpp.

◆ base() [2/2]

template<int dim>

const ReciprocalLatticeVector< dim >::BaseType & model::ReciprocalLatticeVector< dim >::base ( ) const

Definition at line 24 of file Lattices/ReciprocalLatticeVector.cpp.

◆ cartesian()

template<int dim>

ReciprocalLatticeVector< dim >::VectorDimD model::ReciprocalLatticeVector< dim >::cartesian ( ) const

Definition at line 109 of file Lattices/ReciprocalLatticeVector.cpp.

◆ closestPlaneIndexOfPoint()

template<int dim>

long int model::ReciprocalLatticeVector< dim >::closestPlaneIndexOfPoint ( const VectorDimD & P ) const

Definition at line 128 of file Lattices/ReciprocalLatticeVector.cpp.

◆ cross()

template<int dim>

ReciprocalLatticeVector< dim >::LatticeDirectionType model::ReciprocalLatticeVector< dim >::cross ( const ReciprocalLatticeVectorType & other ) const

Definition at line 102 of file Lattices/ReciprocalLatticeVector.cpp.

◆ d2cov()

template<int dim>

ReciprocalLatticeVector< dim >::VectorDimI model::ReciprocalLatticeVector< dim >::d2cov	(	const VectorDimD &	d,
		const LatticeType &	lat )

static

Definition at line 160 of file Lattices/ReciprocalLatticeVector.cpp.

◆ dot()

template<int dim>

long int model::ReciprocalLatticeVector< dim >::dot ( const LatticeVectorType & other ) const

Definition at line 95 of file Lattices/ReciprocalLatticeVector.cpp.

◆ interplaneVector()

template<int dim>

ReciprocalLatticeVector< dim >::VectorDimD model::ReciprocalLatticeVector< dim >::interplaneVector ( ) const

Definition at line 121 of file Lattices/ReciprocalLatticeVector.cpp.

◆ operator*()

template<int dim>

ReciprocalLatticeVector< dim >::ReciprocalLatticeVectorType model::ReciprocalLatticeVector< dim >::operator* ( const long int & scalar ) const

Definition at line 89 of file Lattices/ReciprocalLatticeVector.cpp.

◆ operator+()

template<int dim>

ReciprocalLatticeVector< dim >::ReciprocalLatticeVectorType model::ReciprocalLatticeVector< dim >::operator+ ( const ReciprocalLatticeVectorType & other ) const

Definition at line 59 of file Lattices/ReciprocalLatticeVector.cpp.

◆ operator+=()

template<int dim>

ReciprocalLatticeVector< dim >::ReciprocalLatticeVectorType & model::ReciprocalLatticeVector< dim >::operator+= ( const ReciprocalLatticeVectorType & other )

Definition at line 66 of file Lattices/ReciprocalLatticeVector.cpp.

◆ operator-()

template<int dim>

ReciprocalLatticeVector< dim >::ReciprocalLatticeVectorType model::ReciprocalLatticeVector< dim >::operator- ( const ReciprocalLatticeVectorType & other ) const

Definition at line 74 of file Lattices/ReciprocalLatticeVector.cpp.

◆ operator-=()

template<int dim>

ReciprocalLatticeVector< dim >::ReciprocalLatticeVectorType & model::ReciprocalLatticeVector< dim >::operator-= ( const ReciprocalLatticeVectorType & other )

Definition at line 81 of file Lattices/ReciprocalLatticeVector.cpp.

◆ planeIndexOfPoint() [1/2]

template<int dim>

long int model::ReciprocalLatticeVector< dim >::planeIndexOfPoint ( const LatticeVector< dim > & P ) const

Definition at line 153 of file Lattices/ReciprocalLatticeVector.cpp.

◆ planeIndexOfPoint() [2/2]

template<int dim>

long int model::ReciprocalLatticeVector< dim >::planeIndexOfPoint ( const VectorDimD & P ) const

Definition at line 136 of file Lattices/ReciprocalLatticeVector.cpp.

◆ planeSpacing()

template<int dim>

double model::ReciprocalLatticeVector< dim >::planeSpacing ( ) const

Definition at line 115 of file Lattices/ReciprocalLatticeVector.cpp.

Member Data Documentation

◆ lattice

template<int dim>

const LatticeType& model::ReciprocalLatticeVector< dim >::lattice

Definition at line 43 of file Lattices/ReciprocalLatticeVector.h.

◆ roundTol

template<int dim>

double model::ReciprocalLatticeVector< dim >::roundTol =FLT_EPSILON

staticconstexpr

Definition at line 35 of file Lattices/ReciprocalLatticeVector.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ BaseType

◆ LatticeDirectionType

◆ LatticeType

◆ LatticeVectorType

◆ MatrixDimD [1/2]

◆ MatrixDimD [2/2]

◆ MatrixDimI

◆ ReciprocalLatticeVectorType

◆ VectorDimD [1/2]

◆ VectorDimD [2/2]

◆ VectorDimI [1/2]

◆ VectorDimI [2/2]

Constructor & Destructor Documentation

◆ ReciprocalLatticeVector() [1/6]

◆ ReciprocalLatticeVector() [2/6]

◆ ReciprocalLatticeVector() [3/6]

◆ ReciprocalLatticeVector() [4/6]

◆ ReciprocalLatticeVector() [5/6]

◆ ReciprocalLatticeVector() [6/6]

Member Function Documentation

◆ base() [1/2]

◆ base() [2/2]

◆ cartesian()

◆ closestPlaneIndexOfPoint()

◆ cross()

◆ d2cov()

◆ dot()

◆ interplaneVector()

◆ operator*()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ planeIndexOfPoint() [1/2]

◆ planeIndexOfPoint() [2/2]

◆ planeSpacing()

Member Data Documentation

◆ lattice

◆ roundTol