详细描述

This class implements a specialized version of max heap structure. This heap specializes in storing the least k values seen so far along with the indices (or id) of the entities with which the values are associated. On calling the push method, it is automatically checked, if the new value supplied, is among the least k distances seen so far. Also, in case the heap is full already, the max among the stored values is automatically thrown out as the new value finds its proper place in the heap.

在文件 KNNHeap.h 第 47 行定义.

Public 成员函数
	CKNNHeap (int32_t k=1)

	~CKNNHeap ()

void	push (index_t index, float64_t dist)

float64_t	get_max_dist ()

index_t	get_max_index ()

SGVector< float64_t >	get_dists ()

SGVector< index_t >	get_indices ()

构造及析构函数说明

CKNNHeap ( int32_t k = 1 )

constructor

参数

k	heap capacity i.e. the number of least distance values to be stored

在文件 KNNHeap.cpp 第 37 行定义.

~CKNNHeap ( )

destructor

在文件 KNNHeap.h 第 57 行定义.

成员函数说明

SGVector< float64_t > get_dists ( )

get distances

返回: distances stored in the heap

在文件 KNNHeap.cpp 第 100 行定义.

SGVector< index_t > get_indices ( )

get indices

返回: indices stored in the heap

在文件 KNNHeap.cpp 第 123 行定义.

float64_t get_max_dist ( )

max distance

返回: max distance value stored in the heap

在文件 KNNHeap.h 第 70 行定义.

index_t get_max_index ( )

max index

返回: vector id of the max distance stored

在文件 KNNHeap.h 第 76 行定义.

void push	(	index_t	index,
		float64_t	dist
	)

push into heap

参数

index	vector id whose distance value is pushed into the heap
dist	distance value of the vector id index from the query point

在文件 KNNHeap.cpp 第 51 行定义.

该类的文档由以下文件生成:

详细描述

Public 成员函数

构造及析构函数说明

成员函数说明