MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Private Member Functions | Private Attributes | List of all members
DenseLinAlgPack::DMatrix Class Reference

More...

#include <DenseLinAlgPack_DMatrixClass.hpp>

Public Types

typedef DenseLinAlgPack::value_type value_type
 
typedef DenseLinAlgPack::size_type size_type
 
typedef ptrdiff_t difference_type
 
typedef value_typereference
 
typedef const value_typeconst_reference
 
typedef std::valarray< value_typevalarray
 

Private Member Functions

void validate_row_subscript (size_type i) const
 
void validate_col_subscript (size_type j) const
 
DVectorSlice p_diag (difference_type k) const
 

Private Attributes

std::valarray< value_typev_
 
size_type rows_
 
 DMatrix ()
 Construct a matrix with rows = cols = 0. More...
 
 DMatrix (size_type rows, size_type cols)
 Construct an uninitialied rectangular matrix (rows x cols) More...
 
 DMatrix (value_type val, size_type rows, size_type cols)
 
 DMatrix (const value_type *p, size_type rows, size_type cols)
 
 DMatrix (const DMatrixSlice &gms)
 
void resize (size_type rows, size_type cols, value_type val=value_type())
 Resize matrix to a (rows x cols) matrix and initializes any added elements by val. More...
 
void free ()
 frees memory and leaves a (0 x 0) matrix More...
 
size_type rows () const
 Return the number of rows. More...
 
size_type cols () const
 Return the number of columns. More...
 
EOverLap overlap (const DMatrixSlice &gms) const
 
reference operator() (size_type i, size_type j)
 Return element at row i, col j (i,j) (1-based) More...
 
const_reference operator() (size_type i, size_type j) const
 Return element at row i, col j (i,j) (1-based) More...
 
DVectorSlice row (size_type i)
 Return DVectorSlice object representing the ith row (1-based; 1,2,..,#this->rows()#) More...
 
const DVectorSlice row (size_type i) const
 
DVectorSlice col (size_type j)
 Return DVectorSlice object representing the jth column (1-based; 1,2,..,#this->cols()#) More...
 
const DVectorSlice col (size_type j) const
 
DVectorSlice diag (difference_type k=0)
 
const DVectorSlice diag (difference_type k=0) const
 
DMatrixSlice operator() (const Range1D &I, const Range1D &J)
 
const DMatrixSlice operator() (const Range1D &I, const Range1D &J) const
 
DMatrixSlice operator() (size_type i1, size_type i2, size_type j1, size_type j2)
 
const DMatrixSlice operator() (size_type i1, size_type i2, size_type j1, size_type j2) const
 
DMatrixSlice operator() ()
 Return a DMatrixSlice that represents this entire matrix. More...
 
const DMatrixSlice operator() () const
 
 operator DMatrixSlice ()
 
 operator const DMatrixSlice () const
 
DMatrixoperator= (value_type rhs)
 
DMatrixoperator= (const DMatrixSlice &gms_rhs)
 
DMatrixoperator= (const DMatrix &rhs)
 Same as above. Needed to override the default assignment operator. More...
 
size_type max_rows () const
 Return the number of rows in the full matrix. Equivalent to BLAS LDA argument. More...
 
value_typecol_ptr (size_type j)
 
const value_typecol_ptr (size_type j) const
 Same as above. More...
 

Detailed Description

Definition at line 372 of file DenseLinAlgPack_DMatrixClass.hpp.

Member Typedef Documentation

typedef DenseLinAlgPack::value_type DenseLinAlgPack::DMatrix::value_type

Definition at line 389 of file DenseLinAlgPack_DMatrixClass.hpp.

typedef DenseLinAlgPack::size_type DenseLinAlgPack::DMatrix::size_type

Definition at line 390 of file DenseLinAlgPack_DMatrixClass.hpp.

typedef ptrdiff_t DenseLinAlgPack::DMatrix::difference_type

Definition at line 391 of file DenseLinAlgPack_DMatrixClass.hpp.

typedef value_type& DenseLinAlgPack::DMatrix::reference

Definition at line 392 of file DenseLinAlgPack_DMatrixClass.hpp.

typedef const value_type& DenseLinAlgPack::DMatrix::const_reference

Definition at line 393 of file DenseLinAlgPack_DMatrixClass.hpp.

typedef std::valarray<value_type> DenseLinAlgPack::DMatrix::valarray

Definition at line 394 of file DenseLinAlgPack_DMatrixClass.hpp.

Constructor & Destructor Documentation

DenseLinAlgPack::DMatrix::DMatrix ( )
inline

Construct a matrix with rows = cols = 0.

Definition at line 977 of file DenseLinAlgPack_DMatrixClass.hpp.

DenseLinAlgPack::DMatrix::DMatrix ( size_type  rows,
size_type  cols 
)
inlineexplicit

Construct an uninitialied rectangular matrix (rows x cols)

Definition at line 981 of file DenseLinAlgPack_DMatrixClass.hpp.

DenseLinAlgPack::DMatrix::DMatrix ( value_type  val,
size_type  rows,
size_type  cols 
)
inlineexplicit

Definition at line 986 of file DenseLinAlgPack_DMatrixClass.hpp.

DenseLinAlgPack::DMatrix::DMatrix ( const value_type p,
size_type  rows,
size_type  cols 
)
inlineexplicit

Definition at line 991 of file DenseLinAlgPack_DMatrixClass.hpp.

DenseLinAlgPack::DMatrix::DMatrix ( const DMatrixSlice gms)
inline

Definition at line 1001 of file DenseLinAlgPack_DMatrixClass.hpp.

Member Function Documentation

void DenseLinAlgPack::DMatrix::resize ( size_type  rows,
size_type  cols,
value_type  val = value_type() 
)
inline

Resize matrix to a (rows x cols) matrix and initializes any added elements by val.

Definition at line 1010 of file DenseLinAlgPack_DMatrixClass.hpp.

void DenseLinAlgPack::DMatrix::free ( )
inline

frees memory and leaves a (0 x 0) matrix

Definition at line 1018 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix::size_type DenseLinAlgPack::DMatrix::rows ( ) const
inline

Return the number of rows.

Definition at line 1026 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix::size_type DenseLinAlgPack::DMatrix::cols ( ) const
inline

Return the number of columns.

Definition at line 1031 of file DenseLinAlgPack_DMatrixClass.hpp.

EOverLap DenseLinAlgPack::DMatrix::overlap ( const DMatrixSlice gms) const

Definition at line 168 of file DenseLinAlgPack_DMatrixClass.cpp.

DMatrix::reference DenseLinAlgPack::DMatrix::operator() ( size_type  i,
size_type  j 
)
inline

Return element at row i, col j (i,j) (1-based)

Definition at line 1038 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix::const_reference DenseLinAlgPack::DMatrix::operator() ( size_type  i,
size_type  j 
) const
inline

Return element at row i, col j (i,j) (1-based)

Definition at line 1045 of file DenseLinAlgPack_DMatrixClass.hpp.

DVectorSlice DenseLinAlgPack::DMatrix::row ( size_type  i)
inline

Return DVectorSlice object representing the ith row (1-based; 1,2,..,#this->rows()#)

Definition at line 1054 of file DenseLinAlgPack_DMatrixClass.hpp.

const DVectorSlice DenseLinAlgPack::DMatrix::row ( size_type  i) const
inline

Definition at line 1061 of file DenseLinAlgPack_DMatrixClass.hpp.

DVectorSlice DenseLinAlgPack::DMatrix::col ( size_type  j)
inline

Return DVectorSlice object representing the jth column (1-based; 1,2,..,#this->cols()#)

Definition at line 1068 of file DenseLinAlgPack_DMatrixClass.hpp.

const DVectorSlice DenseLinAlgPack::DMatrix::col ( size_type  j) const
inline

Definition at line 1075 of file DenseLinAlgPack_DMatrixClass.hpp.

DVectorSlice DenseLinAlgPack::DMatrix::diag ( difference_type  k = 0)
inline

Definition at line 1082 of file DenseLinAlgPack_DMatrixClass.hpp.

const DVectorSlice DenseLinAlgPack::DMatrix::diag ( difference_type  k = 0) const
inline

Definition at line 1088 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrixSlice DenseLinAlgPack::DMatrix::operator() ( const Range1D I,
const Range1D J 
)
inline

Definition at line 1094 of file DenseLinAlgPack_DMatrixClass.hpp.

const DMatrixSlice DenseLinAlgPack::DMatrix::operator() ( const Range1D I,
const Range1D J 
) const
inline

Definition at line 1102 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrixSlice DenseLinAlgPack::DMatrix::operator() ( size_type  i1,
size_type  i2,
size_type  j1,
size_type  j2 
)
inline

Definition at line 1110 of file DenseLinAlgPack_DMatrixClass.hpp.

const DMatrixSlice DenseLinAlgPack::DMatrix::operator() ( size_type  i1,
size_type  i2,
size_type  j1,
size_type  j2 
) const
inline

Definition at line 1118 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrixSlice DenseLinAlgPack::DMatrix::operator() ( )
inline

Return a DMatrixSlice that represents this entire matrix.

Definition at line 1126 of file DenseLinAlgPack_DMatrixClass.hpp.

const DMatrixSlice DenseLinAlgPack::DMatrix::operator() ( ) const
inline

Definition at line 1132 of file DenseLinAlgPack_DMatrixClass.hpp.

DenseLinAlgPack::DMatrix::operator DMatrixSlice ( )
inline

Definition at line 1141 of file DenseLinAlgPack_DMatrixClass.hpp.

DenseLinAlgPack::DMatrix::operator const DMatrixSlice ( ) const
inline

Definition at line 1146 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix & DenseLinAlgPack::DMatrix::operator= ( value_type  rhs)
inline

Definition at line 1154 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix & DenseLinAlgPack::DMatrix::operator= ( const DMatrixSlice gms_rhs)
inline

Definition at line 1168 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix & DenseLinAlgPack::DMatrix::operator= ( const DMatrix rhs)
inline

Same as above. Needed to override the default assignment operator.

Definition at line 1161 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix::size_type DenseLinAlgPack::DMatrix::max_rows ( ) const
inline

Return the number of rows in the full matrix. Equivalent to BLAS LDA argument.

Definition at line 1177 of file DenseLinAlgPack_DMatrixClass.hpp.

DMatrix::value_type * DenseLinAlgPack::DMatrix::col_ptr ( size_type  j)
inline

Definition at line 1181 of file DenseLinAlgPack_DMatrixClass.hpp.

const DMatrix::value_type * DenseLinAlgPack::DMatrix::col_ptr ( size_type  j) const
inline

Same as above.

Definition at line 1193 of file DenseLinAlgPack_DMatrixClass.hpp.

void DenseLinAlgPack::DMatrix::validate_row_subscript ( size_type  i) const
private

Definition at line 173 of file DenseLinAlgPack_DMatrixClass.cpp.

void DenseLinAlgPack::DMatrix::validate_col_subscript ( size_type  j) const
private

Definition at line 180 of file DenseLinAlgPack_DMatrixClass.cpp.

DVectorSlice DenseLinAlgPack::DMatrix::p_diag ( difference_type  k) const
private

Definition at line 155 of file DenseLinAlgPack_DMatrixClass.cpp.

Member Data Documentation

std::valarray<value_type> DenseLinAlgPack::DMatrix::v_
private

Definition at line 622 of file DenseLinAlgPack_DMatrixClass.hpp.

size_type DenseLinAlgPack::DMatrix::rows_
private

Definition at line 623 of file DenseLinAlgPack_DMatrixClass.hpp.


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