leafpostlist.h

Go to the documentation of this file.

/* Copyright (C) 2007,2009,2011,2013,2015,2016,2020 Olly Betts
 * Copyright (C) 2009 Lemur Consulting Ltd
 *
 * 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 XAPIAN_INCLUDED_LEAFPOSTLIST_H
#define XAPIAN_INCLUDED_LEAFPOSTLIST_H

#include "postlist.h"

#include <algorithm>
#include <string>

namespace Xapian {
    class Weight;
}

class LeafPostList : public PostList {
    void operator=(const LeafPostList &);

    LeafPostList(const LeafPostList &);

  protected:
    const Xapian::Weight * weight;

    bool need_doclength, need_unique_terms;

    std::string term;

    explicit LeafPostList(const std::string & term_)
        : weight(0), need_doclength(false), need_unique_terms(false),
          term(term_) { }

  public:
    ~LeafPostList();

    void set_termweight(const Xapian::Weight * weight_);

    double resolve_lazy_termweight(Xapian::Weight * weight_,
                                   Xapian::Weight::Internal * stats,
                                   Xapian::termcount qlen,
                                   Xapian::termcount wqf,
                                   double factor)
    {
        weight_->init_(*stats, qlen, term, wqf, factor, this);
        // There should be an existing LazyWeight set already.
        Assert(weight);
        const Xapian::Weight * const_weight_ = weight_;
        std::swap(weight, const_weight_);
        delete const_weight_;
        need_doclength = weight->get_sumpart_needs_doclength_();
        // We get such terms from the database so they should exist.
        Assert(get_termfreq() > 0);
        double result = weight->get_maxpart();
        double& max_part = stats->termfreqs[term].max_part;
        max_part = std::max(max_part, result);
        return result;
    }

    virtual Xapian::doccount get_termfreq() const = 0;

    Xapian::doccount get_termfreq_min() const;
    Xapian::doccount get_termfreq_max() const;
    Xapian::doccount get_termfreq_est() const;

    double get_maxweight() const;
    double get_weight() const;
    double recalc_maxweight();

    TermFreqs get_termfreq_est_using_stats(
        const Xapian::Weight::Internal & stats) const;

    Xapian::termcount count_matching_subqs() const;

    void gather_position_lists(OrPositionList* orposlist);

    virtual LeafPostList * open_nearby_postlist(const std::string & term_) const;

    virtual Xapian::termcount get_wdf_upper_bound() const = 0;

    void set_term(const std::string & term_) { term = term_; }
};

#endif // XAPIAN_INCLUDED_LEAFPOSTLIST_H