fir_matcher.h

#pragma once

#include <face_sdk_base/export.h>

#include <face_sdk_base/data_container.h>
#include <face_sdk_base/fir.h>
#include <face_sdk_base/license.h>
#include <face_sdk_fir_matcher/fir_list.h>

namespace face_sdk
{

    typedef std::tuple<uint32_t, float> match;

    typedef std::vector<match> matches;

    enum match_fields
    {
        FIR_INDEX = 0,
        MATCH_SCORE = 1
    };


    enum class architecture_type
    {
        COMMON = 0, // Common architecture. Standard type that use for compute matches.
        NUMA        // NUMA architecture. Prefer to use for compute matches on machine with NUMA.
    };

    class fir_matcher
    {
    public:

        virtual float match(const std::shared_ptr<face_sdk::fir> &fir_l, const std::shared_ptr<face_sdk::fir> &fir_r) = 0;

        virtual float match(const std::shared_ptr<face_sdk::fir_list> &fir_list, uint32_t idx, const std::shared_ptr<face_sdk::fir> &fir) = 0;

        virtual uint32_t builder_version() const noexcept = 0;

        virtual std::string far_table_code() const noexcept = 0;

        virtual std::vector<float> match(const std::shared_ptr<face_sdk::fir> &fir, const std::shared_ptr<face_sdk::fir_list> &fir_list) = 0;

        virtual matches best_matches(
            const std::shared_ptr<face_sdk::fir> &fir,
            const std::shared_ptr<face_sdk::fir_list> &fir_list,
            float threshold, uint32_t max_matches) = 0;

        virtual matches best_matches(
            const std::vector< std::shared_ptr<face_sdk::fir> > &firs,
            const std::shared_ptr<face_sdk::fir_list> &fir_list,
            float threshold, uint32_t max_matches) = 0;
    };

    bool FACE_SDK_EXPORT is_architecture_available(const architecture_type type);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const std::shared_ptr<face_sdk::license> &license,
        const std::shared_ptr<face_sdk::data_container> &container,
        const architecture_type type);


    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const std::shared_ptr<face_sdk::license> &license,
        const std::shared_ptr<face_sdk::data_container> &container);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const std::shared_ptr<face_sdk::license> &license);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const std::shared_ptr<face_sdk::license> &license,
        const architecture_type type);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const std::shared_ptr<face_sdk::data_container> &data_container);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const std::shared_ptr<face_sdk::data_container> &data_container,
        const architecture_type type);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code);

    std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT make_fir_matcher(
        uint32_t builder_version,
        const std::string &table_code,
        const architecture_type type);

    float FACE_SDK_EXPORT score_to_percentage(float score);

    float FACE_SDK_EXPORT percentage_to_score(float percentage);

}