Vector< T > Class Template Reference

#include <Vector.hpp>

Inheritance diagram for Vector< T >:

[legend]

Collaboration diagram for Vector< T >:

[legend]

List of all members.

Public Types
typedef T	ValueType
	T ValueType Used to be able to access to T using typename.
Public Member Functions
const size_t &	size () const
	Read-only access to the size of the vector.
size_t	number (T const &e) const
	Finds the number of an element of the vector.
const T &	operator[] (const size_t &i) const
	Read-only access to the ith __values of the vector.
T &	operator[] (const size_t &i)
	Access to the ith element of the vector.
const T &	operator() (const size_t &i) const
T &	operator() (const size_t &i)
void	resize (const size_t &newSize)
const Vector< T > &	operator= (const T &t)
	operator= overloading. Initializes every element to the value t.
const Vector< T > &	operator= (const Vector< T > &V)
	operator= overloading. Copies the vector V.
Vector< T >	operator* (const T &t) const
template<class T2>
const Vector< T > &	operator*= (const T2 &t)
	operator*= overloading. The vector is multiplied by t.
Vector< T >	operator+ (const Vector< T > &V) const
Vector< T >	operator- (const Vector< T > &V) const
const Vector< T > &	operator+= (const Vector< T > &V)
	operator+= overloading. Addes V to the vector.
const Vector< T > &	operator+= (const T &t)
	operator+= overloading. Addes V to the vector.
const Vector< T > &	operator-= (const Vector< T > &V)
	operator-= overloading. Substractes V to the vector.
real_t	operator* (const Vector< T > &V) const
	operator* overloading. Scalar product.
	Vector ()
	Default constructor initializes a dimension 0 vector.
	Vector (size_t size)
	Vector (const Vector< T > &V)
	Copy constructor.
	~Vector ()
	Destructor.
Protected Attributes
size_t	__size
	The number of elements of the vector.
T *__restrict	__values
	The elements of the vector.
Friends
std::ostream &	operator<< (std::ostream &os, const Vector< T > &V)
	writes a vector in a stream.
Vector< T >	operator* (const T &t, const Vector< T > &V)
real_t	Norm (const Vector< T > &v)

---

Detailed Description

template<typename T>
class Vector< T >

class Vector This class defines a template Vector class to store huge quantity of datas. The stored elements type is the template argument.

Todo:

Use expression template to provide a more efficient code.

Author:

Stéphane Del Pino.

Definition at line 46 of file Vector.hpp.

---

Member Typedef Documentation

template<typename T>

typedef T Vector< T >::ValueType

T ValueType Used to be able to access to T using typename.

Definition at line 51 of file Vector.hpp.

---

Constructor & Destructor Documentation

template<typename T>

Vector< T >::Vector

(

)

[inline]

Default constructor initializes a dimension 0 vector.

Definition at line 279 of file Vector.hpp.

    : __size(0)
  {
    ;
  }

template<typename T>

Vector< T >::Vector

(

size_t

size

)

[inline]

Constructs a vector which size is givenSize. __values values are garbage.

Definition at line 289 of file Vector.hpp.

    : __size(size)
  {
    if (__size>0)
      __values = new T[__size];
  }

template<typename T>

Vector< T >::Vector

(

const Vector< T > &

V

)

[inline]

Copy constructor.

Definition at line 297 of file Vector.hpp.

    : __size(V.__size)
  {
    if (__size>0)
      __values = new T[__size];
    ZoneCopy(__values,V.__values,__size);
  }

template<typename T>

Vector< T >::~Vector

(

)

[inline]

Destructor.

Definition at line 306 of file Vector.hpp.

  {
    if (__size > 0)
      delete[] __values;
  }

---

Member Function Documentation

template<typename T>

const size_t& Vector< T >::size

(

)

const [inline]

Read-only access to the size of the vector.

Definition at line 61 of file Vector.hpp.

Referenced by DegreeOfFreedomSetBuilder::__buildCorrespondance(), SurfaceMesh::__computesFictitiousCells(), SurfaceMeshGenerator::Internals::__constructionFinalMesh(), SurfaceMeshGenerator::Internals::__constructionVerticesList(), WriterVTK::__fillCrossedComponent(), WriterMedit::__fillCrossedComponent(), ScalarFunctionBuilder::Simplifier::__getOperatorF1F2SimplifiedFunction(), SpectralFEMPreconditioner::Internal::__legendreToLagrange(), SpectralFEMPreconditioner::Internal::__legendreToLagrangeTransposed(), WriterMedit::__proceedData(), MeshFormatReader::__readHexahedra(), MeshFormatReader::__readQuadrilaterals(), MeshFormatReader::__readTetrahedra(), MeshReaderAM_FMTFormat::__readTriangles(), MeshFormatReader::__readTriangles(), MeshReaderAM_FMTFormat::__readTrianglesReferences(), OctreeMeshBuilder::buildMesh(), SpectralFEMPreconditioner::Internal::computes(), MultiGrid::computes(), IncompleteCholeskiFactorization::computes(), DiagPrecond::computes(), SpectralFEMPreconditioner::Internal::computesTransposed(), MultiGrid::copyDirichlet(), LagrangeBasis::degree(), DGFunction< MeshType, FiniteElementTraits >::DGFunction(), LagrangeBasis::dimension(), FEMFunction< MeshType, FiniteElementTraits >::FEMFunction(), FGMRES::FGMRES(), LegendreBasis::getDerivativeValues(), ScalarFunctionReaderVTK::getFunction(), LegendreBasis::getSecondDerivativeValues(), LegendreBasis::getValues(), LagrangeBasis::getValues(), GMRES::GMRES(), invertEndianess(), LagrangeBasis::LagrangeBasis(), ScalarDegreeOfFreedomPositionsSet::number(), Structured3DMesh::numberOfCells(), SpectralMesh::numberOfCells(), EdgesSet::numberOfEdges(), FacesSet< Triangle >::numberOfFaces(), GaussLobatto::numberOfPoints(), VerticesSet::numberOfVertices(), MultiGrid::DirichletPositions::operator()(), Structured3DVector< bool >::operator=(), FEMFunctionBase::operator=(), FEMFunction< MeshType, FiniteElementTraits >::operator=(), DGFunctionBase::operator=(), DGFunction< MeshType, FiniteElementTraits >::operator=(), MultiGrid::residuDirichlet(), ScalarFunctionBuilder::setUnaryMinus(), MultiGrid::DirichletPositions::size(), SpectralFunction::SpectralFunction(), SparseMatrix::transposedTimesX(), and MultiGrid::weightJacobi().

  {
    return __size;
  }

template<typename T>

size_t Vector< T >::number

(

T const &

e

)

const [inline]

Finds the number of an element of the vector.

Definition at line 67 of file Vector.hpp.

Referenced by DegreeOfFreedomSetBuilder::__buildFEMFictitious(), Structured3DMesh::cellNumber(), SpectralMesh::cellNumber(), DegreeOfFreedomSet::DegreeOfFreedomSet(), VerticesSet::number(), FacesSet< Triangle >::number(), and EdgesSet::number().

  {
    ASSERT ((&e >= __values)&&(static_cast<size_t>(&e-__values) < __size));
    return (&e-__values);
  }

template<typename T>

const T& Vector< T >::operator[]

(

const size_t &

i

)

const [inline]

Read-only access to the ith __values of the vector.

Definition at line 83 of file Vector.hpp.

  {
    ASSERT (i<__size);
    return __values[i];
  }

template<typename T>

T& Vector< T >::operator[]

(

const size_t &

i

)

[inline]

Access to the ith element of the vector.

Definition at line 90 of file Vector.hpp.

  {
    ASSERT (i<__size);
    return __values[i];
  }

template<typename T>

const T& Vector< T >::operator()

(

const size_t &

i

)

const [inline]

Read-only access to the ith element of the vector. Used to provide a Blitz-like interface.

Definition at line 100 of file Vector.hpp.

  {
    ASSERT (i<__size);
    return __values[i];
  }

template<typename T>

T& Vector< T >::operator()

(

const size_t &

i

)

[inline]

Access to the ith element of the vector. Used to provide a Blitz-like interface.

Definition at line 110 of file Vector.hpp.

  {
    ASSERT (i<__size);
    return __values[i];
  }

template<typename T>

void Vector< T >::resize

(

const size_t &

newSize

)

[inline]

This function is to resize the vector. Used to provide a Blitz-like interface, the elements are lost if the size is changed.

Definition at line 121 of file Vector.hpp.

Referenced by ScalarDegreeOfFreedomPositionsSet::Builder::__buildFEM(), FictitiousDomainMethod::__computesDegreesOfFreedom(), SpectralLegendreDiscretizer::assembleSecondMember(), SparseMatrix::copyProfile(), FGMRES::FGMRES(), SpectralLegendreDiscretizer::getDiagonal(), BoundaryConditionDiscretizationSpectralConform::getDiagonal(), ScalarFunctionReaderVTK::getFunction(), SpectralLegendreDiscretizer::getMultiDiagonal(), GMRES::GMRES(), Structured3DVector< bool >::resize(), EdgesSet::setNumberOfEdges(), FacesSet< Triangle >::setNumberOfFaces(), VerticesSet::setNumberOfVertices(), BoundaryConditionDiscretizationSpectralConform::setSecondMember(), SpectralLegendreDiscretizer::timesX(), BoundaryConditionDiscretizationSpectralConform::timesX(), SpectralLegendreDiscretizer::transposedTimesX(), and BoundaryConditionDiscretizationSpectralConform::transposedTimesX().

  {
    ASSERT (newSize>=0);

    if (newSize != __size) {
      if (__size!=0)    {               // Destroy previous vector
        delete [] __values;
      }
      __size = newSize;
      __values = new ValueType[__size];
    } else {
      ;                         // else do nothing
    }
  }

template<typename T>

const Vector<T>& Vector< T >::operator=

(

const T &

t

)

[inline]

operator= overloading. Initializes every element to the value t.

Reimplemented in Structured3DVector< T >, and Structured3DVector< bool >.

Definition at line 137 of file Vector.hpp.

Referenced by Structured3DVector< bool >::operator=().

  {
    for (size_t i=0; i<__size; ++i)
      __values[i] = t;
    return (*this);
  }

template<typename T>

const Vector<T>& Vector< T >::operator=

(

const Vector< T > &

V

)

[inline]

operator= overloading. Copies the vector V.

Reimplemented in Structured3DVector< T >, and Structured3DVector< bool >.

Definition at line 145 of file Vector.hpp.

  {
    ASSERT (__size == V.__size);
    ZoneCopy(__values, V.__values, __size);

    return (*this);
  }

template<typename T>

Vector<T> Vector< T >::operator*

(

const T &

t

)

const [inline]

operator* overloading. Returns t * this.

Warning:

a temporary is created!

Definition at line 158 of file Vector.hpp.

  {
    Vector<T> prod(*this);
    TermToTermProduct<T> tttp;
    for (size_t i=0; i<__size; ++i)
      prod.__values[i] = tttp(__values[i],t);
    return prod;
  }

template<typename T>

template<class T2>

const Vector<T>& Vector< T >::operator*=

(

const T2 &

t

)

[inline]

operator*= overloading. The vector is multiplied by t.

Definition at line 185 of file Vector.hpp.

  {
    TermToTermProduct<T> tttp;
    for (size_t i=0; i<__size; ++i)
      __values[i] = tttp(__values[i],t);
    return *this;
  }

template<typename T>

Vector<T> Vector< T >::operator+

(

const Vector< T > &

V

)

const [inline]

operator+ overloading. Computes sum with V.

Warning:

a temporary is created!

Definition at line 197 of file Vector.hpp.

  {
    ASSERT(__size==V.__size);
    Vector<T> W(__size);
    for (size_t i=0; i<__size; ++i)
      W.__values[i] = __values[i] + V.__values[i];
    return W;
  }

template<typename T>

Vector<T> Vector< T >::operator-

(

const Vector< T > &

V

)

const [inline]

operator- overloading. Computes difference with V.

Warning:

a temporary is created!

Definition at line 210 of file Vector.hpp.

  {
    ASSERT(__size==V.__size);

    Vector<T> W(__size);
    for (size_t i=0; i<__size; ++i) {
      W.__values[i] = __values[i] - V.__values[i];
    }

    return W;
  }

template<typename T>

const Vector<T>& Vector< T >::operator+=

(

const Vector< T > &

V

)

[inline]

operator+= overloading. Addes V to the vector.

Definition at line 224 of file Vector.hpp.

  {
    ASSERT(__size==V.__size);

    for (size_t i=0; i<__size; ++i)
      __values[i] += V.__values[i];

    return *this;
  }

template<typename T>

const Vector<T>& Vector< T >::operator+=

(

const T &

t

)

[inline]

operator+= overloading. Addes V to the vector.

Definition at line 235 of file Vector.hpp.

  {
    for (size_t i=0; i<__size; ++i)
      __values[i] += t;

    return *this;
  }

template<typename T>

const Vector<T>& Vector< T >::operator-=

(

const Vector< T > &

V

)

[inline]

operator-= overloading. Substractes V to the vector.

Definition at line 244 of file Vector.hpp.

  {
    ASSERT(__size==V.__size);

    for (size_t i=0; i<__size; ++i)
      __values[i] -= V.__values[i];

    return (*this);
  }

template<typename T>

real_t Vector< T >::operator*

(

const Vector< T > &

V

)

const [inline]

operator* overloading. Scalar product.

Definition at line 255 of file Vector.hpp.

  {
    ASSERT(__size==V.__size);

    real_t t = 0;
    for (size_t i=0; i<__size; ++i)
      t += __values[i] * V.__values[i];

    return t;
  }

---

Friends And Related Function Documentation

template<typename T>

std::ostream& operator<<	(	std::ostream &	os,
		const Vector< T > &	V
	)			[friend]

writes a vector in a stream.

Definition at line 74 of file Vector.hpp.

  {
    for (size_t i=0; i<V.size(); ++i) {
      os << V[i] << '\n';
    }
    return os;
  }

template<typename T>

Vector<T> operator*	(	const T &	t,
		const Vector< T > &	V
	)			[friend]

operator* overloading (friend version). Returns t * this.

Warning:

a temporary is created!

Definition at line 172 of file Vector.hpp.

  {
    Vector<T> sum(V.__size);
    TermToTermProduct<T> tttp;
    for (size_t i=0; i<V.__size; ++i)
      sum.__values[i] = tttp(V.__values[i],t);

    return sum;
  }

template<typename T>

real_t Norm

(

const Vector< T > &

v

)

[friend]

Computes the « norm » of a given vector v. The result is a T! If T is of scalar type it returns the usual norm.

Warning:

only works if the template type T allows scalar product.

Todo:

Name might be change?

Definition at line 272 of file Vector.hpp.

  {
    return sqrt(v*v);
  }

---

Member Data Documentation

template<typename T>

size_t Vector< T >::__size [protected]

The number of elements of the vector.

Definition at line 54 of file Vector.hpp.

Referenced by Vector< Tetrahedron >::number(), Vector< Tetrahedron >::operator()(), Vector< Tetrahedron >::operator*(), Vector< Tetrahedron >::operator*=(), Vector< Tetrahedron >::operator+(), Vector< Tetrahedron >::operator+=(), Vector< Tetrahedron >::operator-(), Vector< Tetrahedron >::operator-=(), Vector< Tetrahedron >::operator=(), Vector< Tetrahedron >::operator[](), Vector< Tetrahedron >::resize(), Vector< Tetrahedron >::size(), Vector< Tetrahedron >::Vector(), and Vector< Tetrahedron >::~Vector().

template<typename T>

T* __restrict Vector< T >::__values [protected]

The elements of the vector.

Definition at line 57 of file Vector.hpp.

Referenced by Vector< Tetrahedron >::number(), Vector< Tetrahedron >::operator()(), Vector< Tetrahedron >::operator*(), Vector< Tetrahedron >::operator*=(), Vector< Tetrahedron >::operator+(), Vector< Tetrahedron >::operator+=(), Vector< Tetrahedron >::operator-(), Vector< Tetrahedron >::operator-=(), Vector< Tetrahedron >::operator=(), Vector< Tetrahedron >::operator[](), Vector< Tetrahedron >::resize(), Vector< Tetrahedron >::Vector(), and Vector< Tetrahedron >::~Vector().

---

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

• Vector.hpp