libMesh::DenseVector< T > Class Template Reference

Defines a dense vector for use in Finite Element-type computations. More...

#include <meshless_interpolation_function.h>

Inheritance diagram for libMesh::DenseVector< T >:

Public Member Functions
	DenseVector (const unsigned int n=0)
	Constructor. More...
	DenseVector (const unsigned int n, const T &val)
	Constructor. More...
template<typename T2 >
	DenseVector (const DenseVector< T2 > &other_vector)
	Copy-constructor. More...
template<typename T2 >
	DenseVector (const std::vector< T2 > &other_vector)
	Copy-constructor, from a std::vector. More...
	DenseVector (DenseVector &&)=default
	The 5 special functions can be defaulted for this class, as it does not manage any memory itself. More...
	DenseVector (const DenseVector &)=default
DenseVector &	operator= (const DenseVector &)=default
DenseVector &	operator= (DenseVector &&)=default
virtual	~DenseVector ()=default
virtual unsigned int	size () const override
virtual bool	empty () const override
virtual void	zero () override
	Set every element in the vector to 0. More...
const T &	operator() (const unsigned int i) const
T &	operator() (const unsigned int i)
virtual T	el (const unsigned int i) const override
virtual T &	el (const unsigned int i) override
template<typename T2 >
DenseVector< T > &	operator= (const DenseVector< T2 > &other_vector)
	Assignment operator. More...
void	swap (DenseVector< T > &other_vector)
	STL-like swap method. More...
void	resize (const unsigned int n)
	Resize the vector. More...
template<typename T2 >
void	append (const DenseVector< T2 > &other_vector)
	Append additional entries to (resizing, but unchanging) the vector. More...
void	scale (const T factor)
	Multiplies every element in the vector by factor. More...
DenseVector< T > &	operator*= (const T factor)
	Multiplies every element in the vector by factor. More...
template<typename T2 , typename T3 >
boostcopy::enable_if_c< ScalarTraits< T2 >::value, void >::type	add (const T2 factor, const DenseVector< T3 > &vec)
	Adds factor times vec to this vector. More...
template<typename T2 >
CompareTypes< T, T2 >::supertype	dot (const DenseVector< T2 > &vec) const
template<typename T2 >
CompareTypes< T, T2 >::supertype	indefinite_dot (const DenseVector< T2 > &vec) const
template<typename T2 >
bool	operator== (const DenseVector< T2 > &vec) const
template<typename T2 >
bool	operator!= (const DenseVector< T2 > &vec) const
template<typename T2 >
DenseVector< T > &	operator+= (const DenseVector< T2 > &vec)
	Adds vec to this vector. More...
template<typename T2 >
DenseVector< T > &	operator-= (const DenseVector< T2 > &vec)
	Subtracts vec from this vector. More...
Real	min () const
Real	max () const
Real	l1_norm () const
Real	l2_norm () const
Real	linfty_norm () const
void	get_principal_subvector (unsigned int sub_n, DenseVector< T > &dest) const
	Puts the principal subvector of size sub_n (i.e. More...
std::vector< T > &	get_values ()
const std::vector< T > &	get_values () const
void	print (std::ostream &os) const
	Pretty-print the vector to stdout. More...
void	print_scientific (std::ostream &os, unsigned precision=8) const
	Prints the entries of the vector with additional decimal places in scientific notation. More...

Private Attributes
std::vector< T >	_val
	The actual data values, stored as a 1D array. More...

Detailed Description

template<typename T>
class libMesh::DenseVector< T >

Defines a dense vector for use in Finite Element-type computations.

This class is to basically compliment the DenseMatrix class. It has additional capabilities over the std::vector that make it useful for finite elements, particularly for systems of equations. All overridden virtual functions are documented in dense_vector_base.h.

Author

Benjamin S. Kirk

Date

2003

Definition at line 39 of file meshless_interpolation_function.h.

Constructor & Destructor Documentation

DenseVector() [1/6]

template<typename T >

libMesh::DenseVector< T >::DenseVector ( const unsigned int  n = 0 )

explicit

Constructor.

Creates a dense vector of dimension n.

Definition at line 277 of file dense_vector.h.

                                                :
  _val (n, T(0.))
{
}

DenseVector() [2/6]

template<typename T>

libMesh::DenseVector< T >::DenseVector ( const unsigned int  n, const T &  val  )

explicit

Constructor.

Creates a dense vector of dimension n where all entries have value val.

Definition at line 285 of file dense_vector.h.

                                           :
  _val (n, val)
{
}

DenseVector() [3/6]

template<typename T >

template<typename T2 >

libMesh::DenseVector< T >::DenseVector

(

const DenseVector< T2 > &

other_vector

)

Copy-constructor.

Definition at line 296 of file dense_vector.h.

                                                                 :
  DenseVectorBase<T>()
{
  const std::vector<T2> & other_vals = other_vector.get_values();

  _val.clear();

  const int N = cast_int<int>(other_vals.size());
  _val.reserve(N);

  for (int i=0; i<N; i++)
    _val.push_back(other_vals[i]);
}

DenseVector() [4/6]

template<typename T >

template<typename T2 >

libMesh::DenseVector< T >::DenseVector

(

const std::vector< T2 > &

other_vector

)

Copy-constructor, from a std::vector.

Definition at line 315 of file dense_vector.h.

                                                               :
  _val(other_vector)
{
}

DenseVector() [5/6]

template<typename T>

libMesh::DenseVector< T >::DenseVector ( DenseVector< T > &&  )

default

The 5 special functions can be defaulted for this class, as it does not manage any memory itself.

DenseVector() [6/6]

template<typename T>

libMesh::DenseVector< T >::DenseVector ( const DenseVector< T > &  )

default

~DenseVector()

template<typename T>

virtual libMesh::DenseVector< T >::~DenseVector ( )

virtualdefault

Member Function Documentation

add()

template<typename T >

template<typename T2 , typename T3 >

boostcopy::enable_if_c< ScalarTraits< T2 >::value, void >::type libMesh::DenseVector< T >::add	(	const T2	factor,
		const DenseVector< T3 > &	vec
	)

Adds factor times vec to this vector.

This should only work if T += T2 * T3 is valid C++ and if T2 is scalar. Return type is void

Returns

A reference to *this.

Definition at line 436 of file dense_vector.h.

Referenced by libMesh::DenseMatrix< Real >::vector_mult_add().

{
  libmesh_assert_equal_to (this->size(), vec.size());

  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    (*this)(i) += static_cast<T>(factor)*vec(i);
}

append()

template<typename T >

template<typename T2 >

void libMesh::DenseVector< T >::append

(

const DenseVector< T2 > &

other_vector

)

Append additional entries to (resizing, but unchanging) the vector.

Definition at line 367 of file dense_vector.h.

{
  const std::vector<T2> & other_vals = other_vector.get_values();

  _val.reserve(this->size() + other_vals.size());
  _val.insert(_val.end(), other_vals.begin(), other_vals.end());
}

dot()

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::DenseVector< T >::dot

(

const DenseVector< T2 > &

vec

)

const

Returns

The dot product of *this with vec.

In the complex-valued case, uses the complex conjugate of vec.

Definition at line 451 of file dense_vector.h.

{
  if (!_val.size())
    return 0.;

  libmesh_assert_equal_to (this->size(), vec.size());

#ifdef LIBMESH_HAVE_EIGEN
  // We reverse the order of the arguments to dot() here since
  // the convention in Eigen is to take the complex conjugate of the
  // *first* argument, while ours is to take the complex conjugate of
  // the second.
  return Eigen::Map<const typename Eigen::Matrix<T2, Eigen::Dynamic, 1>>(vec.get_values().data(), vec.size())
    .dot(Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()));
#else
  typename CompareTypes<T, T2>::supertype val = 0.;

  const int N = cast_int<int>(_val.size());
  // The following pragma tells clang's vectorizer that it is safe to
  // reorder floating point operations for this loop.
#ifdef __clang__
#pragma clang loop vectorize(enable)
#endif
  for (int i=0; i<N; i++)
    val += (*this)(i)*libmesh_conj(vec(i));

  return val;
#endif
}

el() [1/2]

template<typename T>

virtual T libMesh::DenseVector< T >::el ( const unsigned int  i ) const

overridevirtual

Returns

The (i) element of the vector.

Implements libMesh::DenseVectorBase< T >.

Definition at line 112 of file dense_vector.h.

  { return (*this)(i); }

el() [2/2]

template<typename T>

virtual T& libMesh::DenseVector< T >::el ( const unsigned int  i )

overridevirtual

Returns

The (i) element of the vector as a writable reference.

Implements libMesh::DenseVectorBase< T >.

Definition at line 115 of file dense_vector.h.

  { return (*this)(i); }

empty()

template<typename T>

virtual bool libMesh::DenseVector< T >::empty ( ) const

overridevirtual

Returns

true iff size() is 0.

Reimplemented from libMesh::DenseVectorBase< T >.

Definition at line 97 of file dense_vector.h.

Referenced by libMesh::NumericVector< Number >::add_vector(), and libMesh::NumericVector< Number >::insert().

  { return _val.empty(); }

get_principal_subvector()

template<typename T>

void libMesh::DenseVector< T >::get_principal_subvector	(	unsigned int	sub_n,
		DenseVector< T > &	dest
	)		const

Puts the principal subvector of size sub_n (i.e.

first sub_n entries) into dest.

Definition at line 672 of file dense_vector.h.

{
  libmesh_assert_less_equal ( sub_n, this->size() );

  dest.resize(sub_n);
  const int N = cast_int<int>(sub_n);
  for (int i=0; i<N; i++)
    dest(i) = _val[i];
}

get_values() [1/2]

template<typename T>

std::vector<T>& libMesh::DenseVector< T >::get_values

(

)

Returns

A reference to the underlying data storage vector.

This should be used with caution (i.e. one should not change the size of the vector, etc.) but is useful for interoperating with low level BLAS routines which expect a simple array.

Definition at line 256 of file dense_vector.h.

Referenced by libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::operator()().

{ return _val; }

get_values() [2/2]

template<typename T>

const std::vector<T>& libMesh::DenseVector< T >::get_values

(

)

const

Returns

A constant reference to the underlying data storage vector.

Definition at line 261 of file dense_vector.h.

{ return _val; }

indefinite_dot()

template<typename T >

template<typename T2 >

CompareTypes< T, T2 >::supertype libMesh::DenseVector< T >::indefinite_dot

(

const DenseVector< T2 > &

vec

)

const

Returns

The dot product of *this with vec.

In the complex-valued case, does not use the complex conjugate of vec.

Definition at line 484 of file dense_vector.h.

{
  libmesh_assert_equal_to (this->size(), vec.size());

  typename CompareTypes<T, T2>::supertype val = 0.;

  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    val += (*this)(i)*(vec(i));

  return val;
}

l1_norm()

template<typename T >

Real libMesh::DenseVector< T >::l1_norm

(

)

const

Returns

The -norm of the vector, i.e. the sum of the absolute values of the entries.

Definition at line 601 of file dense_vector.h.

{
  if (!_val.size())
    return 0.;

#ifdef LIBMESH_HAVE_EIGEN
  return Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()).template lpNorm<1>();
#else
  Real my_norm = 0.;
  const int N = cast_int<int>(_val.size());
  for (int i=0; i!=N; i++)
    my_norm += std::abs((*this)(i));

  return my_norm;
#endif
}

l2_norm()

template<typename T >

Real libMesh::DenseVector< T >::l2_norm

(

)

const

Returns

The -norm of the vector, i.e. the square root of the sum of the squares of the entries.

Definition at line 622 of file dense_vector.h.

{
  if (!_val.size())
    return 0.;

#ifdef LIBMESH_HAVE_EIGEN
  return Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()).norm();
#else
  Real my_norm = 0.;
  const int N = cast_int<int>(_val.size());
  // The following pragma tells clang's vectorizer that it is safe to
  // reorder floating point operations for this loop.
#ifdef __clang__
#pragma clang loop vectorize(enable)
#endif
  for (int i=0; i!=N; i++)
    my_norm += TensorTools::norm_sq((*this)(i));

  return sqrt(my_norm);
#endif
}

linfty_norm()

template<typename T >

Real libMesh::DenseVector< T >::linfty_norm

(

)

const

Returns

The -norm of the vector, i.e. the maximum absolute value of the entries.

Definition at line 648 of file dense_vector.h.

{
  if (!_val.size())
    return 0.;

#ifdef LIBMESH_HAVE_EIGEN
  return Eigen::Map<const typename Eigen::Matrix<T, Eigen::Dynamic, 1>>(_val.data(), _val.size()).template lpNorm<Eigen::Infinity>();
#else
  Real my_norm = TensorTools::norm_sq((*this)(0));

  const int N = cast_int<int>(_val.size());
  for (int i=1; i!=N; i++)
    {
      Real current = TensorTools::norm_sq((*this)(i));
      my_norm = (my_norm > current? my_norm : current);
    }
  return sqrt(my_norm);
#endif
}

max()

template<typename T >

Real libMesh::DenseVector< T >::max

(

)

const

Returns

The maximum entry of the vector, or the maximum real part in the case of complex numbers.

Definition at line 583 of file dense_vector.h.

{
  libmesh_assert (this->size());
  Real my_max = libmesh_real((*this)(0));

  const int N = cast_int<int>(_val.size());
  for (int i=1; i!=N; i++)
    {
      Real current = libmesh_real((*this)(i));
      my_max = (my_max > current? my_max : current);
    }
  return my_max;
}

min()

template<typename T >

Real libMesh::DenseVector< T >::min

(

)

const

Returns

The minimum entry of the vector, or the minimum real part in the case of complex numbers.

Definition at line 565 of file dense_vector.h.

{
  libmesh_assert (this->size());
  Real my_min = libmesh_real((*this)(0));

  const int N = cast_int<int>(_val.size());
  for (int i=1; i!=N; i++)
    {
      Real current = libmesh_real((*this)(i));
      my_min = (my_min < current? my_min : current);
    }
  return my_min;
}

operator!=()

template<typename T >

template<typename T2 >

bool libMesh::DenseVector< T >::operator!=

(

const DenseVector< T2 > &

vec

)

const

Returns

true if vec is not exactly equal to this vector, false otherwise.

Definition at line 517 of file dense_vector.h.

{
  libmesh_assert_equal_to (this->size(), vec.size());

  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    if ((*this)(i) != vec(i))
      return true;

  return false;
}

operator()() [1/2]

template<typename T >

const T & libMesh::DenseVector< T >::operator()

(

const unsigned int

i

)

const

Returns

Entry i of the vector as a const reference.

Definition at line 390 of file dense_vector.h.

{
  libmesh_assert_less (i, _val.size());

  return _val[i];
}

operator()() [2/2]

template<typename T >

T & libMesh::DenseVector< T >::operator()

(

const unsigned int

i

)

Returns

Entry i of the vector as a writable reference.

Definition at line 401 of file dense_vector.h.

{
  libmesh_assert_less (i, _val.size());

  return _val[i];
}

operator*=()

template<typename T>

DenseVector< T > & libMesh::DenseVector< T >::operator*=

(

const T

factor

)

Multiplies every element in the vector by factor.

Returns

A reference to *this.

Definition at line 423 of file dense_vector.h.

{
  this->scale(factor);
  return *this;
}

operator+=()

template<typename T >

template<typename T2 >

DenseVector< T > & libMesh::DenseVector< T >::operator+=

(

const DenseVector< T2 > &

vec

)

Adds vec to this vector.

Returns

A reference to *this.

Definition at line 534 of file dense_vector.h.

{
  libmesh_assert_equal_to (this->size(), vec.size());

  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    (*this)(i) += vec(i);

  return *this;
}

operator-=()

template<typename T >

template<typename T2 >

DenseVector< T > & libMesh::DenseVector< T >::operator-=

(

const DenseVector< T2 > &

vec

)

Subtracts vec from this vector.

Returns

A reference to *this.

Definition at line 550 of file dense_vector.h.

{
  libmesh_assert_equal_to (this->size(), vec.size());

  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    (*this)(i) -= vec(i);

  return *this;
}

operator=() [1/3]

template<typename T>

DenseVector& libMesh::DenseVector< T >::operator= ( const DenseVector< T > &  )

default

operator=() [2/3]

template<typename T>

DenseVector& libMesh::DenseVector< T >::operator= ( DenseVector< T > &&  )

default

operator=() [3/3]

template<typename T >

template<typename T2 >

DenseVector< T > & libMesh::DenseVector< T >::operator=

(

const DenseVector< T2 > &

other_vector

)

Assignment operator.

Returns

A reference to *this.

Definition at line 327 of file dense_vector.h.

{
  const std::vector<T2> & other_vals = other_vector.get_values();

  _val.clear();

  const int N = cast_int<int>(other_vals.size());
  _val.reserve(N);

  for (int i=0; i<N; i++)
    _val.push_back(other_vals[i]);

  return *this;
}

operator==()

template<typename T >

template<typename T2 >

bool libMesh::DenseVector< T >::operator==

(

const DenseVector< T2 > &

vec

)

const

Returns

true if vec is exactly equal to this vector, false otherwise.

Definition at line 500 of file dense_vector.h.

{
  libmesh_assert_equal_to (this->size(), vec.size());

  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    if ((*this)(i) != vec(i))
      return false;

  return true;
}

print()

template<typename T>

void libMesh::DenseVectorBase< T >::print ( std::ostream &  os ) const

inherited

Pretty-print the vector to stdout.

print_scientific()

template<typename T>

void libMesh::DenseVectorBase< T >::print_scientific ( std::ostream &  os, unsigned  precision = 8  ) const

inherited

Prints the entries of the vector with additional decimal places in scientific notation.

resize()

template<typename T >

void libMesh::DenseVector< T >::resize

(

const unsigned int

n

)

Resize the vector.

Sets all elements to 0.

Definition at line 355 of file dense_vector.h.

Referenced by libMesh::DenseMatrix< Real >::_cholesky_back_substitute(), libMesh::DenseMatrix< Real >::_lu_back_substitute(), libMesh::MeshlessInterpolationFunction::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::operator()(), libMesh::CompositeFEMFunction< Output >::operator()(), libMesh::CompositeFunction< Output >::operator()(), libMesh::DenseVector< Output >::resize(), libMesh::DenseMatrix< Real >::vector_mult(), libMesh::DenseMatrix< Real >::vector_mult_add(), and libMesh::DenseMatrix< Real >::vector_mult_transpose().

{
  _val.resize(n);

  zero();
}

scale()

template<typename T>

void libMesh::DenseVector< T >::scale

(

const T

factor

)

Multiplies every element in the vector by factor.

Definition at line 412 of file dense_vector.h.

{
  const int N = cast_int<int>(_val.size());
  for (int i=0; i<N; i++)
    _val[i] *= factor;
}

size()

template<typename T>

virtual unsigned int libMesh::DenseVector< T >::size ( ) const

overridevirtual

Returns

The size of the vector.

Implements libMesh::DenseVectorBase< T >.

Definition at line 92 of file dense_vector.h.

Referenced by libMesh::DenseMatrix< Real >::_lu_back_substitute(), libMesh::NumericVector< Number >::add_vector(), libMesh::VectorSetAction< Val >::insert(), libMesh::NumericVector< Number >::insert(), libMesh::ConstFunction< Output >::operator()(), libMesh::ConstFEMFunction< Output >::operator()(), libMesh::WrappedFunction< Output >::operator()(), libMesh::ParsedFEMFunction< T >::operator()(), libMesh::CompositeFEMFunction< Output >::operator()(), libMesh::CompositeFunction< Output >::operator()(), libMesh::DenseMatrix< Real >::outer_product(), libMesh::DenseMatrix< Real >::vector_mult(), libMesh::DenseMatrix< Real >::vector_mult_add(), and libMesh::DenseMatrix< Real >::vector_mult_transpose().

  {
    return cast_int<unsigned int>(_val.size());
  }

swap()

template<typename T>

void libMesh::DenseVector< T >::swap

(

DenseVector< T > &

other_vector

)

STL-like swap method.

Definition at line 346 of file dense_vector.h.

{
  _val.swap(other_vector._val);
}

zero()

template<typename T >

void libMesh::DenseVector< T >::zero ( )

overridevirtual

Set every element in the vector to 0.

Needs to be pure virtual since the storage method may be different in derived classes.

Implements libMesh::DenseVectorBase< T >.

Definition at line 379 of file dense_vector.h.

Referenced by SolutionFunction::operator()(), SolutionGradient::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::operator()(), libMesh::CompositeFEMFunction< Output >::operator()(), and libMesh::CompositeFunction< Output >::operator()().

{
  std::fill (_val.begin(),
             _val.end(),
             T(0.));
}

Member Data Documentation

_val

template<typename T>

std::vector<T> libMesh::DenseVector< T >::_val

private

The actual data values, stored as a 1D array.

Definition at line 268 of file dense_vector.h.

Referenced by libMesh::DenseVector< Output >::empty(), libMesh::DenseVector< Output >::get_values(), and libMesh::DenseVector< Output >::size().

---

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

• examples/miscellaneous/miscellaneous_ex8/meshless_interpolation_function.h
• include/numerics/dense_vector.h