DFT-EFE
 
Loading...
Searching...
No Matches
dftefe::utils::PointImpl< T > Class Template Reference

#include <PointImpl.h>

Public Member Functions

 PointImpl (const std::vector< T > &x)
 Constructor for an N-dimensional point where N=1,2,3. More...
 
 PointImpl (const T *x, size_type N)
 Constructor for an N-dimensional point where N=1,2,3. More...
 
 PointImpl (size_type N)
 Constructor for an N-dimensional point where N=1,2,3. More...
 
 PointImpl (size_type N, const_reference init)
 Constructor for an N-dimensional point where N=1,2,3. More...
 
 PointImpl (const PointImpl &p)
 Copy constructor for a point. More...
 
 ~PointImpl ()
 Destructor. More...
 
size_type size () const
 Returns the dimension of the point. More...
 
iterator begin ()
 Return iterator pointing to the begining of point data. More...
 
const_iterator begin () const
 Return iterator pointing to the begining of PointImpl data. More...
 
iterator end ()
 Return iterator pointing to the end of PointImpl data. More...
 
const_iterator end () const
 Return iterator pointing to the end of PointImpl data. More...
 
PointImploperator= (const PointImpl &p)
 Operator overload for assignment q=p. More...
 
reference operator[] (size_type i)
 Operator to get a reference to a component of the point. More...
 
const_reference operator[] (size_type i) const
 Operator to get a const reference to a component of the point. More...
 

Private Types

typedef T value_type
 
typedef T * pointer
 
typedef T & reference
 
typedef const T & const_reference
 
typedef int difference_type
 
typedef T * iterator
 
typedef const T * const_iterator
 

Private Attributes

pointer d_data
 
size_type d_size
 

Member Typedef Documentation

◆ const_iterator

template<typename T >
typedef const T* dftefe::utils::PointImpl< T >::const_iterator
private

◆ const_reference

template<typename T >
typedef const T& dftefe::utils::PointImpl< T >::const_reference
private

◆ difference_type

template<typename T >
typedef int dftefe::utils::PointImpl< T >::difference_type
private

◆ iterator

template<typename T >
typedef T* dftefe::utils::PointImpl< T >::iterator
private

◆ pointer

template<typename T >
typedef T* dftefe::utils::PointImpl< T >::pointer
private

◆ reference

template<typename T >
typedef T& dftefe::utils::PointImpl< T >::reference
private

◆ value_type

template<typename T >
typedef T dftefe::utils::PointImpl< T >::value_type
private

Constructor & Destructor Documentation

◆ PointImpl() [1/5]

template<typename T >
dftefe::utils::PointImpl< T >::PointImpl ( const std::vector< T > &  x)
inline

Constructor for an N-dimensional point where N=1,2,3.

Parameters
[in]xis reference to std::vector contaning the coordinates of the point
Exceptions
exceptionif N > 3

◆ PointImpl() [2/5]

template<typename T >
dftefe::utils::PointImpl< T >::PointImpl ( const T *  x,
size_type  N 
)
inline

Constructor for an N-dimensional point where N=1,2,3.

Parameters
[in]xis pointer to coordinates of the point
[in]Ndimension of the point
Exceptions
exceptionif N > 3

◆ PointImpl() [3/5]

template<typename T >
dftefe::utils::PointImpl< T >::PointImpl ( size_type  N)
inline

Constructor for an N-dimensional point where N=1,2,3.

Parameters
[in]Ndimension of the point point
Exceptions
exceptionif N > 3

◆ PointImpl() [4/5]

template<typename T >
dftefe::utils::PointImpl< T >::PointImpl ( size_type  N,
const_reference  init 
)
inline

Constructor for an N-dimensional point where N=1,2,3.

Parameters
[in]Ndimension of the point
[out]initinitial value to be assigned to all components of the point
Exceptions
exceptionif N > 3

◆ PointImpl() [5/5]

template<typename T >
dftefe::utils::PointImpl< T >::PointImpl ( const PointImpl< T > &  p)
inline

Copy constructor for a point.

Parameters
[in]pPointImpl object to copy from
Here is the call graph for this function:

◆ ~PointImpl()

template<typename T >
dftefe::utils::PointImpl< T >::~PointImpl
inline

Destructor.

Member Function Documentation

◆ begin() [1/2]

template<typename T >
PointImpl< T >::iterator dftefe::utils::PointImpl< T >::begin
inline

Return iterator pointing to the begining of point data.

Returns
Iterator pointing to the begingin of PointImpl.
Here is the caller graph for this function:

◆ begin() [2/2]

template<typename T >
PointImpl< T >::const_iterator dftefe::utils::PointImpl< T >::begin
inline

Return iterator pointing to the begining of PointImpl data.

Returns
Constant iterator pointing to the begining of PointImpl.

◆ end() [1/2]

template<typename T >
PointImpl< T >::iterator dftefe::utils::PointImpl< T >::end
inline

Return iterator pointing to the end of PointImpl data.

Returns
Iterator pointing to the end of PointImpl.
Here is the caller graph for this function:

◆ end() [2/2]

template<typename T >
PointImpl< T >::const_iterator dftefe::utils::PointImpl< T >::end
inline

Return iterator pointing to the end of PointImpl data.

Returns
Constant iterator pointing to the end of PointImpl.

◆ operator=()

template<typename T >
PointImpl< T > & dftefe::utils::PointImpl< T >::operator= ( const PointImpl< T > &  p)
inline

Operator overload for assignment q=p.

Parameters
[in]pthe rhs PointImpl from which to copy
Returns
reference to the lhs PointImpl
Here is the call graph for this function:

◆ operator[]() [1/2]

template<typename T >
PointImpl< T >::reference dftefe::utils::PointImpl< T >::operator[] ( size_type  i)
inline

Operator to get a reference to a component of the point.

Parameters
[in]iis the index to the component of the point
Returns
reference to the component of the point
Exceptions
exceptionif i >= dimension of the point

◆ operator[]() [2/2]

template<typename T >
PointImpl< T >::const_reference dftefe::utils::PointImpl< T >::operator[] ( size_type  i) const
inline

Operator to get a const reference to a component of the point.

Parameters
[in]iis the index to the component of the point
Returns
const reference to the component of the point
Exceptions
exceptionif i >= dimension of the point

◆ size()

template<typename T >
size_type dftefe::utils::PointImpl< T >::size
inline

Returns the dimension of the point.

Returns
dimension of the point
Here is the caller graph for this function:

Member Data Documentation

◆ d_data

template<typename T >
pointer dftefe::utils::PointImpl< T >::d_data
private

◆ d_size

template<typename T >
size_type dftefe::utils::PointImpl< T >::d_size
private

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