GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
MatrixType Class Reference

#include "MatrixType.h"

Collaboration diagram for MatrixType:
Collaboration graph
[legend]

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 Matrix &a)
 
 MatrixType (const ComplexMatrix &a)
 
 MatrixType (const FloatMatrix &a)
 
 MatrixType (const FloatComplexMatrix &a)
 
template<typename T >
 MatrixType (const MSparse< T > &a)
 
 MatrixType (const matrix_type t, bool _full=false)
 
 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 (void)
 
double band_density (void) const
 
void info (void) const
 
void invalidate_type (void)
 
bool is_banded (void) const
 
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
 
bool isbanded (void) const
 
bool isdiag (void) const
 
bool ishermitian (void) const
 
bool istril (void) const
 
bool istriu (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 (bool quiet=true)
 
int type (const Matrix &a)
 
int type (const ComplexMatrix &a)
 
int type (const FloatMatrix &a)
 
int type (const FloatComplexMatrix &a)
 
int type (const SparseMatrix &a)
 
int type (const SparseComplexMatrix &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 38 of file MatrixType.h.

Member Enumeration Documentation

◆ matrix_type

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 43 of file MatrixType.h.

Constructor & Destructor Documentation

◆ MatrixType() [1/10]

MatrixType::MatrixType ( void  )

Definition at line 64 of file MatrixType.cc.

◆ MatrixType() [2/10]

MatrixType::MatrixType ( const MatrixType &  a)

Definition at line 70 of file MatrixType.cc.

References a, i, nperm, and perm.

◆ MatrixType() [3/10]

MatrixType::MatrixType ( const Matrix &  a)

Definition at line 200 of file MatrixType.cc.

References a, matrix_real_probe(), and typ.

◆ MatrixType() [4/10]

MatrixType::MatrixType ( const ComplexMatrix &  a)

Definition at line 208 of file MatrixType.cc.

References a, matrix_complex_probe(), and typ.

◆ MatrixType() [5/10]

MatrixType::MatrixType ( const FloatMatrix &  a)

Definition at line 216 of file MatrixType.cc.

References a, matrix_real_probe(), and typ.

◆ MatrixType() [6/10]

MatrixType::MatrixType ( const FloatComplexMatrix &  a)

Definition at line 224 of file MatrixType.cc.

References a, matrix_complex_probe(), and typ.

◆ MatrixType() [7/10]

template<typename T >
MatrixType::MatrixType ( const MSparse< T > &  a)

Definition at line 234 of file MatrixType.cc.

References a, bandden, Banded, Banded_Hermitian, octave::math::conj(), d, dense, Array< T >::diag(), Diagonal, found, Full, octave_sparse_params::get_bandden(), octave_sparse_params::get_key(), Hermitian, i, imag(), k, Lower, lower_band, nm, Array< T >::nnz(), norm(), nperm, OCTAVE_LOCAL_BUFFER, perm, Permuted_Diagonal, Permuted_Lower, Permuted_Upper, real(), Rectangular, sp_bandden, tmp, Tridiagonal, Tridiagonal_Hermitian, typ, Upper, upper_band, and warn_calculating_sparse_type().

◆ MatrixType() [8/10]

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

Definition at line 557 of file MatrixType.cc.

References Diagonal, Full, Lower, Permuted_Diagonal, Rectangular, t, Tridiagonal, Tridiagonal_Hermitian, typ, Unknown, Upper, and warn_invalid().

◆ MatrixType() [9/10]

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

Definition at line 573 of file MatrixType.cc.

References i, nperm, p, perm, Permuted_Lower, Permuted_Upper, t, typ, and warn_invalid().

◆ MatrixType() [10/10]

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

Definition at line 593 of file MatrixType.cc.

References Banded, Banded_Hermitian, lower_band, t, typ, upper_band, and warn_invalid().

◆ ~MatrixType()

MatrixType::~MatrixType ( void  )

Definition at line 610 of file MatrixType.cc.

References nperm, and perm.

Member Function Documentation

◆ band_density()

double MatrixType::band_density ( void  ) const
inline

Definition at line 102 of file MatrixType.h.

◆ info()

void MatrixType::info ( void  ) const

Definition at line 840 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().

◆ invalidate_type()

void MatrixType::invalidate_type ( void  )
inline

Definition at line 161 of file MatrixType.h.

◆ is_banded()

bool MatrixType::is_banded ( void  ) const
inline

Definition at line 135 of file MatrixType.h.

◆ is_dense()

bool MatrixType::is_dense ( void  ) const
inline

Definition at line 108 of file MatrixType.h.

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

◆ is_diagonal()

bool MatrixType::is_diagonal ( void  ) const
inline

Definition at line 114 of file MatrixType.h.

◆ is_hermitian()

bool MatrixType::is_hermitian ( void  ) const
inline

Definition at line 148 of file MatrixType.h.

References SparseComplexMatrix::ishermitian().

◆ is_known()

bool MatrixType::is_known ( void  ) const
inline

Definition at line 153 of file MatrixType.h.

◆ is_lower_triangular()

bool MatrixType::is_lower_triangular ( void  ) const
inline

Definition at line 128 of file MatrixType.h.

◆ is_rectangular()

bool MatrixType::is_rectangular ( void  ) const
inline

Definition at line 151 of file MatrixType.h.

◆ is_tridiagonal()

bool MatrixType::is_tridiagonal ( void  ) const
inline

Definition at line 138 of file MatrixType.h.

◆ is_unknown()

bool MatrixType::is_unknown ( void  ) const
inline

Definition at line 155 of file MatrixType.h.

Referenced by do_sqrtm().

◆ is_upper_triangular()

bool MatrixType::is_upper_triangular ( void  ) const
inline

Definition at line 121 of file MatrixType.h.

◆ isbanded()

bool MatrixType::isbanded ( void  ) const
inline

Definition at line 131 of file MatrixType.h.

◆ isdiag()

bool MatrixType::isdiag ( void  ) const
inline

Definition at line 110 of file MatrixType.h.

◆ ishermitian()

bool MatrixType::ishermitian ( void  ) const
inline

Definition at line 141 of file MatrixType.h.

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

◆ istril()

bool MatrixType::istril ( void  ) const
inline

Definition at line 124 of file MatrixType.h.

◆ istriu()

bool MatrixType::istriu ( void  ) const
inline

Definition at line 117 of file MatrixType.h.

◆ mark_as_banded()

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

Definition at line 173 of file MatrixType.h.

◆ mark_as_dense()

void MatrixType::mark_as_dense ( void  )
inline

Definition at line 180 of file MatrixType.h.

◆ mark_as_diagonal()

void MatrixType::mark_as_diagonal ( void  )
inline

Definition at line 163 of file MatrixType.h.

◆ mark_as_full()

void MatrixType::mark_as_full ( void  )
inline

Definition at line 176 of file MatrixType.h.

Referenced by ComplexMatrix::fsolve(), and FloatComplexMatrix::fsolve().

◆ mark_as_lower_triangular()

void MatrixType::mark_as_lower_triangular ( void  )
inline

Definition at line 169 of file MatrixType.h.

◆ mark_as_not_dense()

void MatrixType::mark_as_not_dense ( void  )
inline

Definition at line 182 of file MatrixType.h.

◆ mark_as_permuted()

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

Definition at line 924 of file MatrixType.cc.

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

◆ mark_as_permuted_diagonal()

void MatrixType::mark_as_permuted_diagonal ( void  )
inline

Definition at line 165 of file MatrixType.h.

◆ mark_as_rectangular()

void MatrixType::mark_as_rectangular ( void  )
inline

Definition at line 178 of file MatrixType.h.

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

◆ mark_as_symmetric()

void MatrixType::mark_as_symmetric ( void  )

Definition at line 895 of file MatrixType.cc.

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

◆ mark_as_tridiagonal()

void MatrixType::mark_as_tridiagonal ( void  )
inline

Definition at line 171 of file MatrixType.h.

◆ mark_as_unpermuted()

void MatrixType::mark_as_unpermuted ( void  )

Definition at line 944 of file MatrixType.cc.

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

◆ mark_as_unsymmetric()

void MatrixType::mark_as_unsymmetric ( void  )

Definition at line 911 of file MatrixType.cc.

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

Referenced by SparseMatrix::bsolve(), SparseComplexMatrix::bsolve(), Matrix::determinant(), FloatMatrix::determinant(), ComplexMatrix::determinant(), FloatComplexMatrix::determinant(), Matrix::fsolve(), FloatMatrix::fsolve(), ComplexMatrix::fsolve(), FloatComplexMatrix::fsolve(), SparseMatrix::fsolve(), SparseComplexMatrix::fsolve(), SparseMatrix::inverse(), SparseComplexMatrix::inverse(), Matrix::inverse(), FloatMatrix::inverse(), ComplexMatrix::inverse(), FloatComplexMatrix::inverse(), oct_binop_mul_cdm_scm(), oct_binop_mul_cdm_sm(), oct_binop_mul_dm_scm(), oct_binop_mul_dm_sm(), oct_binop_mul_scm_cdm(), oct_binop_mul_scm_dm(), oct_binop_mul_sm_cdm(), oct_binop_mul_sm_dm(), Matrix::rcond(), FloatMatrix::rcond(), ComplexMatrix::rcond(), FloatComplexMatrix::rcond(), SparseMatrix::trisolve(), and SparseComplexMatrix::trisolve().

◆ mark_as_upper_triangular()

void MatrixType::mark_as_upper_triangular ( void  )
inline

Definition at line 167 of file MatrixType.h.

◆ nlower()

int MatrixType::nlower ( void  ) const
inline

Definition at line 106 of file MatrixType.h.

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

◆ nupper()

int MatrixType::nupper ( void  ) const
inline

Definition at line 104 of file MatrixType.h.

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

◆ operator=()

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

Definition at line 619 of file MatrixType.cc.

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

◆ transpose()

MatrixType MatrixType::transpose ( void  ) const

Definition at line 961 of file MatrixType.cc.

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

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

◆ triangular_perm()

octave_idx_type* MatrixType::triangular_perm ( void  ) const
inline

Definition at line 159 of file MatrixType.h.

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

◆ type() [1/8]

int MatrixType::type ( bool  quiet = true)

Definition at line 650 of file MatrixType.cc.

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

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

◆ type() [2/8]

int MatrixType::type ( const Matrix &  a)

Definition at line 736 of file MatrixType.cc.

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

◆ type() [3/8]

int MatrixType::type ( const ComplexMatrix &  a)

Definition at line 762 of file MatrixType.cc.

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

◆ type() [4/8]

int MatrixType::type ( const FloatMatrix &  a)

Definition at line 788 of file MatrixType.cc.

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

◆ type() [5/8]

int MatrixType::type ( const FloatComplexMatrix &  a)

Definition at line 814 of file MatrixType.cc.

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

◆ type() [6/8]

int MatrixType::type ( const SparseMatrix &  a)

Definition at line 672 of file MatrixType.cc.

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

◆ type() [7/8]

int MatrixType::type ( const SparseComplexMatrix &  a)

Definition at line 704 of file MatrixType.cc.

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

◆ type() [8/8]

void MatrixType::type ( int  new_typ)
inlineprivate

Definition at line 195 of file MatrixType.h.

Member Data Documentation

◆ bandden

double MatrixType::bandden
private

Definition at line 199 of file MatrixType.h.

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

◆ dense

bool MatrixType::dense
private

Definition at line 202 of file MatrixType.h.

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

◆ full

bool MatrixType::full
private

Definition at line 203 of file MatrixType.h.

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

◆ lower_band

octave_idx_type MatrixType::lower_band
private

Definition at line 201 of file MatrixType.h.

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

◆ nperm

octave_idx_type MatrixType::nperm
private

Definition at line 204 of file MatrixType.h.

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

◆ perm

octave_idx_type* MatrixType::perm
private

Definition at line 205 of file MatrixType.h.

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

◆ sp_bandden

double MatrixType::sp_bandden
private

Definition at line 198 of file MatrixType.h.

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

◆ typ

matrix_type MatrixType::typ
private

Definition at line 197 of file MatrixType.h.

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

◆ upper_band

octave_idx_type MatrixType::upper_band
private

Definition at line 200 of file MatrixType.h.

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

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