pcl::FInPlaceSVD Class Reference

In-place singular value decomposition algorithm for FMatrix and FVector objects. More...

#include <Algebra.h>

Inheritance diagram for pcl::FInPlaceSVD:

Public Types
using	algorithm_implementation = GenericInPlaceSVD< 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::GenericInPlaceSVD< float >
using	matrix = GenericMatrix< float >
using	matrix_element = typename matrix::element
using	vector = GenericVector< float >
using	vector_component = typename vector::component

Public Member Functions
	FInPlaceSVD (matrix &A)
Public Member Functions inherited from pcl::GenericInPlaceSVD< float >
	GenericInPlaceSVD (matrix &A)
int	IndexOfLargestSingularValue () const
int	IndexOfSmallestSingularValue () const

Additional Inherited Members
Public Attributes inherited from pcl::GenericInPlaceSVD< float >
matrix	V
vector	W

Detailed Description

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

Definition at line 387 of file Algebra.h.

Member Typedef Documentation

algorithm_implementation

using pcl::FInPlaceSVD::algorithm_implementation = GenericInPlaceSVD<float>

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

Definition at line 395 of file Algebra.h.

matrix

using pcl::FInPlaceSVD::matrix = algorithm_implementation::matrix

Represents a matrix involved in a singular value decomposition.

Definition at line 405 of file Algebra.h.

matrix_element

using pcl::FInPlaceSVD::matrix_element = matrix::element

Represents a matrix element.

Definition at line 415 of file Algebra.h.

vector

using pcl::FInPlaceSVD::vector = algorithm_implementation::vector

Represents a vector involved in a singular value decomposition.

Definition at line 400 of file Algebra.h.

vector_component

using pcl::FInPlaceSVD::vector_component = vector::component

Represents a vector component.

Definition at line 410 of file Algebra.h.

Constructor & Destructor Documentation

FInPlaceSVD()

pcl::FInPlaceSVD::FInPlaceSVD ( 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 replaces the specified matrix A with the matrix U that results from the SVD decomposition (indeed that's why this is an in-place decomposition). W and V are stored in the corresponding members of this object.

Definition at line 429 of file Algebra.h.

---

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

• Algebra.h