SCOREC core
Parallel unstructured mesh tools
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
mth::Vector3< T > Class Template Reference

convenience wrapper over apf::Vector<3> More...

Inheritance diagram for mth::Vector3< T >:
mth::Vector< T, 3 > can::Array< T, N >

Public Member Functions

 Vector3 ()
 default constructor
 
 Vector3 (Vector< T, 3 > const &other)
 copy constructor
 
 Vector3 (T const &a, T const &b, T const &c)
 construct from 3 values
 
 Vector3 (T const *abc)
 construct from an array
 
void toArray (T *abc) const
 write vector to array
 
void fromArray (T const *abc)
 read vector from array
 
T & x ()
 mutable x component
 
T & y ()
 mutable y component
 
T & z ()
 mutable z component
 
T const & x () const
 immutable x component
 
T const & y () const
 immutable y component
 
T const & z () const
 immutable z component
 
- Public Member Functions inherited from mth::Vector< T, 3 >
 Vector ()
 default constructor
 
 Vector (unsigned n)
 construct with n elems More...
 
 Vector (T const *v)
 construct from an array
 
T & operator() (unsigned i)
 mutable index operator More...
 
T const & operator() (unsigned i) const
 immutable index operator
 
Vector< T, N > & operator+= (Vector< T, N > const &b)
 add a vector to this vector
 
Vector< T, N > operator+ (Vector< T, N > const &b) const
 add two vectors
 
Vector< T, N > & operator-= (Vector< T, N > const &b)
 subtract a vector from this vector
 
Vector< T, N > operator- (Vector< T, N > const &b) const
 subtract two vectors
 
Vector< T, N > operator* (T const &s) const
 multiply a vector times a scalar More...
 
operator* (Vector< T, N > const &b) const
 vector dot product More...
 
Vector< T, N > operator/ (T const &s) const
 divide a vector by a scalar More...
 
getLength () const
 get the vector magnitude
 
Vector< T, N > normalize () const
 divide the vector by its magnitude
 
void zero ()
 zero the vector
 
- Public Member Functions inherited from can::Array< T, N >
 Array ()
 default constructor - necessary
 
 Array (Array< T, N > const &other)
 copy constructor
 
 ~Array ()
 elems is destroyed automatically
 
Array< T, N > & operator= (Array< T, N > const &other)
 assignment operator
 
T & operator[] (unsigned i)
 mutable index operator
 
T const & operator[] (unsigned i) const
 immutable index operator
 
unsigned size () const
 get the size of this array
 

Detailed Description

template<class T>
class mth::Vector3< T >

convenience wrapper over apf::Vector<3>

this class add some functions that could not be filled in by templates, mainly component specific initializaiton and x/y/z names

Definition at line 195 of file mthVector.h.


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