sparse_lu< lu_type > Class Template Reference

#include "sparse-lu.h"

Public Types
typedef lu_type::element_type	lu_elt_type

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

Protected Attributes
double	m_cond
lu_type	m_L
MArray< octave_idx_type >	m_P
MArray< octave_idx_type >	m_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 ( )

inline

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

sparse_lu() [2/4]

template<typename lu_type >

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 Sparse< T, Alloc >::data(), Array< T, Alloc >::fortran_vec(), sparse_params::get_key(), isnan(), sparse_lu< lu_type >::m_cond, sparse_lu< lu_type >::m_L, sparse_lu< lu_type >::m_P, sparse_lu< lu_type >::m_Q, sparse_lu< lu_type >::m_R, sparse_lu< lu_type >::m_U, Array< T, Alloc >::numel(), Array< T, Alloc >::resize(), scale(), Sparse< T, Alloc >::xcidx(), and Sparse< T, Alloc >::xridx().

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
	)

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

References Sparse< T, Alloc >::data(), Array< T, Alloc >::fortran_vec(), sparse_params::get_key(), isnan(), sparse_lu< lu_type >::m_cond, sparse_lu< lu_type >::m_L, sparse_lu< lu_type >::m_P, sparse_lu< lu_type >::m_Q, sparse_lu< lu_type >::m_R, sparse_lu< lu_type >::m_U, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, Array< T, Alloc >::resize(), scale(), Sparse< T, Alloc >::xcidx(), and Sparse< T, Alloc >::xridx().

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 ( )

virtualdefault

Member Function Documentation

col_perm()

template<typename lu_type >

const octave_idx_type* sparse_lu< lu_type >::col_perm ( ) const

inline

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

L()

template<typename lu_type >

lu_type sparse_lu< lu_type >::L ( ) 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

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

References sparse_lu< lu_type >::m_cond, sparse_lu< lu_type >::m_L, sparse_lu< lu_type >::m_P, sparse_lu< lu_type >::m_Q, and sparse_lu< lu_type >::m_U.

Pc()

template<typename lu_type >

SparseMatrix sparse_lu< lu_type >::Pc

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

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

Pc_mat()

template<typename lu_type >

PermMatrix sparse_lu< lu_type >::Pc_mat

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

Pc_vec()

template<typename lu_type >

ColumnVector sparse_lu< lu_type >::Pc_vec

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

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

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

Pr_mat()

template<typename lu_type >

PermMatrix sparse_lu< lu_type >::Pr_mat

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

Pr_vec()

template<typename lu_type >

ColumnVector sparse_lu< lu_type >::Pr_vec

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 ( ) const

inline

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

rcond()

template<typename lu_type >

double sparse_lu< lu_type >::rcond ( ) 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 ( ) const

inline

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

U()

template<typename lu_type >

lu_type sparse_lu< lu_type >::U ( ) const

inline

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

Y()

template<typename lu_type >

lu_type sparse_lu< lu_type >::Y

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

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

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

m_L

template<typename lu_type >

lu_type sparse_lu< lu_type >::m_L

protected

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

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

m_P

template<typename lu_type >

MArray<octave_idx_type> sparse_lu< lu_type >::m_P

protected

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

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

m_Q

template<typename lu_type >

MArray<octave_idx_type> sparse_lu< lu_type >::m_Q

protected

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

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

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

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

Referenced by sparse_lu< lu_type >::sparse_lu(), and 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