Ravelin
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
Ravelin::SHAREDVECTORN Class Reference

A generic N-dimensional floating point vector. More...

#include <SharedVectorNd.h>

Public Member Functions

 SHAREDVECTORN (const SHAREDVECTORN &source)
 
 SHAREDVECTORN (unsigned len, unsigned inc, unsigned start, SharedResizable< REAL > data)
 
void reset_from (const SHAREDVECTORN &source)
 
SHAREDVECTORN & normalize ()
 
unsigned size () const
 
REAL norm_inf () const
 
REAL norm1 () const
 
REAL norm () const
 
REAL norm_sq () const
 
SHAREDVECTORN segment (unsigned start, unsigned end)
 
CONST_SHAREDVECTORN segment (unsigned start, unsigned end) const
 
SHAREDVECTORN & resize (unsigned N, bool preserve=false)
 
SHAREDVECTORN & operator= (const ORIGIN2 &source)
 
SHAREDVECTORN & operator= (const ORIGIN3 &source)
 
SHAREDVECTORN & operator= (const VECTOR3 &source)
 
SHAREDVECTORN & operator= (const SHAREDVECTORN &source)
 
SHAREDVECTORN & operator= (const CONST_SHAREDVECTORN &source)
 
SHAREDVECTORN & operator= (const VECTORN &source)
 
SHAREDVECTORN & operator/= (REAL scalar)
 
REAL * data ()
 
const REAL * data () const
 
SHAREDVECTORN & resize (unsigned m, unsigned n, bool preserve=false)
 
void reset ()
 Resets the shared structure.
 
unsigned rows () const
 
unsigned columns () const
 
unsigned leading_dim () const
 
unsigned inc () const
 
REAL & operator[] (unsigned i)
 Returns the desired component of this vector.
 
const REAL & operator[] (unsigned i) const
 Returns the desired component of this vector.
 
REAL * data (unsigned i)
 Gets the appropriate data element.
 
const REAL * data (unsigned i) const
 Gets the appropriate data element.
 
COLUMN_ITERATOR segment_iterator_begin (unsigned start, unsigned end)
 
CONST_COLUMN_ITERATOR segment_iterator_begin (unsigned start, unsigned end) const
 
COLUMN_ITERATOR segment_iterator_end (unsigned start, unsigned end)
 
CONST_COLUMN_ITERATOR segment_iterator_end (unsigned start, unsigned end) const
 
CONST_ROW_ITERATOR row_iterator_begin () const
 
CONST_ROW_ITERATOR row_iterator_end () const
 
ROW_ITERATOR row_iterator_begin ()
 
ROW_ITERATOR row_iterator_end ()
 
CONST_COLUMN_ITERATOR column_iterator_begin () const
 
CONST_COLUMN_ITERATOR column_iterator_end () const
 
COLUMN_ITERATOR column_iterator_begin ()
 
COLUMN_ITERATOR column_iterator_end ()
 
COLUMN_ITERATOR begin ()
 Returns the column iterator.
 
CONST_COLUMN_ITERATOR begin () const
 Returns the constant column iterator.
 
COLUMN_ITERATOR end ()
 Returns the column iterator.
 
CONST_COLUMN_ITERATOR end () const
 Returns the constant column iterator.
 
XVECTORN & set_zero ()
 Sets the vector to the zero vector.
 
XVECTORN & set_zero (unsigned m, unsigned n=1)
 Sets the vector to the zero vector.
 
XVECTORN & set_one ()
 Sets the vector to the zero vector.
 
XVECTORN & set_one (unsigned m, unsigned n=1)
 Sets the vector to the zero vector.
 
bool is_finite () const
 Returns true if all components of this vector are not infinite and not NaN, and false otherwise.
 
XVECTORN & negate ()
 Negates the matrix in place.
 
XVECTORN & operator*= (REAL scalar)
 Multiplies this vector in place by a scalar.
 
template<class V >
XVECTORN & set_sub_vec (unsigned start, const V &v)
 Sets a sub-vector of this vector. More...
 
template<class V >
XVECTORN & operator+= (const V &v)
 Adds a vector from this one in place.
 
template<class V >
XVECTORN & operator-= (const V &v)
 Subtracts a vector from this one in place.
 
template<class ForwardIterator , class V >
XVECTORN & set (ForwardIterator idx_begin, ForwardIterator idx_end, const V &v)
 Sets a subvector; other components are unchanged.
 
template<class V >
XVECTORN & set (std::vector< bool > &indices, const V &v)
 Sets a subvector; other components are unchanged.
 
template<class V >
V & get_sub_vec (unsigned start, unsigned end, V &v) const
 Gets a sub-vector from this vector. More...
 
template<class V >
bool operator< (const V &v) const
 Compares two vectors lexographically.
 
template<class V >
bool operator== (const V &v) const
 Compares two vectors. More...
 
template<class V >
REAL dot (const V &v) const
 Computes the dot-product between two vectors.
 
template<class V >
V & select (const std::vector< bool > &indices, V &v) const
 Gets a subvector (not necessarily contiguous)
 
template<class ForwardIterator , class V >
V & select (ForwardIterator idx_begin, ForwardIterator idx_end, V &v) const
 Gets a subvector (not necessarily contiguous)
 
 SHAREDVECTORN (const SHAREDVECTORN &source)
 
 SHAREDVECTORN (unsigned len, unsigned inc, unsigned start, SharedResizable< REAL > data)
 
void reset_from (const SHAREDVECTORN &source)
 
SHAREDVECTORN & normalize ()
 
unsigned size () const
 
REAL norm_inf () const
 
REAL norm1 () const
 
REAL norm () const
 
REAL norm_sq () const
 
SHAREDVECTORN segment (unsigned start, unsigned end)
 
CONST_SHAREDVECTORN segment (unsigned start, unsigned end) const
 
SHAREDVECTORN & resize (unsigned N, bool preserve=false)
 
SHAREDVECTORN & operator= (const ORIGIN2 &source)
 
SHAREDVECTORN & operator= (const ORIGIN3 &source)
 
SHAREDVECTORN & operator= (const VECTOR3 &source)
 
SHAREDVECTORN & operator= (const SHAREDVECTORN &source)
 
SHAREDVECTORN & operator= (const CONST_SHAREDVECTORN &source)
 
SHAREDVECTORN & operator= (const VECTORN &source)
 
SHAREDVECTORN & operator/= (REAL scalar)
 
REAL * data ()
 
const REAL * data () const
 
SHAREDVECTORN & resize (unsigned m, unsigned n, bool preserve=false)
 
void reset ()
 Resets the shared structure.
 
unsigned rows () const
 
unsigned columns () const
 
unsigned leading_dim () const
 
unsigned inc () const
 
REAL & operator[] (unsigned i)
 Returns the desired component of this vector.
 
const REAL & operator[] (unsigned i) const
 Returns the desired component of this vector.
 
REAL * data (unsigned i)
 Gets the appropriate data element.
 
const REAL * data (unsigned i) const
 Gets the appropriate data element.
 
COLUMN_ITERATOR segment_iterator_begin (unsigned start, unsigned end)
 
CONST_COLUMN_ITERATOR segment_iterator_begin (unsigned start, unsigned end) const
 
COLUMN_ITERATOR segment_iterator_end (unsigned start, unsigned end)
 
CONST_COLUMN_ITERATOR segment_iterator_end (unsigned start, unsigned end) const
 
CONST_ROW_ITERATOR row_iterator_begin () const
 
CONST_ROW_ITERATOR row_iterator_end () const
 
ROW_ITERATOR row_iterator_begin ()
 
ROW_ITERATOR row_iterator_end ()
 
CONST_COLUMN_ITERATOR column_iterator_begin () const
 
CONST_COLUMN_ITERATOR column_iterator_end () const
 
COLUMN_ITERATOR column_iterator_begin ()
 
COLUMN_ITERATOR column_iterator_end ()
 
COLUMN_ITERATOR begin ()
 Returns the column iterator.
 
CONST_COLUMN_ITERATOR begin () const
 Returns the constant column iterator.
 
COLUMN_ITERATOR end ()
 Returns the column iterator.
 
CONST_COLUMN_ITERATOR end () const
 Returns the constant column iterator.
 
XVECTORN & set_zero ()
 Sets the vector to the zero vector.
 
XVECTORN & set_zero (unsigned m, unsigned n=1)
 Sets the vector to the zero vector.
 
XVECTORN & set_one ()
 Sets the vector to the zero vector.
 
XVECTORN & set_one (unsigned m, unsigned n=1)
 Sets the vector to the zero vector.
 
bool is_finite () const
 Returns true if all components of this vector are not infinite and not NaN, and false otherwise.
 
XVECTORN & negate ()
 Negates the matrix in place.
 
XVECTORN & operator*= (REAL scalar)
 Multiplies this vector in place by a scalar.
 
template<class V >
XVECTORN & set_sub_vec (unsigned start, const V &v)
 Sets a sub-vector of this vector. More...
 
template<class V >
XVECTORN & operator+= (const V &v)
 Adds a vector from this one in place.
 
template<class V >
XVECTORN & operator-= (const V &v)
 Subtracts a vector from this one in place.
 
template<class ForwardIterator , class V >
XVECTORN & set (ForwardIterator idx_begin, ForwardIterator idx_end, const V &v)
 Sets a subvector; other components are unchanged.
 
template<class V >
XVECTORN & set (std::vector< bool > &indices, const V &v)
 Sets a subvector; other components are unchanged.
 
template<class V >
V & get_sub_vec (unsigned start, unsigned end, V &v) const
 Gets a sub-vector from this vector. More...
 
template<class V >
bool operator< (const V &v) const
 Compares two vectors lexographically.
 
template<class V >
bool operator== (const V &v) const
 Compares two vectors. More...
 
template<class V >
REAL dot (const V &v) const
 Computes the dot-product between two vectors.
 
template<class V >
V & select (const std::vector< bool > &indices, V &v) const
 Gets a subvector (not necessarily contiguous)
 
template<class ForwardIterator , class V >
V & select (ForwardIterator idx_begin, ForwardIterator idx_end, V &v) const
 Gets a subvector (not necessarily contiguous)
 

Static Public Member Functions

static REAL norm (const SHAREDVECTORN &v)
 
static REAL norm_sq (const SHAREDVECTORN &v)
 
template<class V1 , class V2 >
static REAL dot (const V1 &v1, const V2 &v2)
 Computes the dot-product between two vectors.
 
static REAL norm_inf (const XVECTORN &v)
 Computes the infinity norm of this vector.
 
static REAL norm1 (const XVECTORN &v)
 Computes the l1-norm of this vector.
 
static REAL norm (const SHAREDVECTORN &v)
 
static REAL norm_sq (const SHAREDVECTORN &v)
 
template<class V1 , class V2 >
static REAL dot (const V1 &v1, const V2 &v2)
 Computes the dot-product between two vectors.
 
static REAL norm_inf (const XVECTORN &v)
 Computes the infinity norm of this vector.
 
static REAL norm1 (const XVECTORN &v)
 Computes the l1-norm of this vector.
 

Protected Attributes

SharedResizable< REAL > _data
 
unsigned _start
 
unsigned _inc
 
unsigned _len
 

Friends

class VECTORN
 
class MATRIXN
 
class MATRIX2
 
class MATRIX3
 
class CONST_SHAREDVECTORN
 
class SHAREDMATRIXN
 
class CONST_SHAREDMATRIXN
 

Detailed Description

A generic N-dimensional floating point vector.

Member Function Documentation

template<class V >
V& Ravelin::SHAREDVECTORN::get_sub_vec ( unsigned  start,
unsigned  end,
V &  v 
) const
inline

Gets a sub-vector from this vector.

Parameters
start_idxthe starting index (inclusive)
end_idxthe ending index (exclusive)
template<class V >
V& Ravelin::SHAREDVECTORN::get_sub_vec ( unsigned  start,
unsigned  end,
V &  v 
) const
inline

Gets a sub-vector from this vector.

Parameters
start_idxthe starting index (inclusive)
end_idxthe ending index (exclusive)
template<class V >
bool Ravelin::SHAREDVECTORN::operator== ( const V &  v) const
inline

Compares two vectors.

Note
this method exists solely for convenience of use with iterators
template<class V >
bool Ravelin::SHAREDVECTORN::operator== ( const V &  v) const
inline

Compares two vectors.

Note
this method exists solely for convenience of use with iterators
template<class V >
XVECTORN& Ravelin::SHAREDVECTORN::set_sub_vec ( unsigned  start,
const V &  v 
)
inline

Sets a sub-vector of this vector.

Parameters
start_idxthe starting index (inclusive)
va (end_idx - start_idx + 1)-dimensional vector
template<class V >
XVECTORN& Ravelin::SHAREDVECTORN::set_sub_vec ( unsigned  start,
const V &  v 
)
inline

Sets a sub-vector of this vector.

Parameters
start_idxthe starting index (inclusive)
va (end_idx - start_idx + 1)-dimensional vector
The documentation for this class was generated from the following files:
Generated on Wed Mar 9 2016 11:34:08 for Ravelin by   doxygen 1.8.6