Teuchos::SerialDenseVector< OrdinalType, ScalarType > Class Template Reference

This class creates and provides basic support for dense vectors of templated type as a specialization of Teuchos::SerialDenseMatrix. Additional methods for the SerialDenseVector class, like mathematical methods, can be found documented in SerialDenseMatrix. More...

#include <Teuchos_SerialDenseVector.hpp>

Inheritance diagram for Teuchos::SerialDenseVector< OrdinalType, ScalarType >:

List of all members.

Public Member Functions
Constructor/Destructor methods.
	SerialDenseVector ()
	Default Constructor.
	SerialDenseVector (OrdinalType length, bool zeroOut=true)
	Shaped Constructor.
	SerialDenseVector (DataAccess CV, ScalarType *values, OrdinalType length)
	Shaped Constructor with Values.
	SerialDenseVector (const SerialDenseVector< OrdinalType, ScalarType > &Source)
	Copy Constructor.
virtual	~SerialDenseVector ()
	Destructor.
Sizing methods.
int	size (OrdinalType length_in)
	Size method for changing the size of a SerialDenseVector, initializing entries to zero.
int	sizeUninitialized (OrdinalType length_in)
	Same as size() except leaves values uninitialized.
int	resize (OrdinalType length_in)
	Resizing method for changing the size of a SerialDenseVector, keeping the entries.
Comparison methods.
bool	operator== (const SerialDenseVector< OrdinalType, ScalarType > &Operand)
	Equality of two matrices.
bool	operator!= (const SerialDenseVector< OrdinalType, ScalarType > &Operand)
	Inequality of two matrices.
Set methods.
SerialDenseVector< OrdinalType, ScalarType > &	operator= (const SerialDenseVector< OrdinalType, ScalarType > &Source)
	Copies values from one vector to another.
Accessor methods.
ScalarType &	operator() (OrdinalType index)
	Element access method (non-const).
const ScalarType &	operator() (OrdinalType index) const
	Element access method (const).
ScalarType &	operator[] (OrdinalType index)
	Element access method (non-const).
const ScalarType &	operator[] (OrdinalType index) const
	Element access method (const).
Mathematical methods.
ScalarType	dot (const SerialDenseVector< OrdinalType, ScalarType > &x) const
	Compute the dot product of this vector and x.
Attribute methods.
OrdinalType	length () const
	Returns the length of this vector.
I/O methods.
virtual void	print (std::ostream &os) const
	Print method. Define the behavior of the std::ostream << operator inherited from the Object class.

---

Detailed Description

template<typename OrdinalType, typename ScalarType>
class Teuchos::SerialDenseVector< OrdinalType, ScalarType >

This class creates and provides basic support for dense vectors of templated type as a specialization of Teuchos::SerialDenseMatrix. Additional methods for the SerialDenseVector class, like mathematical methods, can be found documented in SerialDenseMatrix.

Examples:

DenseMatrix/cxx_main.cpp, and LAPACK/cxx_main.cpp.

---

Constructor & Destructor Documentation

template<typename OrdinalType, typename ScalarType> Teuchos::SerialDenseVector< OrdinalType, ScalarType >::SerialDenseVector (   )

Default Constructor. Creates an empty vector of no length. The Sizing methods should be used to size this matrix. Values of this matrix should be set using the [] or the () operators.

template<typename OrdinalType, typename ScalarType> Teuchos::SerialDenseVector< OrdinalType, ScalarType >::SerialDenseVector (  OrdinalType  length, bool  zeroOut = true )

Shaped Constructor. Parameters: length  - Number of elements in this vector. zeroOut  - Initializes values to 0 if true (default) Creates a shaped vector of length length. All values are initialized to 0 when zeroOut is true. Values of this matrix should be set using the [] or the () operators.

template<typename OrdinalType, typename ScalarType> Teuchos::SerialDenseVector< OrdinalType, ScalarType >::SerialDenseVector (  DataAccess  CV, ScalarType *  values, OrdinalType  length )

Shaped Constructor with Values. Parameters: CV  - Enumerated type set to Teuchos::Copy or Teuchos::View. values  - Pointer to an array of ScalarType of the given length. length  - Length of vector to be constructed.

template<typename OrdinalType, typename ScalarType> Teuchos::SerialDenseVector< OrdinalType, ScalarType >::SerialDenseVector (  const SerialDenseVector< OrdinalType, ScalarType > &  Source  )

Copy Constructor.

template<typename OrdinalType, typename ScalarType> Teuchos::SerialDenseVector< OrdinalType, ScalarType >::~SerialDenseVector (   )  [virtual]

Destructor.

---

Member Function Documentation

template<typename OrdinalType, typename ScalarType> int Teuchos::SerialDenseVector< OrdinalType, ScalarType >::size (  OrdinalType  length_in  )  [inline]

Size method for changing the size of a SerialDenseVector, initializing entries to zero. Parameters: length  - The length of the new vector. This allows the user to define the length of a SerialDenseVector at any point. This method can be called at any point after construction. Any values previously in this object will be destroyed and the resized vector starts with all zero values.

template<typename OrdinalType, typename ScalarType> int Teuchos::SerialDenseVector< OrdinalType, ScalarType >::sizeUninitialized (  OrdinalType  length_in  )  [inline]

Same as size() except leaves values uninitialized.

template<typename OrdinalType, typename ScalarType> int Teuchos::SerialDenseVector< OrdinalType, ScalarType >::resize (  OrdinalType  length_in  )  [inline]

Resizing method for changing the size of a SerialDenseVector, keeping the entries. Parameters: length  - The length of the new vector. This allows the user to redefine the length of a SerialDenseVector at any point. This method can be called at any point after construction. Any values previously in this object will be copied to the resized vector.

template<typename OrdinalType, typename ScalarType> bool Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator== (  const SerialDenseVector< OrdinalType, ScalarType > &  Operand  )

Equality of two matrices. Returns: True if this vector and Operand are of the same length and have the same entries, else False will be returned.

template<typename OrdinalType, typename ScalarType> bool Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator!= (  const SerialDenseVector< OrdinalType, ScalarType > &  Operand  )

Inequality of two matrices. Returns: True if this vector and Operand are not of the same length or do not have the same entries, else False will be returned.

template<typename OrdinalType, typename ScalarType> SerialDenseVector< OrdinalType, ScalarType > & Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator= (  const SerialDenseVector< OrdinalType, ScalarType > &  Source  )

Copies values from one vector to another. The operator= copies the values from one existing SerialDenseVector to another. If Source is a view (i.e. CV = Teuchos::View), then this method will return a view. Otherwise, it will return a copy of Source. this will be resized if it is not large enough to copy Source into.

template<typename OrdinalType, typename ScalarType> ScalarType & Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator() (  OrdinalType  index  )  [inline]

Element access method (non-const). Returns the ith element if x(i) is specified, the expression x[i] will return the same element. Returns: (*this)(index) Warning: The validity of index will only be checked if Teuchos is configured with --enable-teuchos-abc.

template<typename OrdinalType, typename ScalarType> const ScalarType & Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator() (  OrdinalType  index  )  const [inline]

Element access method (const). Returns the ith element if x(i) is specified, the expression x[i] will return the same element. Returns: (*this)(index) Warning: The validity of index will only be checked if Teuchos is configured with --enable-teuchos-abc.

template<typename OrdinalType, typename ScalarType> ScalarType & Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator[] (  OrdinalType  index  )  [inline]

Element access method (non-const). Returns the ith element if x[i] is specified, the expression x(i) will return the same element. Returns: (*this)[index] Warning: The validity of index will only be checked if Teuchos is configured with --enable-teuchos-abc. Reimplemented from Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >.

template<typename OrdinalType, typename ScalarType> const ScalarType & Teuchos::SerialDenseVector< OrdinalType, ScalarType >::operator[] (  OrdinalType  index  )  const [inline]

Element access method (const). Returns the ith element if x[i] is specified, the expression x(i) will return the same element. Returns: (*this)[index] Warning: The validity of index will only be checked if Teuchos is configured with --enable-teuchos-abc. Reimplemented from Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >.

template<typename OrdinalType, typename ScalarType> ScalarType Teuchos::SerialDenseVector< OrdinalType, ScalarType >::dot (  const SerialDenseVector< OrdinalType, ScalarType > &  x  )  const

Compute the dot product of this vector and x.

template<typename OrdinalType, typename ScalarType> OrdinalType Teuchos::SerialDenseVector< OrdinalType, ScalarType >::length (   )  const [inline]

Returns the length of this vector.

template<typename OrdinalType, typename ScalarType> void Teuchos::SerialDenseVector< OrdinalType, ScalarType >::print (  std::ostream &  os  )  const [virtual]

Print method. Define the behavior of the std::ostream << operator inherited from the Object class. Reimplemented from Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >.

---

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

• Teuchos_SerialDenseVector.hpp

---