GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Types | Public Member Functions | List of all members
svd< T > Class Template Reference

#include "svd.h"

Public Types

typedef T::real_diag_matrix_type DM_T
 
enum class  Driver { GESVD , GESDD , GEJSV }
 
enum class  Type { std , economy , sigma_only }
 

Public Member Functions

 svd ()
 
 svd (const svd &a)
 
 svd (const T &a, svd::Type type=svd::Type::std, svd::Driver driver=svd::Driver::GESVD)
 
 ~svd ()=default
 
T left_singular_matrix () const
 
svd & operator= (const svd &a)
 
T right_singular_matrix () const
 
DM_T singular_values () const
 

Detailed Description

template<typename T>
class svd< T >

Definition at line 38 of file svd.h.

Member Typedef Documentation

◆ DM_T

template<typename T >
typedef T::real_diag_matrix_type svd< T >::DM_T

Definition at line 44 of file svd.h.

Member Enumeration Documentation

◆ Driver

template<typename T >
enum svd::Driver
strong
Enumerator
GESVD 
GESDD 
GEJSV 

Definition at line 53 of file svd.h.

◆ Type

template<typename T >
enum svd::Type
strong
Enumerator
std 
economy 
sigma_only 

Definition at line 46 of file svd.h.

Constructor & Destructor Documentation

◆ svd() [1/3]

template<typename T >
svd< T >::svd ( )
inline

Definition at line 60 of file svd.h.

◆ svd() [2/3]

template<typename T >
svd< T >::svd ( const T &  a,
svd< T >::Type  type = svd< T >::Type::std,
svd< T >::Driver  driver = svd< T >::Driver::GESVD 
)

Definition at line 671 of file svd.cc.

References current_liboctave_error_handler, svd< T >::economy, svd< T >::GEJSV, svd< T >::GESDD, svd< T >::GESVD, m, max(), min(), n, svd< T >::sigma_only, and svd< T >::std.

◆ svd() [3/3]

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

Definition at line 67 of file svd.h.

◆ ~svd()

template<typename T >
svd< T >::~svd ( )
default

Member Function Documentation

◆ left_singular_matrix()

template<typename T >
T svd< T >::left_singular_matrix

Definition at line 311 of file svd.cc.

References svd< T >::sigma_only.

◆ operator=()

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

Definition at line 72 of file svd.h.

◆ right_singular_matrix()

template<typename T >
T svd< T >::right_singular_matrix

Definition at line 322 of file svd.cc.

References svd< T >::sigma_only.

◆ singular_values()

template<typename T >
DM_T svd< T >::singular_values ( ) const
inline

Definition at line 90 of file svd.h.

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