AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

animal::VectorVec< Vec > Struct Template Reference

#include <vectorVec.h>

Inheritance diagram for animal::VectorVec< Vec >:

List of all members.

---

Detailed Description

template<class Vec>
struct animal::VectorVec< Vec >

A vector of vectors.

Allows one to overload some linear algebra methods. Such a class can be used, for example, to gather particle positions or velocities (each of them being a 3d vector) in a single state vector. To work on such structures, some methods such as implicit euler integration require overloading basic linear methods. Currently only the methods necessary for conjugate gradient solution are overloaded:

• animal::v_dot( const VectorVec<V>& a, const VectorVec<V>& b )
• animal::v_norm( const VectorVec<V>& a )
• animal::v_eq ( VectorVec<V>& Y, const VectorVec<V>& W, double a, const VectorVec<V>& X )
• animal::v_peq ( VectorVec<V>& Y, double a, const VectorVec<V>& X )

Definition at line 22 of file vectorVec.h.

Public Member Functions
	VectorVec ()
	Default constructor does nothing.
	VectorVec (std::size_t s)
	Vector of given size.
	VectorVec (std::size_t s, Vec v)
	Vector of given size initialized with given entry.

---

Constructor & Destructor Documentation

template<class Vec> animal::VectorVec< Vec >::VectorVec (   )  [inline]

Default constructor does nothing. Definition at line 26 of file vectorVec.h.

template<class Vec> animal::VectorVec< Vec >::VectorVec (  std::size_t  s  )  [inline]

Vector of given size. Definition at line 29 of file vectorVec.h.

template<class Vec> animal::VectorVec< Vec >::VectorVec (  std::size_t  s, Vec  v )  [inline]

Vector of given size initialized with given entry. Definition at line 34 of file vectorVec.h.

---

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

• vectorVec.h

---