CoinDenseVector< T > Class Template Reference

#include <CoinDenseVector.hpp>

List of all members.

Public Member Functions
Get methods.
int	getNumElements () const
	Get the size.
int	size () const
const T *	getElements () const
	Get element values.
T *	getElements ()
	Get element values.
Set methods
void	clear ()
	Reset the vector (i.e. set all elemenets to zero).
CoinDenseVector &	operator= (const CoinDenseVector &)
T &	operator[] (int index) const
void	setVector (int size, const T *elems)
void	setConstant (int size, T elems)
void	setElement (int index, T element)
void	resize (int newSize, T fill=T())
void	append (const CoinDenseVector &)
norms, sum and scale
T	oneNorm () const
	1-norm of vector
double	twoNorm () const
	2-norm of vector
T	infNorm () const
	infinity-norm of vector
T	sum () const
	sum of vector elements
void	scale (T factor)
	scale vector elements
Arithmetic operators.
void	operator+= (T value)
	add value to every entry
void	operator-= (T value)
	subtract value from every entry
void	operator *= (T value)
	multiply every entry by value
void	operator/= (T value)
	divide every entry by value
Constructors and destructors
	CoinDenseVector ()
	CoinDenseVector (int size, const T *elems)
	CoinDenseVector (int size, T element=T())
	CoinDenseVector (const CoinDenseVector &)
	~CoinDenseVector ()
Private Member Functions
Private methods
void	gutsOfSetVector (int size, const T *elems)
	Copy internal data.
void	gutsOfSetConstant (int size, T value)
	Set all elements to a given value.
Private Attributes
Private member data
int	nElements_
	Size of element vector.
T *	elements_
	Vector elements.

---

Detailed Description

template<typename T>
class CoinDenseVector< T >

Dense Vector

Stores a dense (or expanded) vector of floating point values. Type of vector elements is controlled by templating. (Some working quantities such as accumulated sums are explicitly declared of type double). This allows the components of the vector integer, single or double precision.

Here is a sample usage:

    const int ne = 4;
    double el[ne] = { 10., 40., 1., 50. };

    // Create vector and set its value
    CoinDenseVector<double> r(ne,el);

    // access each element
    assert( r.getElements()[0]==10. );
    assert( r.getElements()[1]==40. );
    assert( r.getElements()[2]== 1. );
    assert( r.getElements()[3]==50. );

    // Test for equality
    CoinDenseVector<double> r1;
    r1=r;

    // Add dense vectors.
    // Similarly for subtraction, multiplication,
    // and division.
    CoinDenseVector<double> add = r + r1;
    assert( add[0] == 10.+10. );
    assert( add[1] == 40.+40. );
    assert( add[2] ==  1.+ 1. );
    assert( add[3] == 50.+50. );

    assert( r.sum() == 10.+40.+1.+50. );

Definition at line 63 of file CoinDenseVector.hpp.

---

Constructor & Destructor Documentation

template<typename T> CoinDenseVector< T >::CoinDenseVector (   )

Default constructor Definition at line 129 of file CoinDenseVector.cpp. 00129 : 00130 nElements_(0), 00131 elements_(NULL) 00132 {}

template<typename T> CoinDenseVector< T >::CoinDenseVector (  int  size, const T *  elems )

Alternate Constructors - set elements to vector of Ts Definition at line 137 of file CoinDenseVector.cpp. References CoinDenseVector< T >::gutsOfSetVector(). : nElements_(0), elements_(NULL) { gutsOfSetVector(size, elems); }

template<typename T> CoinDenseVector< T >::CoinDenseVector (  int  size, T  element = T() )

Alternate Constructors - set elements to same scalar value Definition at line 146 of file CoinDenseVector.cpp. References CoinDenseVector< T >::gutsOfSetConstant(). : nElements_(0), elements_(NULL) { gutsOfSetConstant(size, value); }

template<typename T> CoinDenseVector< T >::CoinDenseVector (  const CoinDenseVector< T > &   )

Copy constructors Definition at line 156 of file CoinDenseVector.cpp. References CoinDenseVector< T >::setVector(). : nElements_(0), elements_(NULL) { setVector(rhs.getNumElements(), rhs.getElements()); }

template<typename T> CoinDenseVector< T >::~CoinDenseVector (   )

Destructor Definition at line 165 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_. { delete [] elements_; }

---

Member Function Documentation

template<typename T> void CoinDenseVector< T >::append (  const CoinDenseVector< T > &   )

Append a dense vector to this dense vector Definition at line 81 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_, CoinDenseVector< T >::getElements(), CoinDenseVector< T >::getNumElements(), CoinDenseVector< T >::nElements_, and CoinDenseVector< T >::resize(). { const int s = nElements_; const int cs = caboose.getNumElements(); int newsize = s + cs; resize(newsize); const T * celem = caboose.getElements(); CoinDisjointCopyN(celem, cs, elements_ + s); }

template<typename T> CoinDenseVector< T > & CoinDenseVector< T >::operator= (  const CoinDenseVector< T > &   )

Assignment operator Definition at line 24 of file CoinDenseVector.cpp. References CoinDenseVector< T >::getElements(), CoinDenseVector< T >::getNumElements(), and CoinDenseVector< T >::setVector(). { if (this != &rhs) { setVector(rhs.getNumElements(), rhs.getElements()); } return *this; }

template<typename T> T & CoinDenseVector< T >::operator[] (  int  index  )  const

Member of array operator Definition at line 197 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_, and CoinDenseVector< T >::nElements_. { assert(index >= 0 && index < nElements_); T *where = elements_ + index; return *where; }

template<typename T> void CoinDenseVector< T >::resize (  int  newSize, T  fill = T() )

Resize the dense vector to be the first newSize elements. If length is decreased, vector is truncated. If increased new entries, set to new default element Definition at line 54 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_, and CoinDenseVector< T >::nElements_. Referenced by CoinDenseVector< T >::append(), CoinDenseVector< T >::gutsOfSetConstant(), CoinDenseVector< T >::gutsOfSetVector(), CoinDenseVector< T >::setConstant(), and CoinDenseVector< T >::setVector(). { if (newsize != nElements_){ assert(newsize > 0); T *newarray = new T[newsize]; int cpysize = min(newsize, nElements_); memcpy(newarray, elements_, cpysize*sizeof(T)); delete[] elements_; elements_ = newarray; nElements_ = newsize; for(int i=cpysize; i<newsize; i++) elements_[i] = value; } }

template<typename T> void CoinDenseVector< T >::setConstant (  int  size, T  elems )

Elements set to have the same scalar value Definition at line 44 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_, and CoinDenseVector< T >::resize(). { resize(size); for(int i=0; i<size; i++) elements_[i] = value; }

template<typename T> void CoinDenseVector< T >::setElement (  int  index, T  element )

Set an existing element in the dense vector The first argument is the "index" into the elements() array Definition at line 72 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_, and CoinDenseVector< T >::nElements_. { assert(index >= 0 && index < nElements_); elements_[index] = element; }

template<typename T> void CoinDenseVector< T >::setVector (  int  size, const T *  elems )

Set vector size, and elements. Size is the length of the elements vector. The element vector is copied into this class instance's member data. Definition at line 35 of file CoinDenseVector.cpp. References CoinDenseVector< T >::elements_, and CoinDenseVector< T >::resize(). Referenced by CoinDenseVector< T >::CoinDenseVector(), and CoinDenseVector< T >::operator=(). { resize(size); memcpy(elements_, elems, size*sizeof(T)); }

---

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

• CoinDenseVector.hpp
• CoinDenseVector.cpp

---