GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
sparse_lu< lu_type > Class Template Reference

#include "sparse-lu.h"

Collaboration diagram for sparse_lu< lu_type >:

Public Types

typedef lu_type::element_type lu_elt_type
 

Public Member Functions

OCTAVE_API sparse_lu (const lu_type &a, const ColumnVector &Qinit, const Matrix &piv_thres, bool scale=false, bool FixedQ=false, double droptol=-1.0, bool milu=false, bool udiag=false)
 
OCTAVE_API sparse_lu (const lu_type &a, const Matrix &piv_thres=Matrix(), bool scale=false)
 
 sparse_lu (const sparse_lu &a)
 
 sparse_lu (void)
 
virtual ~sparse_lu (void)=default
 
const octave_idx_typecol_perm (void) const
 
lu_type L (void) const
 
sparse_luoperator= (const sparse_lu &a)
 
OCTAVE_API SparseMatrix Pc (void) const
 
OCTAVE_API PermMatrix Pc_mat (void) const
 
OCTAVE_API ColumnVector Pc_vec (void) const
 
OCTAVE_API SparseMatrix Pr (void) const
 
OCTAVE_API PermMatrix Pr_mat (void) const
 
OCTAVE_API ColumnVector Pr_vec (void) const
 
SparseMatrix R (void) const
 
double rcond (void) const
 
const octave_idx_typerow_perm (void) const
 
lu_type U (void) const
 
OCTAVE_API lu_type Y (void) const
 

Protected Attributes

double m_cond
 
lu_type m_L
 
MArray< octave_idx_typem_P
 
MArray< octave_idx_typem_Q
 
SparseMatrix m_R
 
lu_type m_U
 

Detailed Description

template<typename lu_type>
class sparse_lu< lu_type >

Definition at line 47 of file sparse-lu.h.

Member Typedef Documentation

◆ lu_elt_type

template<typename lu_type >
typedef lu_type::element_type sparse_lu< lu_type >::lu_elt_type

Definition at line 53 of file sparse-lu.h.

Constructor & Destructor Documentation

◆ sparse_lu() [1/4]

template<typename lu_type >
sparse_lu< lu_type >::sparse_lu ( void  )
inline

Definition at line 55 of file sparse-lu.h.

◆ sparse_lu() [2/4]

◆ sparse_lu() [3/4]

template<typename lu_type >
sparse_lu< lu_type >::sparse_lu ( const lu_type &  a,
const ColumnVector Qinit,
const Matrix piv_thres,
bool  scale = false,
bool  FixedQ = false,
double  droptol = -1.0,
bool  milu = false,
bool  udiag = false 
)

◆ sparse_lu() [4/4]

template<typename lu_type >
sparse_lu< lu_type >::sparse_lu ( const sparse_lu< lu_type > &  a)
inline

Definition at line 68 of file sparse-lu.h.

◆ ~sparse_lu()

template<typename lu_type >
virtual sparse_lu< lu_type >::~sparse_lu ( void  )
virtualdefault

Member Function Documentation

◆ col_perm()

template<typename lu_type >
const octave_idx_type* sparse_lu< lu_type >::col_perm ( void  ) const
inline

Definition at line 111 of file sparse-lu.h.

◆ L()

template<typename lu_type >
lu_type sparse_lu< lu_type >::L ( void  ) const
inline

Definition at line 89 of file sparse-lu.h.

◆ operator=()

template<typename lu_type >
sparse_lu& sparse_lu< lu_type >::operator= ( const sparse_lu< lu_type > &  a)
inline

◆ Pc()

template<typename lu_type >
SparseMatrix sparse_lu< lu_type >::Pc ( void  ) const

◆ Pc_mat()

template<typename lu_type >
PermMatrix sparse_lu< lu_type >::Pc_mat ( void  ) const

Definition at line 978 of file sparse-lu.cc.

References PermMatrix.

◆ Pc_vec()

template<typename lu_type >
ColumnVector sparse_lu< lu_type >::Pc_vec ( void  ) const

Definition at line 964 of file sparse-lu.cc.

References Array< T, Alloc >::xelem().

◆ Pr()

template<typename lu_type >
SparseMatrix sparse_lu< lu_type >::Pr ( void  ) const

◆ Pr_mat()

template<typename lu_type >
PermMatrix sparse_lu< lu_type >::Pr_mat ( void  ) const

Definition at line 937 of file sparse-lu.cc.

References PermMatrix.

◆ Pr_vec()

template<typename lu_type >
ColumnVector sparse_lu< lu_type >::Pr_vec ( void  ) const

Definition at line 923 of file sparse-lu.cc.

References Array< T, Alloc >::xelem().

◆ R()

template<typename lu_type >
SparseMatrix sparse_lu< lu_type >::R ( void  ) const
inline

Definition at line 93 of file sparse-lu.h.

◆ rcond()

template<typename lu_type >
double sparse_lu< lu_type >::rcond ( void  ) const
inline

Definition at line 113 of file sparse-lu.h.

◆ row_perm()

template<typename lu_type >
const octave_idx_type* sparse_lu< lu_type >::row_perm ( void  ) const
inline

Definition at line 109 of file sparse-lu.h.

◆ U()

template<typename lu_type >
lu_type sparse_lu< lu_type >::U ( void  ) const
inline

Definition at line 91 of file sparse-lu.h.

◆ Y()

template<typename lu_type >
lu_type sparse_lu< lu_type >::Y ( void  ) const

Definition at line 866 of file sparse-lu.cc.

Member Data Documentation

◆ m_cond

template<typename lu_type >
double sparse_lu< lu_type >::m_cond
protected

◆ m_L

template<typename lu_type >
lu_type sparse_lu< lu_type >::m_L
protected

◆ m_P

template<typename lu_type >
MArray<octave_idx_type> sparse_lu< lu_type >::m_P
protected

◆ m_Q

template<typename lu_type >
MArray<octave_idx_type> sparse_lu< lu_type >::m_Q
protected

◆ m_R

template<typename lu_type >
SparseMatrix sparse_lu< lu_type >::m_R
protected

Definition at line 119 of file sparse-lu.h.

Referenced by sparse_lu< lu_type >::sparse_lu().

◆ m_U

template<typename lu_type >
lu_type sparse_lu< lu_type >::m_U
protected

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