PCL
pcl::FSVD Class Reference

Singular value decomposition algorithm for FMatrix and FVector objects. More...

#include <Algebra.h>

+ Inheritance diagram for pcl::FSVD:

Public Types

using algorithm_implementation = GenericSVD< float >
 
using matrix = algorithm_implementation::matrix
 
using matrix_element = matrix::element
 
using vector = algorithm_implementation::vector
 
using vector_component = vector::component
 
- Public Types inherited from pcl::GenericSVD< float >
using algorithm_implementation = GenericInPlaceSVD< float >
 
using matrix = typename algorithm_implementation::matrix
 
using matrix_element = typename matrix::element
 
using vector = typename algorithm_implementation::vector
 
using vector_component = typename vector::component
 

Public Member Functions

 FSVD (const matrix &A)
 
- Public Member Functions inherited from pcl::GenericSVD< float >
 GenericSVD (const matrix &A)
 
int IndexOfLargestSingularValue () const
 
int IndexOfSmallestSingularValue () const
 

Additional Inherited Members

- Public Attributes inherited from pcl::GenericSVD< float >
matrix U
 
matrix V
 
vector W
 

Detailed Description

FSVD is a template instantiation of GenericSVD for the float type. FSVD works with FMatrix and FVector objects. FMatrix and FVector are template instantiations of GenericMatrix and GenericVector, respectively, for the float type.

Definition at line 606 of file Algebra.h.

Member Typedef Documentation

◆ algorithm_implementation

Identifies the parent template class, which implements the underlying algorithm for this class.

Definition at line 614 of file Algebra.h.

◆ matrix

Represents a matrix involved in a singular value decomposition.

Definition at line 624 of file Algebra.h.

◆ matrix_element

using pcl::FSVD::matrix_element = matrix::element

Represents a matrix element.

Definition at line 634 of file Algebra.h.

◆ vector

Represents a vector involved in a singular value decomposition.

Definition at line 619 of file Algebra.h.

◆ vector_component

using pcl::FSVD::vector_component = vector::component

Represents a vector component.

Definition at line 629 of file Algebra.h.

Constructor & Destructor Documentation

◆ FSVD()

pcl::FSVD::FSVD ( const matrix A)
inline

Singular Value Decomposition: A = U*W*Vt

The dimensions of A are n rows and m columns. U is an n x m matrix. The m components of W are the positive diagonal elements of W, and each column of V (m x m) is the eigenvector for the corresponding element of W.

On output, this constructor stores U, W and V in the corresponding members of this object.

Definition at line 646 of file Algebra.h.


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