| Face Engine SDK 5.34.0 A face detection, recognition and tracking engine.

Public Member Functions | List of all members
fsdk::IIndex Struct Referenceabstract

Base index interface. More...

`#include <IIndex.h>`

Inheritance diagram for fsdk::IIndex:

## Public Member Functions
virtual ResultValue< FSDKError, int > | search (const IDescriptor *reference, int maxResultsCount, SearchResult *results) const noexcept=0
| Search for descriptors with the shorter distance to passed descriptor. More...
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t | retain () noexcept=0
| Increase strong reference count. More...
virtual int32_t | retainLocked () noexcept=0
| Increase strong reference count thread safely. More...
virtual int32_t | release () noexcept=0
| Decrease strong reference count. More...
virtual int32_t | getRefCount () const noexcept=0
| Get actual strong reference count. More...
virtual int32_t | retainWeak () noexcept=0
| Increase weak reference count. More...
virtual int32_t | releaseWeak () noexcept=0
| Decrease weak reference count. More...
virtual int32_t | getWeakRefCount () const noexcept=0
| Get actual weak reference count. More...

## Detailed Description

Base index interface.

You may think of index as some data structure optimized for search queries.

## Member Function Documentation

## ◆ search()

virtual ResultValue<FSDKError, int> fsdk::IIndex::search | ( | const IDescriptor * | reference,
|  | int | maxResultsCount,
|  | SearchResult * | results
| ) |  | const
| pure virtual noexcept

Search for descriptors with the shorter distance to passed descriptor.

Parameters

  [in] | reference | Descriptor to match against index.
  [in] | maxResultsCount | Maximum count of results. It is upper bound value, it does not guarantee to return exactly this amount of results.
  [out] | results | C-Array of at least

See also
  maxResultsCount size. Is filled with query results.

Returns
  ResultValue with error code and count of found descriptors.

See also
  IDescriptor, SearchResult, ResultValue and FSDKError for details.

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

- include/fsdk/IIndex.h