added new ranking function rank-similar in ranksimilar.c

[idzebra-moved-to-github.git] / index / rank.h

diff --git a/index/rank.h b/index/rank.h
new file mode 100644 (file)
index 0000000..4ef5aa1
--- /dev/null
+++ b/index/rank.h
@@ -0,0 +1,63 @@
+/* $Id: rank.h,v 1.1 2006-05-03 09:31:26 marc Exp $
+   Copyright (C) 1995-2005
+   Index Data ApS
+
+This file is part of the Zebra server.
+
+Zebra is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with Zebra; see the file LICENSE.zebra.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+*/
+
+#ifndef RANK_H
+#define RANK_H
+
+#include <idzebra/api.h>
+
+YAZ_BEGIN_CDECL
+
+struct rank_control {
+    char *name;
+    void *(*create)(ZebraHandle zh);
+    void (*destroy)(struct zebra_register *reg, void *class_handle);
+    void *(*begin)(struct zebra_register *reg, 
+                   void *class_handle, RSET rset, NMEM nmem,
+                   TERMID *terms, int numterms);
+    /* ### Could add parameters to begin:
+     * char *index;    // author, title, etc.
+     * int dbsize;     // number of records in database
+     * int rssize;     // number of records in result set (estimate?)
+     */
+    void (*end)(struct zebra_register *reg, void *set_handle);
+    int (*calc)(void *set_handle, zint sysno, zint staticrank,
+               int *stop_flag);
+    void (*add)(void *set_handle, int seqno, TERMID term);
+};
+
+void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
+ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
+void zebraRankDestroy (struct zebra_register *reg);
+
+/* declaring externally defined rank class structures */
+/* remember to install rank classes in zebraapi.c as well!! */
+extern struct rank_control *rank_1_class;
+extern struct rank_control *rank_zv_class;
+extern struct rank_control *rank_static_class;
+extern struct rank_control *rank_similarity_class;
+
+
+
+YAZ_END_CDECL
+
+#endif