This initialization rule initializes matrix W and H to root of the average of V, perturbed with uniform noise. More...

Public Member Functions
	AverageInitialization ()

template < typename Archive >
void	serialize (Archive &, const uint32_t)
	Serialize the object (in this case, there is nothing to do). More...

Static Public Member Functions
template < typename MatType >
static void	Initialize (const MatType &V, const size_t r, arma::mat &W, arma::mat &H)
	Initialize the matrices W and H to the average value of V with uniform random noise added. More...

template < typename MatType >
static void	InitializeOne (const MatType &V, const size_t r, arma::mat &M, const bool whichMatrix=true)
	Initialize the matrix W or H to the average value of V with uniform random noise added. More...

Detailed Description

This initialization rule initializes matrix W and H to root of the average of V, perturbed with uniform noise.

Uniform noise is generated by Armadillo's 'randu' function. For better performance, the lowest element of the matrix is subtracted from the average before dividing it by the factorization rank. This computed value is added with the random noise.

Definition at line 27 of file average_init.hpp.

Constructor & Destructor Documentation

◆ AverageInitialization()

AverageInitialization ( )

inline

Definition at line 31 of file average_init.hpp.

Member Function Documentation

◆ Initialize()

static void Initialize	(	const MatType &	V,
		const size_t	r,
		arma::mat &	W,
		arma::mat &	H
	)

inlinestatic

Initialize the matrices W and H to the average value of V with uniform random noise added.

Parameters

V	Input matrix.
r	Rank of matrix.
W	W matrix, to be initialized.
H	H matrix, to be initialized.

Definition at line 43 of file average_init.hpp.

◆ InitializeOne()

static void InitializeOne	(	const MatType &	V,
		const size_t	r,
		arma::mat &	M,
		const bool	whichMatrix = `true`
	)

inlinestatic

Initialize the matrix W or H to the average value of V with uniform random noise added.

Parameters

V	Input matrix.
r	Rank of matrix.
M	W or H matrix, to be initialized to the average value of V with uniform random noise added.
whichMatrix	If true, initialize W. Otherwise, initialize H.

Definition at line 86 of file average_init.hpp.

◆ serialize()

void serialize	(	Archive &	,
		const uint32_t
	)

inline

Serialize the object (in this case, there is nothing to do).

Definition at line 122 of file average_init.hpp.

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

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/amf/init_rules/average_init.hpp

Public Member Functions