mlpack: OverallMeanNormalization Class Reference

This normalization class performs overall mean normalization on raw ratings. More...

Public Member Functions
	OverallMeanNormalization ()

double	Denormalize (const size_t, const size_t, const double rating) const
	Denormalize computed rating by adding mean. More...

void	Denormalize (const arma::Mat< size_t > &, arma::vec &predictions) const
	Denormalize computed rating by adding mean. More...

double	Mean () const
	Return mean. More...

void	Normalize (arma::mat &data)
	Normalize the data by subtracting the mean of all existing ratings. More...

void	Normalize (arma::sp_mat &cleanedData)
	Normalize the data by subtracting the mean of all existing ratings. More...

template<typename Archive >
void	serialize (Archive &ar, const unsigned int)
	Serialization. More...

Detailed Description

This normalization class performs overall mean normalization on raw ratings.

An example of how to use OverallMeanNormalization in CF is shown below:

* extern arma::mat data; // data is a (user, item, rating) table.
* // Users for whom recommendations are generated.
* extern arma::Col<size_t> users;
* arma::Mat<size_t> recommendations; // Resulting recommendations.
*
* // Use OverallMeanNormalization as normalization method.
* CFType<NMFPolicy, OverallMeanNormalization> cf(data);
*
* // Generate 10 recommendations for all users.
* cf.GetRecommendations(10, recommendations);
* 

Definition at line 39 of file overall_mean_normalization.hpp.

Constructor & Destructor Documentation

OverallMeanNormalization ( )

inline

Definition at line 43 of file overall_mean_normalization.hpp.

Member Function Documentation

double Denormalize	(	const size_t	,
		const size_t	,
		const double	rating
	)		const

inline

Denormalize computed rating by adding mean.

Parameters

user	User ID.
item	Item ID.
rating	Computed rating before denormalization.

Definition at line 100 of file overall_mean_normalization.hpp.

void Denormalize	(	const arma::Mat< size_t > &	,
		arma::vec &	predictions
	)		const

inline

Denormalize computed rating by adding mean.

Parameters

combinations	User/Item combinations.
predictions	Predicted ratings for each user/item combination.

Definition at line 113 of file overall_mean_normalization.hpp.

double Mean ( ) const

inline

Return mean.

Definition at line 122 of file overall_mean_normalization.hpp.

void Normalize ( arma::mat & data )

inline

Normalize the data by subtracting the mean of all existing ratings.

Parameters

data	Input dataset in the form of coordinate list.

Definition at line 50 of file overall_mean_normalization.hpp.

void Normalize ( arma::sp_mat & cleanedData )

inline

Normalize the data by subtracting the mean of all existing ratings.

Parameters

cleanedData Input data as a sparse matrix.

Definition at line 68 of file overall_mean_normalization.hpp.

void serialize	(	Archive &	ar,
		const unsigned	int
	)

inline

Serialization.

Definition at line 131 of file overall_mean_normalization.hpp.

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

src/mlpack/methods/cf/normalization/overall_mean_normalization.hpp