ir_eval.h

Go to the documentation of this file.

#ifndef META_IR_EVAL_H_
#define META_IR_EVAL_H_

#include <iostream>
#include <limits>
#include <stdexcept>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
#include "meta.h"

namespace meta
{
namespace index
{

class ir_eval
{
  public:
    using result_type = std::vector<std::pair<doc_id, double>>;

    ir_eval(const std::string& config_file);

    double precision(const result_type& results, query_id q_id,
             uint64_t num_docs = std::numeric_limits<uint64_t>::max()) const;

    double recall(const result_type& results, query_id q_id,
              uint64_t num_docs = std::numeric_limits<uint64_t>::max()) const;

    double f1(const result_type& results, query_id q_id,
              uint64_t num_docs = std::numeric_limits<uint64_t>::max(),
              double beta = 1.0) const;

    double ndcg(const result_type& results, query_id q_id,
                uint64_t num_docs = std::numeric_limits<uint64_t>::max()) const;

    double avg_p(const result_type& results, query_id q_id,
                 uint64_t num_docs = std::numeric_limits<uint64_t>::max());

    double map() const;

    double gmap() const;

    void print_stats(const result_type& results, query_id q_id,
                     std::ostream& out = std::cout);

    void reset_stats();

  private:
    std::unordered_map<query_id, std::unordered_map<doc_id, uint8_t>> qrels_;

    std::vector<double> scores_;

    void init_index(const std::string& path);

    double relevant_retrieved(const result_type& results, query_id q_id,
                              uint64_t num_docs) const;

  public:
    class ir_eval_exception : public std::runtime_error
    {
      public:
        using std::runtime_error::runtime_error;
    };
};
}
}

#endif