mlpack
Public Types | Public Member Functions | List of all members
mlpack::cf::LMetricSearch< TPower > Class Template Reference

Nearest neighbor search with L_p distance. More...

#include <lmetric_search.hpp>

Public Types

using NeighborSearchType = neighbor::NeighborSearch< neighbor::NearestNeighborSort, metric::LMetric< TPower, true > >
 

Public Member Functions

 LMetricSearch (const arma::mat &referenceSet)
 
void Search (const arma::mat &query, const size_t k, arma::Mat< size_t > &neighbors, arma::mat &similarities)
 Given a set of query points, find the nearest k neighbors, and return similarites. More...
 

Detailed Description

template<int TPower>
class mlpack::cf::LMetricSearch< TPower >

Nearest neighbor search with L_p distance.

An example of how to use LMetricSearch 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.
CFType<> cf(data);
// Generate 10 recommendations for all users.
cf.template GetRecommendations<LMetricSearch<2>>(10, recommendations);
Template Parameters
TPowerPower of metric.

Constructor & Destructor Documentation

◆ LMetricSearch()

template<int TPower>
mlpack::cf::LMetricSearch< TPower >::LMetricSearch ( const arma::mat &  referenceSet)
inline
Parameters
referenceSetSet of reference points.

Member Function Documentation

◆ Search()

template<int TPower>
void mlpack::cf::LMetricSearch< TPower >::Search ( const arma::mat &  query,
const size_t  k,
arma::Mat< size_t > &  neighbors,
arma::mat &  similarities 
)
inline

Given a set of query points, find the nearest k neighbors, and return similarites.

Similarities are non-negative and no larger thant one.

Parameters
queryA set of query points.
kNumber of neighbors to search.
neighborsNearest neighbors.
similaritiesSimilarities between query point and its neighbors.

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