VecDouble Class Reference

#include <vecdouble.h>

Inheritance diagram for VecDouble:

[legend]

List of all members.

Public Member Functions
	VecDouble ()
	VecDouble (const VecDouble &v)
	VecDouble (unsigned n)
	VecDouble (const Point< 3 > &p)
	VecDouble (const Point< 2 > &p)
	VecDouble (const Point< 1 > &p)
	VecDouble (const std::vector< double > &p)
bool	is_owner ()
void	swap (VecDouble &v)
void	reinit (const unsigned int N, const bool fast=false)
virtual void	reinit (const VecDouble &V, const bool fast=false)
VecDouble &	operator= (const VecDouble &v)
VecDouble &	operator= (const Vector< double > &v)
VecDouble &	operator= (const BlockVector< double > &v)
void	operator= (double dd)
void	copyRow (unsigned row, Matrix &M)
void	getMinMaxValues (double *min, double *max) const
void	set (double d1, double d2)
void	setRef (double *p, unsigned size)
void	setRef (Vector< double > &v)
virtual	~VecDouble ()
void	term_mult (const VecDouble &v1, const VecDouble &v2)
Protected Attributes
bool	m_owner
Friends
class	ArrayOfVecDouble
class	VecIncBC

---

Detailed Description

VecDouble This class is an extension of the dealII Vector<double> It has a minor difference though. In the usual way the Vector always allocate and deallocate its own memory. Although this is always the safest way, sometimes making the vector to point to someone memory is pretty pretty attractive for efficiency purposes. The old duel between efficiency and manutenability of code.

So this extension of the Vector class, allows the Vector to switch to reference mode. This mode is triggered when the user call setRef method. This is dangerous specially if the user passes a place in memory that does not correspond to the vector size. Segmentation fault may result from that or worse, set a location in memory that belongs to another variable. That why for security measures, once the vector enters this mode, it is not possible anymore to cast it to its base class dealII or even reinitialize the vector. In other words, once the object enters reference mode it cannot own any memory again in its entire lifetime. Also the method setRef is private and can be accessed only by its friend classes. This is done to discourage the use of such method by other programmers. Shallow copy might result in some very nasty errors and sometimes bugs that consumes months of development. So shallow copy can be used here only for some very few and crucial parts of the code and only there.

Right now the only class that is a friend is ArrayOfVecDouble class

Definition at line 38 of file vecdouble.h.

---

Constructor & Destructor Documentation

VecDouble::VecDouble

(

)

Definition at line 163 of file vecdouble.cpp.

{
  m_owner=true;
}

VecDouble::VecDouble

(

const VecDouble &

v

)

Definition at line 17 of file vecdouble.cpp.

   :Vector<double>(v)
 {
   m_owner=true;
 }

VecDouble::VecDouble

(

unsigned

n

)

Definition at line 60 of file vecdouble.cpp.

   :Vector<double>(n)
 {
   m_owner=true;
}

VecDouble::VecDouble

(

const Point< 3 > &

p

)

Definition at line 35 of file vecdouble.cpp.

{
  m_owner=true;
  Point<3> &paux = const_cast<Point<3>& >(p);
  setRef(&(paux[0]),3);
}

VecDouble::VecDouble

(

const Point< 2 > &

p

)

Definition at line 42 of file vecdouble.cpp.

{
  m_owner=true;
  Point<2> &paux = const_cast<Point<2>& >(p);
  setRef(&(paux[0]),2);
}

VecDouble::VecDouble

(

const Point< 1 > &

p

)

Definition at line 49 of file vecdouble.cpp.

{
  m_owner=true;
  Point<1> &paux = const_cast<Point<1>& >(p);
  setRef(&(paux[0]),1);
}

VecDouble::VecDouble

(

const std::vector< double > &

p

)

Definition at line 23 of file vecdouble.cpp.

{
  m_owner=true;
  reinit(p.size());
  for (unsigned i=0;i<p.size();i++)
  {
    operator()(i)=p[i];
  }
}

VecDouble::~VecDouble

(

)

[virtual]

Definition at line 8 of file vecdouble.cpp.

{
  if (!m_owner)
  {
    val=0;
    max_vec_size = vec_size = 0;
  }
}

---

Member Function Documentation

void VecDouble::copyRow	(	unsigned	row,
		Matrix &	M
	)

Definition at line 210 of file vecdouble.cpp.

{
   assert(M.n() == size());
  for (unsigned i=0;i<size();i++)
  {
    (*this)(i)=M(row,i);
  }
}

void VecDouble::getMinMaxValues	(	double *	min,
		double *	max
	)			const

Definition at line 180 of file vecdouble.cpp.

{
  assert(size() != 0);
  *min=*max=(*this)(0);
  for (unsigned i=1;i<size();i++)
  {
    if ((*this)(i) < *min)
      *min=operator()(i);
    if ((*this)(i) > *max)
      *max=operator()(i);
  }

}

bool VecDouble::is_owner

(

)

[inline]

Definition at line 57 of file vecdouble.h.

{return m_owner;}

void VecDouble::operator=

(

double

dd

)

Definition at line 156 of file vecdouble.cpp.

{
  if (vec_size!=0)
    std::fill (begin(), end(), dd);
}

VecDouble & VecDouble::operator=

(

const BlockVector< double > &

v

)

Definition at line 101 of file vecdouble.cpp.

{
  /*
    This method is valid only if the vector owns its memory
    or in the case that both vectors have equal size
  */
  assert(m_owner || (v.size() == size()) );
  Vector<double>::operator=(v);
  return *this;
}

VecDouble & VecDouble::operator=

(

const Vector< double > &

v

)

Definition at line 113 of file vecdouble.cpp.

{
  assert(m_owner || (v.size() == size()) );
  Vector<double>::operator=(v);
  return *this;
}

VecDouble & VecDouble::operator=

(

const VecDouble &

v

)

Definition at line 90 of file vecdouble.cpp.

{
  /*
    This method is valid only if the vector owns its memory
    or in the case that both vectors have equal size
  */
  assert(m_owner || (v.size() == size()) );
  Vector< double >::operator=(v);  
  return *this;
}

void VecDouble::reinit	(	const VecDouble &	V,
		const bool	fast = false
	)			[virtual]

Definition at line 78 of file vecdouble.cpp.

{
  reinit(V.size(),fast);
} 

void VecDouble::reinit	(	const unsigned int	N,
		const bool	fast = false
	)

Definition at line 68 of file vecdouble.cpp.

{
  if (!m_owner)
  {
    throw new Exception("VecDouble::reinit Attemp to reinit a vector that does not own its memory\n");
  }
  Vector<double>::reinit(N,fast);
}

void VecDouble::set	(	double	d1,
		double	d2
	)

Definition at line 221 of file vecdouble.cpp.

{
  reinit(2);
  operator()(0)=d1;
  operator()(1)=d2;
}

void VecDouble::setRef

(

Vector< double > &

v

)

Definition at line 146 of file vecdouble.cpp.

{
  setRef(&(v(0)),v.size());
}

void VecDouble::setRef	(	double *	p,
		unsigned	size
	)

Make the vector to point to someone else memory. Once this function is called, the object is forbidden to allocate memory by its own during its hole like.

Parameters:

	p
	size

Returns:

Reimplemented in VecDoubleRef.

Definition at line 129 of file vecdouble.cpp.

{
  if (m_owner)
  {
    reinit(0);
  }
  m_owner=false;
  val=p;
  max_vec_size=vec_size=size;
}

void VecDouble::swap

(

VecDouble &

v

)

Definition at line 83 of file vecdouble.cpp.

{
  Vector<double>::swap(v);
  std::swap(m_owner,v.m_owner);
}

void VecDouble::term_mult	(	const VecDouble &	v1,
		const VecDouble &	v2
	)

Definition at line 195 of file vecdouble.cpp.

{
  assert(v1.size() == v2.size());
  assert(v1.size() == size());
  const double *d1 = v1.val;
  const double *d2 = v2.val;
  double *d3 = &(operator()(0));
  for (unsigned i=0;i<v1.size();i++)
  {
    *d3++=*d1++ * *d2++;
  }
}

---

Friends And Related Function Documentation

friend class ArrayOfVecDouble [friend]

Definition at line 40 of file vecdouble.h.

friend class VecIncBC [friend]

Definition at line 41 of file vecdouble.h.

---

Member Data Documentation

bool VecDouble::m_owner [protected]

Definition at line 46 of file vecdouble.h.

---

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

• vecdouble.h
• vecdouble.cpp