Public Types | Public Member Functions | Private Member Functions | Private Attributes

MatrixType Class Reference

#include "MatrixType.h"

Collaboration diagram for MatrixType:
Collaboration graph
[legend]

List of all members.

Public Types

enum  matrix_type {
  Unknown = 0, Full, Diagonal, Permuted_Diagonal,
  Upper, Lower, Permuted_Upper, Permuted_Lower,
  Banded, Hermitian, Banded_Hermitian, Tridiagonal,
  Tridiagonal_Hermitian, Rectangular
}

Public Member Functions

 MatrixType (void)
 MatrixType (const MatrixType &a)
 MatrixType (const ComplexMatrix &a)
 MatrixType (const SparseComplexMatrix &a)
 MatrixType (const matrix_type t, bool _full=false)
 MatrixType (const FloatMatrix &a)
 MatrixType (const matrix_type t, const octave_idx_type np, const octave_idx_type *p, bool _full=false)
 MatrixType (const matrix_type t, const octave_idx_type ku, const octave_idx_type kl, bool _full=false)
 MatrixType (const Matrix &a)
 MatrixType (const FloatComplexMatrix &a)
 MatrixType (const SparseMatrix &a)
 ~MatrixType (void)
double band_density (void) const
void info (void) const
void invalidate_type (void)
bool is_banded (void)
bool is_dense (void) const
bool is_diagonal (void) const
bool is_hermitian (void) const
bool is_known (void) const
bool is_lower_triangular (void) const
bool is_rectangular (void) const
bool is_tridiagonal (void) const
bool is_unknown (void) const
bool is_upper_triangular (void) const
void mark_as_banded (const octave_idx_type ku, const octave_idx_type kl)
void mark_as_dense (void)
void mark_as_diagonal (void)
void mark_as_full (void)
void mark_as_lower_triangular (void)
void mark_as_not_dense (void)
void mark_as_permuted (const octave_idx_type np, const octave_idx_type *p)
void mark_as_permuted_diagonal (void)
void mark_as_rectangular (void)
void mark_as_symmetric (void)
void mark_as_tridiagonal (void)
void mark_as_unpermuted (void)
void mark_as_unsymmetric (void)
void mark_as_upper_triangular (void)
int nlower (void) const
int nupper (void) const
MatrixType & operator= (const MatrixType &a)
MatrixType transpose (void) const
octave_idx_type * triangular_perm (void) const
int type (const FloatMatrix &a)
int type (const ComplexMatrix &a)
int type (const Matrix &a)
int type (const SparseMatrix &a)
int type (bool quiet=true)
int type (const SparseComplexMatrix &a)
int type (const FloatComplexMatrix &a)

Private Member Functions

void type (int new_typ)

Private Attributes

double bandden
bool dense
bool full
octave_idx_type lower_band
octave_idx_type nperm
octave_idx_type * perm
double sp_bandden
matrix_type typ
octave_idx_type upper_band

Detailed Description

Definition at line 34 of file MatrixType.h.

Member Enumeration Documentation

enum MatrixType::matrix_type
Enumerator:
Unknown 
Full 
Diagonal 
Permuted_Diagonal 
Upper 
Lower 
Permuted_Upper 
Permuted_Lower 
Banded 
Hermitian 
Banded_Hermitian 
Tridiagonal 
Tridiagonal_Hermitian 
Rectangular 

Definition at line 39 of file MatrixType.h.

Constructor & Destructor Documentation

MatrixType::MatrixType ( void   ) 

Definition at line 41 of file MatrixType.cc.

MatrixType::MatrixType ( const MatrixType &  a  ) 

Definition at line 47 of file MatrixType.cc.

References nperm, and perm.

MatrixType::MatrixType ( const Matrix &  a  ) 

Definition at line 176 of file MatrixType.cc.

References matrix_real_probe(), and typ.

MatrixType::MatrixType ( const ComplexMatrix &  a  ) 

Definition at line 184 of file MatrixType.cc.

References matrix_complex_probe(), and typ.

MatrixType::MatrixType ( const FloatMatrix &  a  ) 

Definition at line 193 of file MatrixType.cc.

References matrix_real_probe(), and typ.

MatrixType::MatrixType ( const FloatComplexMatrix &  a  ) 

Definition at line 201 of file MatrixType.cc.

References matrix_complex_probe(), and typ.

MatrixType::MatrixType ( const SparseMatrix &  a  ) 

Definition at line 209 of file MatrixType.cc.

References bandden, Banded, Sparse< T >::cidx(), Sparse< T >::cols(), d, Sparse< T >::data(), dense, Full, octave_sparse_params::get_bandden(), octave_sparse_params::get_key(), Lower, lower_band, Sparse< T >::nnz(), nperm, OCTAVE_LOCAL_BUFFER, perm, Permuted_Diagonal, Permuted_Lower, Permuted_Upper, Sparse< T >::ridx(), Sparse< T >::rows(), singular(), sp_bandden, Tridiagonal, typ, Upper, and upper_band.

MatrixType::MatrixType ( const SparseComplexMatrix &  a  ) 

Definition at line 530 of file MatrixType.cc.

References bandden, Banded, Sparse< T >::cidx(), Sparse< T >::cols(), conj(), d, Sparse< T >::data(), dense, Full, octave_sparse_params::get_bandden(), octave_sparse_params::get_key(), Lower, lower_band, Sparse< T >::nnz(), norm(), nperm, OCTAVE_LOCAL_BUFFER, perm, Permuted_Diagonal, Permuted_Lower, Permuted_Upper, ColumnVector::real, Sparse< T >::ridx(), Sparse< T >::rows(), singular(), sp_bandden, Tridiagonal, typ, Upper, and upper_band.

MatrixType::MatrixType ( const matrix_type  t,
bool  _full = false 
)

Definition at line 851 of file MatrixType.cc.

References current_liboctave_warning_handler, Diagonal, Full, Lower, Permuted_Diagonal, Rectangular, Tridiagonal, Tridiagonal_Hermitian, typ, Unknown, and Upper.

MatrixType::MatrixType ( const matrix_type  t,
const octave_idx_type  np,
const octave_idx_type *  p,
bool  _full = false 
)

Definition at line 867 of file MatrixType.cc.

References current_liboctave_warning_handler, nperm, perm, Permuted_Lower, Permuted_Upper, and typ.

MatrixType::MatrixType ( const matrix_type  t,
const octave_idx_type  ku,
const octave_idx_type  kl,
bool  _full = false 
)

Definition at line 887 of file MatrixType.cc.

References Banded, Banded_Hermitian, current_liboctave_warning_handler, lower_band, typ, and upper_band.

MatrixType::~MatrixType ( void   ) 

Definition at line 904 of file MatrixType.cc.

References nperm, and perm.

Member Function Documentation

double MatrixType::band_density ( void   )  const [inline]

Definition at line 98 of file MatrixType.h.

void MatrixType::info ( void   )  const

Definition at line 1142 of file MatrixType.cc.

References bandden, Banded, Banded_Hermitian, Diagonal, Full, octave_sparse_params::get_key(), Hermitian, Lower, lower_band, Permuted_Diagonal, Permuted_Lower, Permuted_Upper, Rectangular, Tridiagonal, Tridiagonal_Hermitian, typ, Unknown, Upper, and upper_band.

Referenced by SparseMatrix::bsolve(), SparseComplexMatrix::bsolve(), SparseMatrix::dinverse(), SparseComplexMatrix::dinverse(), SparseMatrix::dsolve(), SparseComplexMatrix::dsolve(), SparseMatrix::fsolve(), SparseComplexMatrix::fsolve(), SparseMatrix::ltsolve(), SparseComplexMatrix::ltsolve(), SparseMatrix::tinverse(), SparseComplexMatrix::tinverse(), SparseMatrix::trisolve(), SparseComplexMatrix::trisolve(), SparseMatrix::utsolve(), and SparseComplexMatrix::utsolve().

void MatrixType::invalidate_type ( void   )  [inline]

Definition at line 135 of file MatrixType.h.

Referenced by octave_base_sparse< T >::assign(), DEFUN_DLD(), and octave_base_sparse< T >::delete_elements().

bool MatrixType::is_banded ( void   )  [inline]

Definition at line 115 of file MatrixType.h.

bool MatrixType::is_dense ( void   )  const [inline]

Definition at line 104 of file MatrixType.h.

Referenced by SparseMatrix::bsolve(), SparseComplexMatrix::bsolve(), SparseMatrix::trisolve(), and SparseComplexMatrix::trisolve().

bool MatrixType::is_diagonal ( void   )  const [inline]

Definition at line 106 of file MatrixType.h.

bool MatrixType::is_hermitian ( void   )  const [inline]

Definition at line 121 of file MatrixType.h.

Referenced by FloatMatrix::inverse(), FloatComplexMatrix::inverse(), SparseMatrix::inverse(), Matrix::inverse(), SparseComplexMatrix::inverse(), and ComplexMatrix::inverse().

bool MatrixType::is_known ( void   )  const [inline]

Definition at line 127 of file MatrixType.h.

bool MatrixType::is_lower_triangular ( void   )  const [inline]

Definition at line 112 of file MatrixType.h.

bool MatrixType::is_rectangular ( void   )  const [inline]

Definition at line 125 of file MatrixType.h.

bool MatrixType::is_tridiagonal ( void   )  const [inline]

Definition at line 118 of file MatrixType.h.

bool MatrixType::is_unknown ( void   )  const [inline]

Definition at line 129 of file MatrixType.h.

Referenced by DEFUN_DLD(), and do_sqrtm().

bool MatrixType::is_upper_triangular ( void   )  const [inline]

Definition at line 109 of file MatrixType.h.

void MatrixType::mark_as_banded ( const octave_idx_type  ku,
const octave_idx_type  kl 
) [inline]

Definition at line 147 of file MatrixType.h.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_dense ( void   )  [inline]

Definition at line 154 of file MatrixType.h.

void MatrixType::mark_as_diagonal ( void   )  [inline]

Definition at line 137 of file MatrixType.h.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_full ( void   )  [inline]

Definition at line 150 of file MatrixType.h.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_lower_triangular ( void   )  [inline]

Definition at line 143 of file MatrixType.h.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_not_dense ( void   )  [inline]

Definition at line 156 of file MatrixType.h.

void MatrixType::mark_as_permuted ( const octave_idx_type  np,
const octave_idx_type *  p 
)

Definition at line 1225 of file MatrixType.cc.

References current_liboctave_error_handler, Diagonal, Lower, nperm, perm, Permuted_Diagonal, Permuted_Lower, Permuted_Upper, typ, and Upper.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_permuted_diagonal ( void   )  [inline]

Definition at line 139 of file MatrixType.h.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_rectangular ( void   )  [inline]

Definition at line 152 of file MatrixType.h.

Referenced by SparseMatrix::bsolve(), SparseComplexMatrix::bsolve(), DEFUN_DLD(), FloatMatrix::finverse(), FloatComplexMatrix::finverse(), Matrix::finverse(), ComplexMatrix::finverse(), FloatMatrix::fsolve(), FloatComplexMatrix::fsolve(), SparseMatrix::fsolve(), Matrix::fsolve(), SparseComplexMatrix::fsolve(), ComplexMatrix::fsolve(), SparseMatrix::ltsolve(), SparseComplexMatrix::ltsolve(), FloatMatrix::rcond(), FloatComplexMatrix::rcond(), Matrix::rcond(), ComplexMatrix::rcond(), SparseMatrix::trisolve(), SparseComplexMatrix::trisolve(), SparseMatrix::utsolve(), and SparseComplexMatrix::utsolve().

void MatrixType::mark_as_symmetric ( void   ) 

Definition at line 1194 of file MatrixType.cc.

References Banded, Banded_Hermitian, current_liboctave_error_handler, Full, Hermitian, Tridiagonal, Tridiagonal_Hermitian, typ, and Unknown.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_tridiagonal ( void   )  [inline]

Definition at line 145 of file MatrixType.h.

Referenced by DEFUN_DLD().

void MatrixType::mark_as_unpermuted ( void   ) 

Definition at line 1244 of file MatrixType.cc.

References Diagonal, Lower, nperm, perm, Permuted_Diagonal, Permuted_Lower, Permuted_Upper, typ, and Upper.

void MatrixType::mark_as_unsymmetric ( void   ) 

Definition at line 1211 of file MatrixType.cc.

References Banded, Banded_Hermitian, Full, Hermitian, Tridiagonal, Tridiagonal_Hermitian, typ, and Unknown.

Referenced by SparseMatrix::bsolve(), SparseComplexMatrix::bsolve(), DEFBINOP(), FloatMatrix::determinant(), FloatComplexMatrix::determinant(), Matrix::determinant(), ComplexMatrix::determinant(), FloatMatrix::fsolve(), FloatComplexMatrix::fsolve(), SparseMatrix::fsolve(), Matrix::fsolve(), SparseComplexMatrix::fsolve(), ComplexMatrix::fsolve(), FloatMatrix::inverse(), FloatComplexMatrix::inverse(), SparseMatrix::inverse(), Matrix::inverse(), SparseComplexMatrix::inverse(), ComplexMatrix::inverse(), FloatMatrix::rcond(), FloatComplexMatrix::rcond(), Matrix::rcond(), ComplexMatrix::rcond(), SparseMatrix::trisolve(), and SparseComplexMatrix::trisolve().

void MatrixType::mark_as_upper_triangular ( void   )  [inline]

Definition at line 141 of file MatrixType.h.

Referenced by DEFUN_DLD().

int MatrixType::nlower ( void   )  const [inline]

Definition at line 102 of file MatrixType.h.

Referenced by SparseMatrix::bsolve(), and SparseComplexMatrix::bsolve().

int MatrixType::nupper ( void   )  const [inline]

Definition at line 100 of file MatrixType.h.

Referenced by SparseMatrix::bsolve(), and SparseComplexMatrix::bsolve().

MatrixType & MatrixType::operator= ( const MatrixType &  a  ) 

Definition at line 913 of file MatrixType.cc.

References bandden, dense, full, lower_band, nperm, perm, sp_bandden, typ, and upper_band.

MatrixType MatrixType::transpose ( void   )  const

Definition at line 1261 of file MatrixType.cc.

References Banded, Lower, lower_band, Permuted_Lower, Permuted_Upper, typ, Upper, and upper_band.

Referenced by SparseMatrix::inverse(), SparseComplexMatrix::inverse(), and xdiv().

octave_idx_type* MatrixType::triangular_perm ( void   )  const [inline]

Definition at line 133 of file MatrixType.h.

Referenced by SparseMatrix::ltsolve(), SparseComplexMatrix::ltsolve(), SparseMatrix::tinverse(), SparseComplexMatrix::tinverse(), SparseMatrix::utsolve(), and SparseComplexMatrix::utsolve().

void MatrixType::type ( int  new_typ  )  [inline, private]

Definition at line 169 of file MatrixType.h.

int MatrixType::type ( const SparseMatrix &  a  ) 

Definition at line 968 of file MatrixType.cc.

References bandden, dense, full, octave_sparse_params::get_bandden(), octave_sparse_params::get_key(), lower_band, nperm, perm, sp_bandden, typ, Unknown, and upper_band.

int MatrixType::type ( bool  quiet = true  ) 

Definition at line 944 of file MatrixType.cc.

References full, octave_sparse_params::get_bandden(), octave_sparse_params::get_key(), sp_bandden, typ, and Unknown.

Referenced by SparseMatrix::bsolve(), SparseComplexMatrix::bsolve(), chol2inv(), DEFUN_DLD(), FloatMatrix::determinant(), FloatComplexMatrix::determinant(), Matrix::determinant(), ComplexMatrix::determinant(), SparseMatrix::dinverse(), SparseComplexMatrix::dinverse(), do_sqrtm(), SparseMatrix::dsolve(), SparseComplexMatrix::dsolve(), FloatMatrix::fsolve(), FloatComplexMatrix::fsolve(), SparseMatrix::fsolve(), Matrix::fsolve(), SparseComplexMatrix::fsolve(), ComplexMatrix::fsolve(), FloatMatrix::inverse(), FloatComplexMatrix::inverse(), SparseMatrix::inverse(), Matrix::inverse(), SparseComplexMatrix::inverse(), ComplexMatrix::inverse(), FloatMatrix::ltsolve(), FloatComplexMatrix::ltsolve(), SparseMatrix::ltsolve(), Matrix::ltsolve(), SparseComplexMatrix::ltsolve(), ComplexMatrix::ltsolve(), FloatMatrix::rcond(), FloatComplexMatrix::rcond(), Matrix::rcond(), ComplexMatrix::rcond(), FloatMatrix::solve(), FloatComplexMatrix::solve(), SparseMatrix::solve(), Matrix::solve(), SparseComplexMatrix::solve(), ComplexMatrix::solve(), FloatMatrix::tinverse(), FloatComplexMatrix::tinverse(), SparseMatrix::tinverse(), Matrix::tinverse(), SparseComplexMatrix::tinverse(), ComplexMatrix::tinverse(), SparseMatrix::trisolve(), SparseComplexMatrix::trisolve(), FloatMatrix::utsolve(), FloatComplexMatrix::utsolve(), SparseMatrix::utsolve(), Matrix::utsolve(), SparseComplexMatrix::utsolve(), and ComplexMatrix::utsolve().

int MatrixType::type ( const ComplexMatrix &  a  ) 

Definition at line 1061 of file MatrixType.cc.

References full, octave_sparse_params::get_key(), nperm, perm, typ, and Unknown.

int MatrixType::type ( const Matrix &  a  ) 

Definition at line 1034 of file MatrixType.cc.

References full, octave_sparse_params::get_key(), nperm, perm, typ, and Unknown.

int MatrixType::type ( const FloatComplexMatrix &  a  ) 

Definition at line 1115 of file MatrixType.cc.

References full, octave_sparse_params::get_key(), nperm, perm, typ, and Unknown.

int MatrixType::type ( const SparseComplexMatrix &  a  ) 

Definition at line 1001 of file MatrixType.cc.

References bandden, dense, full, octave_sparse_params::get_bandden(), octave_sparse_params::get_key(), lower_band, nperm, perm, sp_bandden, typ, Unknown, and upper_band.

int MatrixType::type ( const FloatMatrix &  a  ) 

Definition at line 1088 of file MatrixType.cc.

References full, octave_sparse_params::get_key(), nperm, perm, typ, and Unknown.

Member Data Documentation

double MatrixType::bandden [private]

Definition at line 173 of file MatrixType.h.

Referenced by info(), MatrixType(), operator=(), and type().

bool MatrixType::dense [private]

Definition at line 176 of file MatrixType.h.

Referenced by MatrixType(), operator=(), and type().

bool MatrixType::full [private]

Definition at line 177 of file MatrixType.h.

Referenced by operator=(), and type().

octave_idx_type MatrixType::lower_band [private]

Definition at line 175 of file MatrixType.h.

Referenced by info(), MatrixType(), operator=(), transpose(), and type().

octave_idx_type MatrixType::nperm [private]

Definition at line 178 of file MatrixType.h.

Referenced by mark_as_permuted(), mark_as_unpermuted(), MatrixType(), operator=(), type(), and ~MatrixType().

octave_idx_type* MatrixType::perm [private]

Definition at line 179 of file MatrixType.h.

Referenced by mark_as_permuted(), mark_as_unpermuted(), MatrixType(), operator=(), type(), and ~MatrixType().

double MatrixType::sp_bandden [private]

Definition at line 172 of file MatrixType.h.

Referenced by MatrixType(), operator=(), and type().

matrix_type MatrixType::typ [private]

Definition at line 171 of file MatrixType.h.

Referenced by info(), mark_as_permuted(), mark_as_symmetric(), mark_as_unpermuted(), mark_as_unsymmetric(), MatrixType(), operator=(), transpose(), and type().

octave_idx_type MatrixType::upper_band [private]

Definition at line 174 of file MatrixType.h.

Referenced by info(), MatrixType(), operator=(), transpose(), and type().

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Mar 7 2013 16:04:02 for GNU Octave by  doxygen 1.7.1