The CFWrapper class wraps the functionality of all CF types. More...

#include <cf_model.hpp>

Inheritance diagram for mlpack::cf::CFWrapper< DecompositionPolicy, NormalizationPolicy >:

Collaboration diagram for mlpack::cf::CFWrapper< DecompositionPolicy, NormalizationPolicy >:

Public Member Functions
	CFWrapper ()
	Create the CFWrapper object, using default parameters to initialize the held CF object. More...

	CFWrapper (const arma::mat &data, const DecompositionPolicy &decomposition, const size_t numUsersForSimilarity, const size_t rank, const size_t maxIterations, const size_t minResidue, const bool mit)
	Create the CFWrapper object, initializing the held CF object.

virtual CFWrapper *	Clone () const
	Clone the CFWrapper object. This handles polymorphism correctly.

virtual	~CFWrapper ()
	Destroy the CFWrapper object.

CFModelType &	CF ()
	Get the CFType object.

virtual void	Predict (const NeighborSearchTypes nsType, const InterpolationTypes interpolationType, const arma::Mat< size_t > &combinations, arma::vec &predictions)
	Compute predictions for users. More...

virtual void	GetRecommendations (const NeighborSearchTypes nsType, const InterpolationTypes interpolationType, const size_t numRecs, arma::Mat< size_t > &recommendations)
	Compute recommendations for all users.

virtual void	GetRecommendations (const NeighborSearchTypes nsType, const InterpolationTypes interpolationType, const size_t numRecs, arma::Mat< size_t > &recommendations, const arma::Col< size_t > &users)
	Compute recommendations. More...

template<typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the model.

Public Member Functions inherited from mlpack::cf::CFWrapperBase
	CFWrapperBase ()
	Create the object. The base class has nothing to hold.

virtual	~CFWrapperBase ()
	Delete the object.

Protected Types
typedef CFType< DecompositionPolicy, NormalizationPolicy >	CFModelType

Protected Attributes
CFModelType	cf
	This is the CF object that we are wrapping.

Detailed Description

The CFWrapper class wraps the functionality of all CF types.

If special handling is needed for a future CF type, this class can be extended.

Constructor & Destructor Documentation

template<typename DecompositionPolicy, typename NormalizationPolicy>

mlpack::cf::CFWrapper< DecompositionPolicy, NormalizationPolicy >::CFWrapper ( )

inline

Create the CFWrapper object, using default parameters to initialize the held CF object.

template<typename DecompositionPolicy , typename NormalizationPolicy >

void mlpack::cf::CFWrapper< DecompositionPolicy, NormalizationPolicy >::GetRecommendations	(	const NeighborSearchTypes	nsType,
		const InterpolationTypes	interpolationType,
		const size_t	numRecs,
		arma::Mat< size_t > &	recommendations,
		const arma::Col< size_t > &	users
	)

virtual

Compute recommendations.

Compute recommendations for queried users.

template<typename DecompositionPolicy , typename NormalizationPolicy >

void mlpack::cf::CFWrapper< DecompositionPolicy, NormalizationPolicy >::Predict	(	const NeighborSearchTypes	nsType,
		const InterpolationTypes	interpolationType,
		const arma::Mat< size_t > &	combinations,
		arma::vec &	predictions
	)

virtual

Compute predictions for users.

Make predictions.

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