m_set_F.c

/* 
   Copyright (c) 2008 - Chris Buckley. 

   Permission is granted for use and modification of this file for
   research, non-commercial purposes. 
*/

#include "common.h"
#include "sysfunc.h"
#include "trec_eval.h"
#include "functions.h"
#include "trec_format.h"

static int
te_calc_set_F(const EPI * epi, const REL_INFO * rel_info,
              const RESULTS * results, const TREC_MEAS * tm, TREC_EVAL * eval);
static double set_F_param_array[] = { 1.0 };

static PARAMS default_set_F_params = {
    NULL, sizeof(set_F_param_array) / sizeof(set_F_param_array[0]),
    &set_F_param_array[0]
};

/* See trec_eval.h for definition of TREC_MEAS */
TREC_MEAS te_meas_set_F = { "set_F",
    "      Set F measure: weighted harmonic mean of recall and precision\n\
    set_Fx = (x+1) * P * R / (R + x*P)\n\
    where x is the relative importance of R to P (default 1.0).\n\
    Default usage: trec_eval -m set_F.1.0 ...\n\
    Cite: Variant of van Rijsbergen's E measure ('Information Retrieval',\n\
    Butterworths, 1979).\n",
    te_init_meas_s_double_p_double,
    te_calc_set_F,
    te_acc_meas_s,
    te_calc_avg_meas_s,
    te_print_single_meas_s_double,
    te_print_final_meas_s_double_p,
    (void *) &default_set_F_params, -1
};

static int
te_calc_set_F(const EPI * epi, const REL_INFO * rel_info,
              const RESULTS * results, const TREC_MEAS * tm, TREC_EVAL * eval)
{
    double *params = (double *) tm->meas_params->param_values;
    RES_RELS res_rels;
    double x, P, R;

    if (UNDEF == te_form_res_rels(epi, rel_info, results, &res_rels))
        return (UNDEF);

    if (res_rels.num_rel_ret) {
        P = (double) res_rels.num_rel_ret / (double) res_rels.num_ret;
        R = (double) res_rels.num_rel_ret / (double) res_rels.num_rel;
        x = params[0];
        eval->values[tm->eval_index].value = (x + 1.0) * P * R / (x * P + R);
    }
    return (1);
}