GNU Octave  8.1.0
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
chol< T > Class Template Reference

#include "chol.h"

Collaboration diagram for chol< T >:
Collaboration graph
[legend]

Public Types

typedef T::real_elt_type COND_T
 
typedef T::column_vector_type VT
 

Public Member Functions

 chol (const chol &a)
 
 chol (const T &a, bool upper=true, bool calc_cond=false)
 
 chol (const T &a, octave_idx_type &info, bool upper=true, bool calc_cond=false)
 
 chol (void)
 
T chol_matrix (void) const
 
OCTAVE_API void delete_sym (octave_idx_type j)
 
OCTAVE_API void delete_sym (octave_idx_type j_arg)
 
OCTAVE_API void delete_sym (octave_idx_type j_arg)
 
OCTAVE_API void delete_sym (octave_idx_type j_arg)
 
OCTAVE_API void delete_sym (octave_idx_type j_arg)
 
OCTAVE_API octave_idx_type downdate (const ColumnVector &u)
 
OCTAVE_API octave_idx_type downdate (const ComplexColumnVector &u)
 
OCTAVE_API octave_idx_type downdate (const FloatColumnVector &u)
 
OCTAVE_API octave_idx_type downdate (const FloatComplexColumnVector &u)
 
OCTAVE_API octave_idx_type downdate (const VT &u)
 
OCTAVE_API octave_idx_type insert_sym (const ColumnVector &u, octave_idx_type j_arg)
 
OCTAVE_API octave_idx_type insert_sym (const ComplexColumnVector &u, octave_idx_type j_arg)
 
OCTAVE_API octave_idx_type insert_sym (const FloatColumnVector &u, octave_idx_type j_arg)
 
OCTAVE_API octave_idx_type insert_sym (const FloatComplexColumnVector &u, octave_idx_type j_arg)
 
OCTAVE_API octave_idx_type insert_sym (const VT &u, octave_idx_type j)
 
OCTAVE_API T inverse (void) const
 
chol & operator= (const chol &a)
 
COND_T rcond (void) const
 
OCTAVE_API void set (const T &R)
 
OCTAVE_API void shift_sym (octave_idx_type i, octave_idx_type j)
 
OCTAVE_API void shift_sym (octave_idx_type i_arg, octave_idx_type j_arg)
 
OCTAVE_API void shift_sym (octave_idx_type i_arg, octave_idx_type j_arg)
 
OCTAVE_API void shift_sym (octave_idx_type i_arg, octave_idx_type j_arg)
 
OCTAVE_API void shift_sym (octave_idx_type i_arg, octave_idx_type j_arg)
 
OCTAVE_API void update (const ColumnVector &u)
 
OCTAVE_API void update (const ComplexColumnVector &u)
 
OCTAVE_API void update (const FloatColumnVector &u)
 
OCTAVE_API void update (const FloatComplexColumnVector &u)
 
OCTAVE_API void update (const VT &u)
 

Private Member Functions

OCTAVE_API octave_idx_type init (const ComplexMatrix &a, bool upper, bool calc_cond)
 
OCTAVE_API octave_idx_type init (const FloatComplexMatrix &a, bool upper, bool calc_cond)
 
OCTAVE_API octave_idx_type init (const FloatMatrix &a, bool upper, bool calc_cond)
 
OCTAVE_API octave_idx_type init (const Matrix &a, bool upper, bool calc_cond)
 
OCTAVE_API octave_idx_type init (const T &a, bool upper, bool calc_cond)
 

Private Attributes

T m_chol_mat
 
bool m_is_upper
 
COND_T m_rcond
 

Detailed Description

template<typename T>
class chol< T >

Definition at line 36 of file chol.h.

Member Typedef Documentation

◆ COND_T

template<typename T >
typedef T::real_elt_type chol< T >::COND_T

Definition at line 42 of file chol.h.

◆ VT

template<typename T >
typedef T::column_vector_type chol< T >::VT

Definition at line 41 of file chol.h.

Constructor & Destructor Documentation

◆ chol() [1/4]

template<typename T >
chol< T >::chol ( void  )
inline

Definition at line 44 of file chol.h.

◆ chol() [2/4]

template<typename T >
chol< T >::chol ( const T &  a,
bool  upper = true,
bool  calc_cond = false 
)
inline

Definition at line 46 of file chol.h.

◆ chol() [3/4]

template<typename T >
chol< T >::chol ( const T &  a,
octave_idx_type &  info,
bool  upper = true,
bool  calc_cond = false 
)
inline

Definition at line 52 of file chol.h.

◆ chol() [4/4]

template<typename T >
chol< T >::chol ( const chol< T > &  a)
inline

Definition at line 59 of file chol.h.

Member Function Documentation

◆ chol_matrix()

template<typename T >
T chol< T >::chol_matrix ( void  ) const
inline

Definition at line 74 of file chol.h.

◆ delete_sym() [1/5]

template<typename T >
OCTAVE_API void chol< T >::delete_sym ( octave_idx_type  j)

◆ delete_sym() [2/5]

OCTAVE_API void chol< Matrix >::delete_sym ( octave_idx_type  j_arg)

Definition at line 550 of file chol.cc.

References F77_XFCN, n, OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ delete_sym() [3/5]

OCTAVE_API void chol< FloatMatrix >::delete_sym ( octave_idx_type  j_arg)

Definition at line 727 of file chol.cc.

References F77_XFCN, n, OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ delete_sym() [4/5]

OCTAVE_API void chol< ComplexMatrix >::delete_sym ( octave_idx_type  j_arg)

Definition at line 913 of file chol.cc.

References F77_DBLE_CMPLX_ARG, F77_XFCN, n, and OCTAVE_LOCAL_BUFFER.

◆ delete_sym() [5/5]

OCTAVE_API void chol< FloatComplexMatrix >::delete_sym ( octave_idx_type  j_arg)

Definition at line 1099 of file chol.cc.

References F77_CMPLX_ARG, F77_XFCN, n, and OCTAVE_LOCAL_BUFFER.

◆ downdate() [1/5]

OCTAVE_API octave_idx_type chol< Matrix >::downdate ( const ColumnVector &  u)

Definition at line 502 of file chol.cc.

References F77_XFCN, n, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ downdate() [2/5]

OCTAVE_API octave_idx_type chol< ComplexMatrix >::downdate ( const ComplexColumnVector &  u)

Definition at line 858 of file chol.cc.

References F77_DBLE_CMPLX_ARG, F77_XFCN, n, Array< T, Alloc >::numel(), and OCTAVE_LOCAL_BUFFER.

◆ downdate() [3/5]

OCTAVE_API octave_idx_type chol< FloatMatrix >::downdate ( const FloatColumnVector &  u)

Definition at line 678 of file chol.cc.

References F77_XFCN, n, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ downdate() [4/5]

OCTAVE_API octave_idx_type chol< FloatComplexMatrix >::downdate ( const FloatComplexColumnVector &  u)

Definition at line 1047 of file chol.cc.

References F77_CMPLX_ARG, F77_XFCN, n, Array< T, Alloc >::numel(), and OCTAVE_LOCAL_BUFFER.

◆ downdate() [5/5]

template<typename T >
OCTAVE_API octave_idx_type chol< T >::downdate ( const VT &  u)

◆ init() [1/5]

OCTAVE_API octave_idx_type chol< ComplexMatrix >::init ( const ComplexMatrix &  a,
bool  upper,
bool  calc_cond 
)
private

Definition at line 764 of file chol.cc.

References Array< T, Alloc >::cols(), F77_DBLE_CMPLX_ARG, F77_XFCN, Array< T, Alloc >::fortran_vec(), n, Array< T, Alloc >::rows(), and xnorm().

◆ init() [2/5]

OCTAVE_API octave_idx_type chol< FloatComplexMatrix >::init ( const FloatComplexMatrix &  a,
bool  upper,
bool  calc_cond 
)
private

Definition at line 955 of file chol.cc.

References Array< T, Alloc >::cols(), F77_CMPLX_ARG, F77_XFCN, Array< T, Alloc >::fortran_vec(), n, Array< T, Alloc >::rows(), and xnorm().

◆ init() [3/5]

OCTAVE_API octave_idx_type chol< FloatMatrix >::init ( const FloatMatrix &  a,
bool  upper,
bool  calc_cond 
)
private

Definition at line 586 of file chol.cc.

References Array< T, Alloc >::cols(), F77_XFCN, Array< T, Alloc >::fortran_vec(), n, OCTAVE_LOCAL_BUFFER, Array< T, Alloc >::rows(), and xnorm().

◆ init() [4/5]

OCTAVE_API octave_idx_type chol< Matrix >::init ( const Matrix &  a,
bool  upper,
bool  calc_cond 
)
private

Definition at line 410 of file chol.cc.

References Array< T, Alloc >::cols(), F77_XFCN, Array< T, Alloc >::fortran_vec(), n, OCTAVE_LOCAL_BUFFER, Array< T, Alloc >::rows(), and xnorm().

◆ init() [5/5]

template<typename T >
OCTAVE_API octave_idx_type chol< T >::init ( const T &  a,
bool  upper,
bool  calc_cond 
)
private

◆ insert_sym() [1/5]

OCTAVE_API octave_idx_type chol< Matrix >::insert_sym ( const ColumnVector &  u,
octave_idx_type  j_arg 
)

Definition at line 523 of file chol.cc.

References F77_XFCN, n, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ insert_sym() [2/5]

OCTAVE_API octave_idx_type chol< ComplexMatrix >::insert_sym ( const ComplexColumnVector &  u,
octave_idx_type  j_arg 
)

Definition at line 882 of file chol.cc.

References F77_DBLE_CMPLX_ARG, F77_XFCN, n, Array< T, Alloc >::numel(), and OCTAVE_LOCAL_BUFFER.

◆ insert_sym() [3/5]

OCTAVE_API octave_idx_type chol< FloatMatrix >::insert_sym ( const FloatColumnVector &  u,
octave_idx_type  j_arg 
)

Definition at line 699 of file chol.cc.

References F77_XFCN, n, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ insert_sym() [4/5]

OCTAVE_API octave_idx_type chol< FloatComplexMatrix >::insert_sym ( const FloatComplexColumnVector &  u,
octave_idx_type  j_arg 
)

Definition at line 1069 of file chol.cc.

References F77_CMPLX_ARG, F77_XFCN, n, Array< T, Alloc >::numel(), and OCTAVE_LOCAL_BUFFER.

◆ insert_sym() [5/5]

template<typename T >
OCTAVE_API octave_idx_type chol< T >::insert_sym ( const VT &  u,
octave_idx_type  j 
)

◆ inverse()

template<typename T >
T chol< T >::inverse ( void  ) const

Definition at line 250 of file chol.cc.

References chol2inv_internal().

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

◆ operator=()

template<typename T >
chol& chol< T >::operator= ( const chol< T > &  a)
inline

Definition at line 62 of file chol.h.

References chol< T >::m_chol_mat, chol< T >::m_is_upper, and chol< T >::m_rcond.

◆ rcond()

template<typename T >
COND_T chol< T >::rcond ( void  ) const
inline

Definition at line 76 of file chol.h.

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

◆ set()

template<typename T >
void chol< T >::set ( const T &  R)

Definition at line 257 of file chol.cc.

◆ shift_sym() [1/5]

template<typename T >
OCTAVE_API void chol< T >::shift_sym ( octave_idx_type  i,
octave_idx_type  j 
)

◆ shift_sym() [2/5]

OCTAVE_API void chol< Matrix >::shift_sym ( octave_idx_type  i_arg,
octave_idx_type  j_arg 
)

Definition at line 567 of file chol.cc.

References F77_XFCN, n, OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ shift_sym() [3/5]

OCTAVE_API void chol< FloatMatrix >::shift_sym ( octave_idx_type  i_arg,
octave_idx_type  j_arg 
)

Definition at line 745 of file chol.cc.

References F77_XFCN, n, OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ shift_sym() [4/5]

OCTAVE_API void chol< ComplexMatrix >::shift_sym ( octave_idx_type  i_arg,
octave_idx_type  j_arg 
)

Definition at line 932 of file chol.cc.

References F77_DBLE_CMPLX_ARG, F77_XFCN, n, OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ shift_sym() [5/5]

OCTAVE_API void chol< FloatComplexMatrix >::shift_sym ( octave_idx_type  i_arg,
octave_idx_type  j_arg 
)

Definition at line 1117 of file chol.cc.

References F77_CMPLX_ARG, F77_XFCN, n, OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ update() [1/5]

OCTAVE_API void chol< Matrix >::update ( const ColumnVector &  u)

Definition at line 485 of file chol.cc.

References F77_XFCN, n, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ update() [2/5]

OCTAVE_API void chol< ComplexMatrix >::update ( const ComplexColumnVector &  u)

Definition at line 838 of file chol.cc.

References F77_DBLE_CMPLX_ARG, F77_XFCN, n, Array< T, Alloc >::numel(), and OCTAVE_LOCAL_BUFFER.

◆ update() [3/5]

OCTAVE_API void chol< FloatMatrix >::update ( const FloatColumnVector &  u)

Definition at line 661 of file chol.cc.

References F77_XFCN, n, Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER, and Faddeeva::w().

◆ update() [4/5]

OCTAVE_API void chol< FloatComplexMatrix >::update ( const FloatComplexColumnVector &  u)

Definition at line 1030 of file chol.cc.

References F77_CMPLX_ARG, F77_XFCN, n, Array< T, Alloc >::numel(), and OCTAVE_LOCAL_BUFFER.

◆ update() [5/5]

template<typename T >
OCTAVE_API void chol< T >::update ( const VT &  u)

Member Data Documentation

◆ m_chol_mat

template<typename T >
T chol< T >::m_chol_mat
private

Definition at line 95 of file chol.h.

Referenced by chol< T >::operator=().

◆ m_is_upper

template<typename T >
bool chol< T >::m_is_upper
private

Definition at line 99 of file chol.h.

Referenced by chol< T >::operator=().

◆ m_rcond

template<typename T >
COND_T chol< T >::m_rcond
private

Definition at line 97 of file chol.h.

Referenced by chol< T >::operator=().

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