GivenInitialization Class Reference

This initialization rule for AMF simply fills the W and H matrices with the matrices given to the constructor of this object. More...

Public Member Functions

 GivenInitialization ()
 
 GivenInitialization (const arma::mat &w, const arma::mat &h)
 
 GivenInitialization (const arma::mat &&w, const arma::mat &&h)
 
template
<
typename
MatType
>
void Initialize (const MatType &V, const size_t r, arma::mat &W, arma::mat &H)
 Fill W and H with random uniform noise. More...

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

 

Detailed Description

This initialization rule for AMF simply fills the W and H matrices with the matrices given to the constructor of this object.

Note that this object does not use std::move() during the Initialize() method, so it can be reused for multiple AMF objects, but will incur copies of the W and H matrices.

Definition at line 27 of file given_init.hpp.

Constructor & Destructor Documentation

◆ GivenInitialization() [1/3]

GivenInitialization ( )
inline

Definition at line 31 of file given_init.hpp.

◆ GivenInitialization() [2/3]

GivenInitialization ( const arma::mat &  w,
const arma::mat &  h 
)
inline

Definition at line 34 of file given_init.hpp.

◆ GivenInitialization() [3/3]

GivenInitialization ( const arma::mat &&  w,
const arma::mat &&  h 
)
inline

Definition at line 38 of file given_init.hpp.

Member Function Documentation

◆ Initialize()

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

Fill W and H with random uniform noise.

Parameters
VInput matrix.
rRank of decomposition.
WW matrix, to be filled with random noise.
HH matrix, to be filled with random noise.

Definition at line 52 of file given_init.hpp.

References Log::Fatal.

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)
inline

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

Definition at line 90 of file given_init.hpp.


The documentation for this class was generated from the following file:
  • /home/ryan/src/mlpack.org/_src/mlpack-3.2.0/src/mlpack/methods/amf/init_rules/given_init.hpp