nag::nmf_results< FPType > Struct Template Reference

A type used to hold the result of a non-negative matrix factorization. More...

#include <SpecImage.hpp>

Public Member Functions
	nmf_results (nmf_results &&a)
	Move constructor. More...
	nmf_results ()=default
	Default constructor. More...
nmf_results &	operator= (nmf_results &&a)
	Move assignment operator. More...

Data Fields
int	k
	The selected inner dimension of the factorization. More...
size_t	m
	The number of rows of the input matrix. More...
size_t	n
	The number of columns of the input matrix. More...
std::unique_ptr< FPType[], cfree >	W
	The m by k matrix factor W, stored in column-major ordering. More...
std::unique_ptr< FPType[], cfree >	H
	The k by n matrix factor H, stored in column-major ordering. More...
FPType	tol
	The tolerance used to produce the result. More...

Detailed Description

template<class FPType>
struct nag::nmf_results< FPType >

A type used to hold the result of a non-negative matrix factorization.

For more information see: nag::SpecImage::nmf.

Constructor & Destructor Documentation

template<class FPType>

nag::nmf_results< FPType >::nmf_results ( nmf_results< FPType > &&  a )

inline

Move constructor.

template<class FPType>

nag::nmf_results< FPType >::nmf_results ( )

default

Default constructor.

Member Function Documentation

template<class FPType>

nmf_results& nag::nmf_results< FPType >::operator= ( nmf_results< FPType > &&  a )

inline

Move assignment operator.

Field Documentation

template<class FPType>

std::unique_ptr<FPType[], cfree> nag::nmf_results< FPType >::H

The k by n matrix factor H, stored in column-major ordering.

template<class FPType>

int nag::nmf_results< FPType >::k

The selected inner dimension of the factorization.

template<class FPType>

size_t nag::nmf_results< FPType >::m

The number of rows of the input matrix.

template<class FPType>

size_t nag::nmf_results< FPType >::n

The number of columns of the input matrix.

template<class FPType>

FPType nag::nmf_results< FPType >::tol

The tolerance used to produce the result.

template<class FPType>

std::unique_ptr<FPType[], cfree> nag::nmf_results< FPType >::W

The m by k matrix factor W, stored in column-major ordering.

---

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

• SpecImage.hpp