Matrix Class Template Reference

Template class for the Dakota numerical matrix. More...

Inheritance diagram for Matrix:

List of all members.

Public Member Functions
	Matrix (size_t num_rows=0, size_t num_cols=0)
	Constructor, takes number of rows, and number of columns as arguments.
	~Matrix ()
	Destructor.
Matrix< T > &	operator= (const T &ival)
	Sets all elements in the matrix to ival.
size_t	num_rows () const
	Returns the number of rows for the matrix.
size_t	num_columns () const
	Returns the number of columns for the matrix.
void	reshape_2d (size_t num_rows, size_t num_cols)
	Resizes the matrix to num_rows by num_cols.
void	read (istream &s, size_t nr, size_t nc)
	Reads a portion of the Matrix from an input stream.
void	read (istream &s)
	Reads the complete Matrix from an input stream.
void	read_row_vector (istream &s, size_t i, size_t nc)
	Reads a portion of the ith Matrix row vector from an input stream.
void	read_row_vector (istream &s, size_t i)
	Reads the ith Matrix row vector from an input stream.
void	write (ostream &s, size_t nr, size_t nc, bool brackets, bool row_rtn, bool final_rtn) const
	Writes a portion of the Matrix to an output stream.
void	write (ostream &s, bool brackets, bool row_rtn, bool final_rtn) const
	Writes the complete Matrix to an output stream.
void	write_row_vector (ostream &s, size_t i, size_t nc, bool brackets, bool break_line, bool final_rtn) const
	Writes a portion of the ith Matrix row vector to an output stream.
void	write_row_vector (ostream &s, size_t i, bool brackets, bool break_line, bool final_rtn) const
	Writes the ith Matrix row vector to an output stream.
void	read (BiStream &s, size_t nr, size_t nc)
	Reads a portion of the Matrix from a binary input stream.
void	read (BiStream &s)
	Reads the complete Matrix from a binary input stream.
void	read_row_vector (BiStream &s, size_t i, size_t nc)
	Reads a portion of the ith Matrix row vector from a binary input stream.
void	read_row_vector (BiStream &s, size_t i)
	Reads the ith Matrix row vector from a binary input stream.
void	write (BoStream &s, size_t nr, size_t nc) const
	Writes a portion of the Matrix to a binary output stream.
void	write (BoStream &s) const
	Writes the complete Matrix to a binary output stream.
void	write_row_vector (BoStream &s, size_t i, size_t nc) const
	Writes a portion of the ith Matrix row vector to a binary output stream.
void	write_row_vector (BoStream &s, size_t i) const
	Writes the ith Matrix row vector to a binary output stream.
void	read (MPIUnpackBuffer &s)
	Reads a Matrix from an MPIUnpackBuffer after an MPI receive.
void	read_annotated (MPIUnpackBuffer &s)
	Reads an annotated Matrix from an MPIUnpackBuffer after an MPI receive.
void	read_row_vector (MPIUnpackBuffer &s, size_t i)
	Reads the ith Matrix row vector from an MPIUnpackBuffer after an MPI recv.
void	write (MPIPackBuffer &s) const
	Writes a Matrix to a MPIPackBuffer prior to an MPI send.
void	write_annotated (MPIPackBuffer &s) const
	Writes an annotated Matrix to a MPIPackBuffer prior to an MPI send.
void	write_row_vector (MPIPackBuffer &s, size_t i) const
	Writes the ith Matrix row vector to a MPIPackBuffer prior to an MPI send.

---

Detailed Description

template<class T>
class Dakota::Matrix< T >

Template class for the Dakota numerical matrix.

A matrix class template to provide 2D arrays of objects. The matrix is zero-based, rows: 0 to (numRows-1) and cols: 0 to (numColumns-1). The class supports overloading of the subscript operator allowing it to emulate a normal built-in 2D array type. Matrix relies on the BaseVector template class to manage any differences between underlying DAKOTA_BASE_VECTOR implementations (RW, STL, etc.).

---

Member Function Documentation

Matrix< T > & operator=

(

const T &

val

)

[inline]

Sets all elements in the matrix to ival.

calls base class operator=(ival)

Reimplemented from BaseVector.

---

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

• DakotaMatrix.H

---