Implementation of a 3D vector (by Vitaliy). More...

#include <SmallVector.h>

Public Member Functions
	SmallVector ()

	SmallVector (const SmallVector &other)

	SmallVector (SmallVector &&other)

	SmallVector (const Mdouble array[])

	SmallVector (std::initializer_list< Mdouble > data)

SmallVector &	operator= (const SmallVector &right)

SmallVector &	operator= (const std::array< Mdouble, numberOfRows > l)

SmallVector	operator+ (const SmallVector &right) const

SmallVector	operator- (const SmallVector &right) const

SmallVector	operator* (const Mdouble &right) const

Mdouble	operator* (const SmallVector &right) const
	Computes inner product between two vectors. More...

SmallVector &	operator/= (const Mdouble &right)

SmallVector	operator/ (const Mdouble &right) const

void	axpy (Mdouble a, const SmallVector &x)

bool	operator== (const SmallVector &right) const
	This function is dangerous to use, since it compares doubles without a tolerance interval to see if they are equal. More...

bool	operator< (const SmallVector &right) const
	This function is dangerous to use, since it compares doubles without a tolerance interval to see if they are equal. More...

SmallVector &	operator+= (const SmallVector &right)

SmallVector &	operator-= (const SmallVector &right)

SmallVector &	operator*= (const double &right)

Mdouble &	operator[] (unsigned int n)

const Mdouble &	operator[] (unsigned int n) const

Mdouble &	operator() (unsigned int n)

const Mdouble &	operator() (unsigned int n) const

unsigned int	size () const

const Mdouble *	data () const

Mdouble *	data ()

SmallVector	operator- () const

Mdouble	length () const

SmallVector< numberOfRows >	getNormalised () const

Private Attributes
std::array< Mdouble, numberOfRows >	data_

Detailed Description

template<unsigned int numberOfRows>
class SmallVector< numberOfRows >

Implementation of a 3D vector (by Vitaliy).

Modifications 21:9:2009 - Added the inclusion guards and some include objects

Todo:: Need to generalize this to n-dimensional vectors of any type

Definition at line 61 of file SmallVector.h.

Constructor & Destructor Documentation

template<unsigned int numberOfRows>

SmallVector< numberOfRows >::SmallVector ( )

inline

Definition at line 66 of file SmallVector.h.

             : data_()
     {
     }

template<unsigned int numberOfRows>

SmallVector< numberOfRows >::SmallVector ( const SmallVector< numberOfRows > & other )

inline

Definition at line 71 of file SmallVector.h.

             : data_(other.data_)
     {
     }

template<unsigned int numberOfRows>

SmallVector< numberOfRows >::SmallVector ( SmallVector< numberOfRows > && other )

inline

Definition at line 76 of file SmallVector.h.

             : data_(std::move(other.data_))
     {
     }

template<unsigned int numberOfRows>

SmallVector< numberOfRows >::SmallVector ( const Mdouble array[] )

inline

Definition at line 81 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

             : data_()
     {
         std::copy(array, array + numberOfRows, data_.begin());
     }

template<unsigned int numberOfRows>

SmallVector< numberOfRows >::SmallVector ( std::initializer_list< Mdouble > data )

inline

Definition at line 87 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and logger.

             : data_()
     {
         logger.assert(data.size() == numberOfRows, "provided array has size %, but should have size %",
                       data.size(), numberOfRows);
         std::copy(data.begin(), data.end(), data_.begin());
     }

Member Function Documentation

template<unsigned int numberOfRows>

void SmallVector< numberOfRows >::axpy	(	Mdouble	a,
		const SmallVector< numberOfRows > &	x
	)

inline

Definition at line 150 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and constants::i.

     {
         for (unsigned int i = 0; i < numberOfRows; ++i)
         {
             data_[i] += a * x[i];
         }
     }

template<unsigned int numberOfRows>

const Mdouble* SmallVector< numberOfRows >::data ( ) const

inline

Definition at line 238 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

Referenced by SmallMatrix< numberOfRows, numberOfColumns >::operator*(), operator*(), SmallMatrix< numberOfRows, numberOfColumns >::SmallMatrix(), and SmallMatrix< numberOfRows, numberOfColumns >::solve().

     {
         return data_.data();
     }

template<unsigned int numberOfRows>

Mdouble* SmallVector< numberOfRows >::data ( )

inline

Definition at line 243 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         return data_.data();
     }

template<unsigned int numberOfRows>

SmallVector<numberOfRows> SmallVector< numberOfRows >::getNormalised ( ) const

inline

Definition at line 264 of file SmallVector.h.

References SmallVector< numberOfRows >::length().

     {
         return (*this) / length();
     }

template<unsigned int numberOfRows>

Mdouble SmallVector< numberOfRows >::length ( ) const

inline

Definition at line 253 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, DEBUG, and logger.

Referenced by SuperQuadricParticle::getCurvature(), and SmallVector< numberOfRows >::getNormalised().

     {
         Mdouble sum = 0;
         for (Mdouble x : data_)
         {
             sum += x * x;
             logger(DEBUG, "x: %, sum: %", x, sum);
         }
         return std::sqrt(sum);
     }

template<unsigned int numberOfRows>

Mdouble& SmallVector< numberOfRows >::operator() ( unsigned int n )

inline

Definition at line 221 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and logger.

     {
         logger.assert(n < numberOfRows, "Requested entry %, but there are only % entries", n, numberOfRows);
         return data_[n];
     }

template<unsigned int numberOfRows>

const Mdouble& SmallVector< numberOfRows >::operator() ( unsigned int n ) const

inline

Definition at line 227 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and logger.

     {
         logger.assert(n < numberOfRows, "Requested entry %, but there are only % entries", n, numberOfRows);
         return data_[n];
     }

template<unsigned int numberOfRows>

SmallVector SmallVector< numberOfRows >::operator* ( const Mdouble & right ) const

inline

Definition at line 121 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         SmallVector result;
         std::transform(data_.begin(), data_.end(), result.data_.begin(), std::bind(std::multiplies<Mdouble>(),
                                                                                    std::placeholders::_1, right));
         return result;
     }

template<unsigned int numberOfRows>

Mdouble SmallVector< numberOfRows >::operator* ( const SmallVector< numberOfRows > & right ) const

inline

Computes inner product between two vectors.

Definition at line 130 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         return std::inner_product(right.data_.begin(), right.data_.end(), data_.begin(), 0.0);
     }

template<unsigned int numberOfRows>

SmallVector& SmallVector< numberOfRows >::operator*= ( const double & right )

inline

Definition at line 202 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         std::transform(data_.begin(), data_.end(), data_.begin(), std::bind(std::multiplies<Mdouble>(),
                                                                             std::placeholders::_1, right));
         return *this;
     }

template<unsigned int numberOfRows>

SmallVector SmallVector< numberOfRows >::operator+ ( const SmallVector< numberOfRows > & right ) const

inline

Definition at line 107 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         SmallVector result;
         std::transform(data_.begin(), data_.end(), right.data_.begin(), result.data_.begin(), std::plus<Mdouble>());
         return result;
     }

template<unsigned int numberOfRows>

SmallVector& SmallVector< numberOfRows >::operator+= ( const SmallVector< numberOfRows > & right )

inline

Definition at line 190 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         std::transform(data_.begin(), data_.end(), right.data_.begin(), data_.begin(), std::plus<Mdouble>());
         return *this;
     }

template<unsigned int numberOfRows>

SmallVector SmallVector< numberOfRows >::operator- ( const SmallVector< numberOfRows > & right ) const

inline

Definition at line 114 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         SmallVector result;
         std::transform(data_.begin(), data_.end(), right.data_.begin(), result.data_.begin(), std::minus<Mdouble>());
         return result;
     }

template<unsigned int numberOfRows>

SmallVector SmallVector< numberOfRows >::operator- ( ) const

inline

Definition at line 248 of file SmallVector.h.

     {
         return *this * -1.0;
     }

template<unsigned int numberOfRows>

SmallVector& SmallVector< numberOfRows >::operator-= ( const SmallVector< numberOfRows > & right )

inline

Definition at line 196 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         std::transform(data_.begin(), data_.end(), right.data_.begin(), data_.begin(), std::minus<Mdouble>());
         return *this;
     }

template<unsigned int numberOfRows>

SmallVector SmallVector< numberOfRows >::operator/ ( const Mdouble & right ) const

inline

Definition at line 142 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         SmallVector result;
         std::transform(data_.begin(), data_.end(), result.data_.begin(), std::bind(std::divides<Mdouble>(),
                                                                                    std::placeholders::_1, right));
         return result;
     }

template<unsigned int numberOfRows>

SmallVector& SmallVector< numberOfRows >::operator/= ( const Mdouble & right )

inline

Definition at line 135 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         std::transform(data_.begin(), data_.end(), data_.begin(), std::bind(std::divides<Mdouble>(),
                                                                             std::placeholders::_1, right));
         return *this;
     }

template<unsigned int numberOfRows>

bool SmallVector< numberOfRows >::operator< ( const SmallVector< numberOfRows > & right ) const

inline

This function is dangerous to use, since it compares doubles without a tolerance interval to see if they are equal.

Definition at line 174 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and constants::i.

     {
         for (unsigned int i = 0; i < numberOfRows; ++i)
         {
             if (data_[i] < right[i])
             {
                 return true;
             }
             if (data_[i] > right[i])
             {
                 return false;
             }
         }
         return false;
     }

template<unsigned int numberOfRows>

SmallVector& SmallVector< numberOfRows >::operator= ( const SmallVector< numberOfRows > & right )

inline

Definition at line 95 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         std::copy(right.data_.begin(), right.data_.end(), data_.begin());
         return *this;
     }

template<unsigned int numberOfRows>

SmallVector& SmallVector< numberOfRows >::operator= ( const std::array< Mdouble, numberOfRows > l )

inline

Definition at line 101 of file SmallVector.h.

References SmallVector< numberOfRows >::data_.

     {
         std::copy(l.begin(), l.end(), data_.begin());
         return *this;
     }

template<unsigned int numberOfRows>

bool SmallVector< numberOfRows >::operator== ( const SmallVector< numberOfRows > & right ) const

inline

This function is dangerous to use, since it compares doubles without a tolerance interval to see if they are equal.

Definition at line 160 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and constants::i.

     {
         for (unsigned int i = 0; i < numberOfRows; ++i)
         {
             if (data_[i] != right[i])
             {
                 return false;
             }
         }
         return true;
     }

template<unsigned int numberOfRows>

Mdouble& SmallVector< numberOfRows >::operator[] ( unsigned int n )

inline

Definition at line 209 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and logger.

     {
         logger.assert(n < numberOfRows, "Requested entry %, but there are only % entries", n, numberOfRows);
         return data_[n];
     }

template<unsigned int numberOfRows>

const Mdouble& SmallVector< numberOfRows >::operator[] ( unsigned int n ) const

inline

Definition at line 215 of file SmallVector.h.

References SmallVector< numberOfRows >::data_, and logger.

     {
         logger.assert(n < numberOfRows, "Requested entry %, but there are only % entries", n, numberOfRows);
         return data_[n];
     }

template<unsigned int numberOfRows>

unsigned int SmallVector< numberOfRows >::size ( ) const

inline

Definition at line 233 of file SmallVector.h.

Referenced by SmallMatrix< numberOfRows, numberOfColumns >::operator*(), and operator*().

     {
         return numberOfRows;
     }

Member Data Documentation

template<unsigned int numberOfRows>

std::array<Mdouble, numberOfRows> SmallVector< numberOfRows >::data_

private

Definition at line 270 of file SmallVector.h.

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

Math/SmallVector.h

Public Member Functions

Private Attributes

Detailed Description

template<unsigned int numberOfRows> class SmallVector< numberOfRows >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned int numberOfRows>
class SmallVector< numberOfRows >