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

#include <AIFProperties.h>

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

Public Types

typedef CoordinateT CoordinateType
 

Public Member Functions

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

Friends

AIFVector< CoordinateType, DIM > operator* (double s, const AIFVector< CoordinateType, DIM > &v)
 
std::ostream & operator<< (std::ostream &stream, const AIFVector< CoordinateType, DIM > &v)
 

Detailed Description

template<typename CoordinateT, unsigned short DIM>
class FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >

Definition at line 172 of file AIFProperties.h.

Member Typedef Documentation

◆ CoordinateType

template<typename CoordinateT , unsigned short DIM>
typedef CoordinateT FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >::CoordinateType

Definition at line 175 of file AIFProperties.h.

Constructor & Destructor Documentation

◆ AIFVector() [1/2]

template<typename CoordinateT , unsigned short DIM>
FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >::AIFVector ( void  )
inline

AIFVector default constructor.

Definition at line 181 of file AIFProperties.h.

Here is the caller graph for this function:

◆ AIFVector() [2/2]

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

AIFVector constructor with 3 coordinates.

Definition at line 194 of file AIFProperties.h.

Member Function Documentation

◆ length()

template<typename CoordinateT , unsigned short DIM>
CoordinateType FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >::length ( void  ) const
inline
  The Euclidean length.
Returns
The current AIFVector object Euclidean length.

Definition at line 208 of file AIFProperties.h.

Here is the caller graph for this function:

◆ operator*() [1/2]

template<typename CoordinateT , unsigned short DIM>
double FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >::operator* ( const AIFVector< CoordinateType, DIM > &  other) const
inline
  * operator
Parameters
otherThe second AIFVector to do a dot product with the current one.
Returns
The resulting dot product (scalar) value.

Definition at line 254 of file AIFProperties.h.

◆ operator*() [2/2]

template<typename CoordinateT , unsigned short DIM>
AIFVector< CoordinateType, DIM > FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >::operator* ( double  k) const
inline
  * operator
Parameters
kThe scalar to multiply each coordinate.
Returns
The resulting AIFVector object.

Definition at line 264 of file AIFProperties.h.

◆ operator+() [1/2]

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

Definition at line 275 of file AIFProperties.h.

◆ operator+() [2/2]

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

Definition at line 222 of file AIFProperties.h.

Here is the call graph for this function:

◆ operator-()

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

Definition at line 233 of file AIFProperties.h.

Here is the call graph for this function:

◆ operator/()

template<typename CoordinateT , unsigned short DIM>
AIFVector< CoordinateType, DIM > FEVV::DataStructures::AIF::AIFVector< CoordinateT, DIM >::operator/ ( double  k) const
inline
  / operator
Parameters
kThe scalar to divide each coordinate.
Returns
The resulting AIFVector object.

Definition at line 243 of file AIFProperties.h.

◆ operator<()

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

Definition at line 286 of file AIFProperties.h.

◆ operator==()

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

Definition at line 309 of file AIFProperties.h.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator*

template<typename CoordinateT , unsigned short DIM>
AIFVector< CoordinateType, DIM > operator* ( double  s,
const AIFVector< CoordinateType, DIM > &  v 
)
friend
  * operator
Parameters
sThe scalar to multiply each coordinate.
vThe AIFVector object whose coordinates are multiplied by s.
Returns
The resulting AIFVector object.

Definition at line 334 of file AIFProperties.h.

◆ operator<<

template<typename CoordinateT , unsigned short DIM>
std::ostream& operator<< ( std::ostream &  stream,
const AIFVector< CoordinateType, DIM > &  v 
)
friend
  << operator
Parameters
streamThe output stream to update.
vThe AIFVector to add to the output stream.
Returns
The resulting output stream object.

Definition at line 345 of file AIFProperties.h.


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