struct xilinx_apps::cosinesim::Result

Overview

Tuple (struct) that holds one cosine similarity match result. More…

#include <cosinesim.hpp>

struct Result
{
    // fields

    RowIndex index = -1L;
    double similarity = 0.0;

    // construction

    Result(RowIndex index, double similarity);
};

Detailed Documentation

Tuple (struct) that holds one cosine similarity match result.

Fields

RowIndex index = -1L

the row index of the matched population vector

double similarity = 0.0

the cosine similarity score for the match

Construction

Result(RowIndex index, double similarity)

Constructs a Result tuple given its fields.

Parameters:

index	the row index of a matched population vector
similarity	the cosine similarity score of the match