#include "neighbor_search.hpp"
#include <mlpack/core/metrics/lmetric.hpp>
#include "sort_policies/nearest_neighbor_sort.hpp"
#include "sort_policies/furthest_neighbor_sort.hpp"

Include dependency graph for typedef.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	mlpack
	Linear algebra utility functions, generally performed on matrices or vectors.

Typedefs
typedef NeighborSearch< NearestNeighborSort, metric::EuclideanDistance >	mlpack::neighbor::KNN
	The KNN class is the k-nearest-neighbors method. More...

typedef NeighborSearch< FurthestNeighborSort, metric::EuclideanDistance >	mlpack::neighbor::KFN
	The KFN class is the k-furthest-neighbors method. More...

template<template< typename TreeMetricType, typename TreeStatType, typename TreeMatType > class TreeType = tree::SPTree>
using	mlpack::neighbor::DefeatistKNN = NeighborSearch< NearestNeighborSort, metric::EuclideanDistance, arma::mat, TreeType, TreeType< metric::EuclideanDistance, NeighborSearchStat< NearestNeighborSort >, arma::mat >::template DefeatistDualTreeTraverser, TreeType< metric::EuclideanDistance, NeighborSearchStat< NearestNeighborSort >, arma::mat >::template DefeatistSingleTreeTraverser >
	The DefeatistKNN class is the k-nearest-neighbors method considering defeatist search. More...

typedef DefeatistKNN< tree::SPTree >	mlpack::neighbor::SpillKNN
	The SpillKNN class is the k-nearest-neighbors method considering defeatist search on SPTree. More...

Detailed Description

Author: Ryan Curtin

Simple typedefs describing template instantiations of the NeighborSearch class which are commonly used. This is meant to be included by neighbor_search.h but is a separate file for simplicity.

mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information.

Typedef Documentation

◆ DefeatistKNN

template<template< typename TreeMetricType, typename TreeStatType, typename TreeMatType > class TreeType = tree::SPTree>

using mlpack::neighbor::DefeatistKNN = typedef NeighborSearch< NearestNeighborSort, metric::EuclideanDistance, arma::mat, TreeType, TreeType<metric::EuclideanDistance, NeighborSearchStat<NearestNeighborSort>, arma::mat>::template DefeatistDualTreeTraverser, TreeType<metric::EuclideanDistance, NeighborSearchStat<NearestNeighborSort>, arma::mat>::template DefeatistSingleTreeTraverser>

The DefeatistKNN class is the k-nearest-neighbors method considering defeatist search.

It returns L2 distances (Euclidean distances) for each of the k nearest neighbors found.

Template Parameters

TreeType The tree type to use; must adhere to the TreeType API, and implement Defeatist Traversers.

◆ KFN

typedef NeighborSearch<FurthestNeighborSort, metric::EuclideanDistance> mlpack::neighbor::KFN

The KFN class is the k-furthest-neighbors method.

It returns L2 distances (Euclidean distances) for each of the k furthest neighbors.

◆ KNN

typedef NeighborSearch<NearestNeighborSort, metric::EuclideanDistance> mlpack::neighbor::KNN

The KNN class is the k-nearest-neighbors method.

It returns L2 distances (Euclidean distances) for each of the k nearest neighbors.

◆ SpillKNN

typedef DefeatistKNN<tree::SPTree> mlpack::neighbor::SpillKNN

The SpillKNN class is the k-nearest-neighbors method considering defeatist search on SPTree.