Class Result

pose_graph/ThirdParty/DBoW/QueryResults.h:22–132

Single result of a query

/// Single result of a query
class Result {
 public:
  /// Entry id
  EntryId Id;

  /// Score obtained
  double Score;

  /// debug
  int nWords;  // words in common
  // !!! this is filled only by Bhatt score!
  // (and for BCMatching, BCThresholding then)

  double bhatScore, chiScore;
  /// debug

  // only done by ChiSq and BCThresholding
  double sumCommonVi;
  double sumCommonWi;
  double expectedChiScore;
  /// debug

  /**
   * Empty constructors
   */
  inline Result() {}

  /**
   * Creates a result with the given data
   * @param _id entry id
   * @param _score score
   */
  inline Result(EntryId _id, double _score) : Id(_id), Score(_score) {}

  /**
   * Compares the scores of two results
   * @return true iff this.score < r.score
   */
  inline bool operator<(const Result& r) const { return this->Score < r.Score; }

  /**
   * Compares the scores of two results
   * @return true iff this.score > r.score
   */
  inline bool operator>(const Result& r) const { return this->Score > r.Score; }

  /**
   * Compares the entry id of the result
   * @return true iff this.id == id
   */
  inline bool operator==(EntryId id) const { return this->Id == id; }

  /**
   * Compares the score of this entry with a given one
   * @param s score to compare with
   * @return true iff this score < s
   */
  inline bool operator<(double s) const { return this->Score < s; }