pbio::TemplatesIndex Class Reference

Interface object for working with the template index. More...

#include <TemplatesIndex.h>

Public Types
typedef LightSmartPtr < TemplatesIndex >::tPtr	Ptr
	Alias for the type of a smart pointer to TemplatesIndex.

Public Member Functions
std::string	getMethodName () const
	Get a method name. Thread-safe. More...
size_t	size () const
	Get a number of templates in the index. Thread-safe. More...
pbio::Template::Ptr	at (size_t i) const
	Get an i-th template. Thread-safe. More...
void	reserveSearchMemory (const int queries_count) const
	Reserve memory for temporary buffers used while searching. These temporary buffers require 8 * size() * queries_count bytes. More...

Detailed Description

Interface object for working with the template index.

Member Function Documentation

Template::Ptr pbio::TemplatesIndex::at ( size_t  i ) const

inline

Get an i-th template. Thread-safe.

Parameters

[in]

i

Integer i: 0 <= i < size.

Returns

The i-th template.

std::string pbio::TemplatesIndex::getMethodName ( ) const

inline

Get a method name. Thread-safe.

Returns

The name of the method created this index.

void pbio::TemplatesIndex::reserveSearchMemory ( const int  queries_count ) const

inline

Reserve memory for temporary buffers used while searching. These temporary buffers require 8 * size() * queries_count bytes.

Parameters

[in]

queries_count

Integer queries_count >= 0 - max size of the queries_templates vector passed to Recognizer::search at once to prepare the buffers for.

size_t pbio::TemplatesIndex::size ( ) const

inline

Get a number of templates in the index. Thread-safe.

Returns

Number of templates in the index.