MEPP2 Project
Public Types | Public Member Functions | Friends | List of all members
FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM > Class Template Reference

#include <AIFProperties.h>

Inheritance diagram for FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >:
Inheritance graph
Collaboration diagram for FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >:
Collaboration graph

Public Types

typedef CoordinateT CoordinateType
 
typedef std::array< CoordinateType, DIM > SuperClass
 

Public Member Functions

 AIFPoint (void)
 
 AIFPoint (CoordinateType x, CoordinateType y, CoordinateType z)
 
const AIFPoint< CoordinateType, DIM > operator+ (const AIFPoint< CoordinateType, DIM > &other) const
 
AIFVector< CoordinateType, DIM > operator- (const AIFPoint< CoordinateType, DIM > &other) const
 
AIFPoint< CoordinateType, DIM > operator+ (const AIFVector< CoordinateType, DIM > &v) const
 
bool operator< (const AIFPoint< CoordinateType, DIM > &p) const
 
bool operator== (const AIFPoint< CoordinateType, DIM > &p) const
 

Friends

std::ostream & operator<< (std::ostream &stream, const AIFPoint< CoordinateType, DIM > &p)
 

Detailed Description

template<typename CoordinateT = double, unsigned short DIM = 3>
class FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >

Definition at line 30 of file AIFProperties.h.

Member Typedef Documentation

◆ CoordinateType

template<typename CoordinateT = double, unsigned short DIM = 3>
typedef CoordinateT FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::CoordinateType

Definition at line 33 of file AIFProperties.h.

◆ SuperClass

template<typename CoordinateT = double, unsigned short DIM = 3>
typedef std::array< CoordinateType, DIM > FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::SuperClass

Definition at line 34 of file AIFProperties.h.

Constructor & Destructor Documentation

◆ AIFPoint() [1/2]

template<typename CoordinateT = double, unsigned short DIM = 3>
FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::AIFPoint ( void  )
inline

AIFPoint default constructor.

Definition at line 40 of file AIFProperties.h.

◆ AIFPoint() [2/2]

template<typename CoordinateT = double, unsigned short DIM = 3>
FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::AIFPoint ( CoordinateType  x,
CoordinateType  y,
CoordinateType  z 
)
inline

AIFPoint constructor with 3 coordinates.

Definition at line 53 of file AIFProperties.h.

Member Function Documentation

◆ operator+() [1/2]

template<typename CoordinateT = double, unsigned short DIM = 3>
const AIFPoint< CoordinateType, DIM > FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::operator+ ( const AIFPoint< CoordinateType, DIM > &  other) const
inline
  + operator
Parameters
otherThe second AIFPoint to add to the current one.
Returns
The resulting AIFPoint object.

Definition at line 69 of file AIFProperties.h.

◆ operator+() [2/2]

template<typename CoordinateT = double, unsigned short DIM = 3>
AIFPoint< CoordinateType, DIM > FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::operator+ ( const AIFVector< CoordinateType, DIM > &  v) const
inline
  + operator
Parameters
vThe AIFVector to add to the current AIFPoint.
Returns
The resulting AIFPoint object.

Definition at line 113 of file AIFProperties.h.

◆ operator-()

template<typename CoordinateT = double, unsigned short DIM = 3>
AIFVector< CoordinateType, DIM > FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::operator- ( const AIFPoint< CoordinateType, DIM > &  other) const
inline
  - operator
Parameters
otherThe second AIFPoint to substract to the current one.
Returns
The resulting AIFVector object.

Definition at line 102 of file AIFProperties.h.

◆ operator<()

template<typename CoordinateT = double, unsigned short DIM = 3>
bool FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::operator< ( const AIFPoint< CoordinateType, DIM > &  p) const
inline
  < operator
Parameters
otherThe second AIFPoint to compare to the current AIFPoint.
Returns
The lexicographical compare.

Definition at line 124 of file AIFProperties.h.

◆ operator==()

template<typename CoordinateT = double, unsigned short DIM = 3>
bool FEVV::DataStructures::AIF::AIFPoint< CoordinateT, DIM >::operator== ( const AIFPoint< CoordinateType, DIM > &  p) const
inline
  == operator
Parameters
otherThe second AIFPoint to compare to the current AIFPoint.
Returns
The equality compare.

Definition at line 147 of file AIFProperties.h.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

template<typename CoordinateT = double, unsigned short DIM = 3>
std::ostream& operator<< ( std::ostream &  stream,
const AIFPoint< CoordinateType, DIM > &  p 
)
friend
  << operator
Parameters
streamThe output stream to update.
pThe AIFPoint to add to the output stream.
Returns
The resulting output stream object.

Definition at line 81 of file AIFProperties.h.


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