Happy new year
[pazpar2-moved-to-github.git] / src / relevance.h
1 /* This file is part of Pazpar2.
2    Copyright (C) Index Data
3
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
18 */
19
20 #ifndef RELEVANCE_H
21 #define RELEVANCE_H
22
23 #include <yaz/yaz-util.h>
24 #include <yaz/ccl.h>
25 #include "charsets.h"
26
27 struct relevance;
28 struct record_cluster;
29 struct reclist;
30
31 struct relevance *relevance_create_ccl(pp2_charset_fact_t pft,
32                                        struct ccl_rpn_node *query,
33                                        int rank_cluster, double follow_factor,
34                                        double lead_decay, int length_divide);
35 void relevance_clear(struct relevance *r);
36 void relevance_destroy(struct relevance **rp);
37 void relevance_newrec(struct relevance *r, struct record_cluster *cluster);
38 void relevance_mergerec(struct relevance *r, struct record_cluster *dst,
39                         const struct record_cluster *src);
40 void relevance_countwords(struct relevance *r, struct record_cluster *cluster,
41                           const char *words, const char *multiplier,
42                           const char *name);
43 int relevance_snippet(struct relevance *r,
44                       const char *words, const char *name,
45                       WRBUF w_snippet);
46
47 void relevance_donerecord(struct relevance *r, struct record_cluster *cluster);
48
49 void relevance_prepare_read(struct relevance *rel, struct reclist *rec);
50
51 #endif
52
53 /*
54  * Local variables:
55  * c-basic-offset: 4
56  * c-file-style: "Stroustrup"
57  * indent-tabs-mode: nil
58  * End:
59  * vim: shiftwidth=4 tabstop=8 expandtab
60  */
61