omenquireinternal.h

Go to the documentation of this file.

/* Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2001,2002 Ananova Ltd
 * Copyright 2002,2003,2004,2005,2006,2007,2008,2009,2010,2011,2014,2015,2016 Olly Betts
 * Copyright 2009 Lemur Consulting Ltd
 * Copyright 2011 Action Without Borders
 *
 * This program 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 of the
 * License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef OM_HGUARD_OMENQUIREINTERNAL_H
#define OM_HGUARD_OMENQUIREINTERNAL_H

#include "xapian/database.h"
#include "xapian/document.h"
#include "xapian/enquire.h"
#include "xapian/query.h"
#include "xapian/keymaker.h"

#include <algorithm>
#include <cmath>
#include <map>
#include <set>
#include <unordered_map>

#include "weight/weightinternal.h"

using std::map;
using std::set;
using std::string;
using std::vector;

class OmExpand;
class MultiMatch;

namespace Xapian {

class TermIterator;

namespace Internal {

class MSetItem {
    public:
        MSetItem(double wt_, Xapian::docid did_)
                : wt(wt_), did(did_), collapse_count(0) {}

        MSetItem(double wt_, Xapian::docid did_, const string &key_)
                : wt(wt_), did(did_), collapse_count(0), collapse_key(key_) {}

        MSetItem(double wt_, Xapian::docid did_, const string &key_,
                 Xapian::doccount collapse_count_)
                : wt(wt_), did(did_),
                  collapse_count(collapse_count_), collapse_key(key_) {}

        void swap(MSetItem & o) {
            std::swap(wt, o.wt);
            std::swap(did, o.did);
            std::swap(collapse_count, o.collapse_count);
            std::swap(collapse_key, o.collapse_key);
            std::swap(sort_key, o.sort_key);
        }

        double wt;

        Xapian::docid did;

        Xapian::doccount collapse_count;

        string collapse_key;

        string sort_key;

        string get_description() const;
};

}

class Enquire::Internal : public Xapian::Internal::intrusive_base {
    friend class MSet::Internal;
    private:
        const Xapian::Database db;

        Query query;

        termcount qlen;

        Internal(const Internal &);
        void operator=(const Internal &);

    public:
        typedef enum { REL, VAL, VAL_REL, REL_VAL } sort_setting;

        Xapian::valueno collapse_key;

        Xapian::doccount collapse_max;

        Xapian::Enquire::docid_order order;

        int percent_cutoff;

        double weight_cutoff;

        Xapian::valueno sort_key;
        sort_setting sort_by;
        bool sort_value_forward;

        Xapian::Internal::opt_intrusive_ptr<KeyMaker> sorter;

        double time_limit;

        mutable Weight * weight;

        std::string eweightname;

        double expand_k;

        vector<Xapian::Internal::opt_intrusive_ptr<MatchSpy>> spies;

        explicit Internal(const Xapian::Database &databases);
        ~Internal();

        void request_doc(const Xapian::Internal::MSetItem &item) const;

        Xapian::Document read_doc(const Xapian::Internal::MSetItem &item) const;

        Xapian::Document get_document(const Xapian::Internal::MSetItem &item) const;

        void set_query(const Query & query_, termcount qlen_);
        const Query & get_query() const;
        MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems,
                      Xapian::doccount check_at_least,
                      const RSet *omrset,
                      const MatchDecider *mdecider) const;

        ESet get_eset(Xapian::termcount maxitems, const RSet & omrset, int flags,
                      const ExpandDecider *edecider, double min_wt) const;

        TermIterator get_matching_terms(Xapian::docid did) const;
        TermIterator get_matching_terms(const Xapian::MSetIterator &it) const;

        Xapian::doccount get_termfreq(const string &tname) const;

        string get_description() const;
};

class MSet::Internal : public Xapian::Internal::intrusive_base {
    public:
        double percent_factor;

    private:
        mutable set<Xapian::doccount> requested_docs;

        mutable map<Xapian::doccount, Xapian::Document> indexeddocs;

        void read_docs() const;

        Internal(const Internal &);
        void operator=(const Internal &);

        mutable std::unordered_map<std::string, double> snippet_bg_relevance;

    public:
        Xapian::Internal::intrusive_ptr<const Enquire::Internal> enquire;

        Xapian::Weight::Internal * stats;

        vector<Xapian::Internal::MSetItem> items;

        Xapian::doccount firstitem;

        Xapian::doccount matches_lower_bound;

        Xapian::doccount matches_estimated;

        Xapian::doccount matches_upper_bound;

        Xapian::doccount uncollapsed_lower_bound;

        Xapian::doccount uncollapsed_estimated;

        Xapian::doccount uncollapsed_upper_bound;

        double max_possible;

        double max_attained;

        Internal()
                : percent_factor(0),
                  stats(NULL),
                  firstitem(0),
                  matches_lower_bound(0),
                  matches_estimated(0),
                  matches_upper_bound(0),
                  uncollapsed_lower_bound(0),
                  uncollapsed_estimated(0),
                  uncollapsed_upper_bound(0),
                  max_possible(0),
                  max_attained(0) {}

        Internal(Xapian::doccount firstitem_,
             Xapian::doccount matches_upper_bound_,
             Xapian::doccount matches_lower_bound_,
             Xapian::doccount matches_estimated_,
             Xapian::doccount uncollapsed_upper_bound_,
             Xapian::doccount uncollapsed_lower_bound_,
             Xapian::doccount uncollapsed_estimated_,
             double max_possible_,
             double max_attained_,
             vector<Xapian::Internal::MSetItem> &items_,
             double percent_factor_)
                : percent_factor(percent_factor_),
                  stats(NULL),
                  firstitem(firstitem_),
                  matches_lower_bound(matches_lower_bound_),
                  matches_estimated(matches_estimated_),
                  matches_upper_bound(matches_upper_bound_),
                  uncollapsed_lower_bound(uncollapsed_lower_bound_),
                  uncollapsed_estimated(uncollapsed_estimated_),
                  uncollapsed_upper_bound(uncollapsed_upper_bound_),
                  max_possible(max_possible_),
                  max_attained(max_attained_) {
            std::swap(items, items_);
        }

        ~Internal() { delete stats; }

        Xapian::Document get_doc_by_index(Xapian::doccount index) const;

        int convert_to_percent_internal(double wt) const;

        std::string snippet(const std::string & text, size_t length,
                            const Xapian::Stem & stemmer,
                            unsigned flags,
                            const std::string & hi_start,
                            const std::string & hi_end,
                            const std::string & omit) const;

        string get_description() const;

        void fetch_items(Xapian::doccount first, Xapian::doccount last) const;
};

class RSet::Internal : public Xapian::Internal::intrusive_base {
    friend class Xapian::RSet;

    private:
        set<Xapian::docid> items;

    public:
        const set<Xapian::docid> & get_items() const { return items; }

        string get_description() const;
};

}

#endif // OM_HGUARD_OMENQUIREINTERNAL_H