octave::math::sparse_lu< lu_type > Class Template Reference

#include "sparse-lu.h"

Collaboration diagram for octave::math::sparse_lu< lu_type >:

Public Types
typedef lu_type::element_type	lu_elt_type

Public Member Functions
	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 (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_type *	col_perm (void) const
lu_type	L (void) const
sparse_lu &	operator= (const sparse_lu &a)
SparseMatrix	Pc (void) const
PermMatrix	Pc_mat (void) const
ColumnVector	Pc_vec (void) const
SparseMatrix	Pr (void) const
PermMatrix	Pr_mat (void) const
ColumnVector	Pr_vec (void) const
SparseMatrix	R (void) const
double	rcond (void) const
const octave_idx_type *	row_perm (void) const
lu_type	U (void) const
lu_type	Y (void) const

Protected Attributes
double	cond
lu_type	Lfact
MArray< octave_idx_type >	P
MArray< octave_idx_type >	Q
SparseMatrix	Rfact
lu_type	Ufact

Detailed Description

template<typename lu_type>
class octave::math::sparse_lu< lu_type >

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

Member Typedef Documentation

lu_elt_type

template<typename lu_type >

typedef lu_type::element_type octave::math::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 >

octave::math::sparse_lu< lu_type >::sparse_lu ( void  )

inline

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

sparse_lu() [2/4]

template<typename lu_type >

octave::math::sparse_lu< lu_type >::sparse_lu	(	const lu_type &	a,
		const Matrix &	piv_thres = Matrix (),
		bool	scale = false
	)

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

References octave::math::sparse_lu< lu_type >::cond, Sparse< T >::data(), Array< T >::fortran_vec(), octave_sparse_params::get_key(), octave::math::isnan(), octave::math::sparse_lu< lu_type >::Lfact, Array< T >::numel(), octave::math::sparse_lu< lu_type >::P, octave::math::sparse_lu< lu_type >::Q, Array< T >::resize(), octave::math::sparse_lu< lu_type >::Rfact, scale(), octave::math::sparse_lu< lu_type >::Ufact, Sparse< T >::xcidx(), and Sparse< T >::xridx().

sparse_lu() [3/4]

template<typename lu_type >

octave::math::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
	)

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

References octave::math::sparse_lu< lu_type >::cond, Sparse< T >::data(), Array< T >::fortran_vec(), octave_sparse_params::get_key(), octave::math::isnan(), octave::math::sparse_lu< lu_type >::Lfact, Array< T >::numel(), OCTAVE_LOCAL_BUFFER, octave::math::sparse_lu< lu_type >::P, octave::math::sparse_lu< lu_type >::Q, Array< T >::resize(), octave::math::sparse_lu< lu_type >::Rfact, scale(), octave::math::sparse_lu< lu_type >::Ufact, Sparse< T >::xcidx(), and Sparse< T >::xridx().

sparse_lu() [4/4]

template<typename lu_type >

octave::math::sparse_lu< lu_type >::sparse_lu ( const sparse_lu< lu_type > &  a )

inline

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

~sparse_lu()

template<typename lu_type >

virtual octave::math::sparse_lu< lu_type >::~sparse_lu ( void  )

virtualdefault

Member Function Documentation

col_perm()

template<typename lu_type >

const octave_idx_type* octave::math::sparse_lu< lu_type >::col_perm ( void  ) const

inline

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

References Q.

Referenced by Flu(), and LuAminusSigmaB().

L()

template<typename lu_type >

lu_type octave::math::sparse_lu< lu_type >::L ( void  ) const

inline

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

Referenced by Flu(), SparseComplexMatrix::inverse(), SparseMatrix::inverse(), and LuAminusSigmaB().

operator=()

template<typename lu_type >

sparse_lu& octave::math::sparse_lu< lu_type >::operator= ( const sparse_lu< lu_type > &  a )

inline

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

References octave::math::sparse_lu< lu_type >::cond, octave::math::sparse_lu< lu_type >::Lfact, octave::math::sparse_lu< lu_type >::P, Q, octave::math::sparse_lu< lu_type >::Q, and octave::math::sparse_lu< lu_type >::Ufact.

Pc()

template<typename lu_type >

SparseMatrix octave::math::sparse_lu< lu_type >::Pc

(

void

)

const

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

References Sparse< T >::cidx(), Sparse< T >::data(), Q, and Sparse< T >::ridx().

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

Pc_mat()

template<typename lu_type >

PermMatrix octave::math::sparse_lu< lu_type >::Pc_mat

(

void

)

const

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

References Q.

Referenced by Flu().

Pc_vec()

template<typename lu_type >

ColumnVector octave::math::sparse_lu< lu_type >::Pc_vec

(

void

)

const

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

References Q, and Array< T >::xelem().

Referenced by Flu().

Pr()

template<typename lu_type >

SparseMatrix octave::math::sparse_lu< lu_type >::Pr

(

void

)

const

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

References Sparse< T >::cidx(), Sparse< T >::data(), and Sparse< T >::ridx().

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

Pr_mat()

template<typename lu_type >

PermMatrix octave::math::sparse_lu< lu_type >::Pr_mat

(

void

)

const

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

Referenced by Flu().

Pr_vec()

template<typename lu_type >

ColumnVector octave::math::sparse_lu< lu_type >::Pr_vec

(

void

)

const

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

References Array< T >::xelem().

Referenced by Flu().

R()

template<typename lu_type >

SparseMatrix octave::math::sparse_lu< lu_type >::R ( void  ) const

inline

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

Referenced by Flu(), and LuAminusSigmaB().

rcond()

template<typename lu_type >

double octave::math::sparse_lu< lu_type >::rcond ( void  ) const

inline

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

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

row_perm()

template<typename lu_type >

const octave_idx_type* octave::math::sparse_lu< lu_type >::row_perm ( void  ) const

inline

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

Referenced by Flu(), and LuAminusSigmaB().

U()

template<typename lu_type >

lu_type octave::math::sparse_lu< lu_type >::U ( void  ) const

inline

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

Referenced by Flu(), SparseComplexMatrix::inverse(), SparseMatrix::inverse(), and LuAminusSigmaB().

Y()

template<typename lu_type >

lu_type octave::math::sparse_lu< lu_type >::Y

(

void

)

const

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

Referenced by Flu().

Member Data Documentation

cond

template<typename lu_type >

double octave::math::sparse_lu< lu_type >::cond

protected

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

Referenced by octave::math::sparse_lu< lu_type >::sparse_lu(), and octave::math::sparse_lu< lu_type >::operator=().

Lfact

template<typename lu_type >

lu_type octave::math::sparse_lu< lu_type >::Lfact

protected

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

Referenced by octave::math::sparse_lu< lu_type >::sparse_lu(), and octave::math::sparse_lu< lu_type >::operator=().

P

template<typename lu_type >

MArray<octave_idx_type> octave::math::sparse_lu< lu_type >::P

protected

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

Referenced by octave::math::sparse_lu< lu_type >::sparse_lu(), and octave::math::sparse_lu< lu_type >::operator=().

Q

template<typename lu_type >

MArray<octave_idx_type> octave::math::sparse_lu< lu_type >::Q

protected

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

Referenced by octave::math::sparse_lu< lu_type >::sparse_lu(), and octave::math::sparse_lu< lu_type >::operator=().

Rfact

template<typename lu_type >

SparseMatrix octave::math::sparse_lu< lu_type >::Rfact

protected

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

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

Ufact

template<typename lu_type >

lu_type octave::math::sparse_lu< lu_type >::Ufact

protected

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

Referenced by octave::math::sparse_lu< lu_type >::sparse_lu(), and octave::math::sparse_lu< lu_type >::operator=().

---

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

• liboctave/numeric/sparse-lu.h
• liboctave/numeric/sparse-lu.cc