postlist.h

Go to the documentation of this file.

 
/* Copyright (C) 2007-2022 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, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef XAPIAN_INCLUDED_POSTLIST_H
#define XAPIAN_INCLUDED_POSTLIST_H
 
#include <string>
 
#include "xapian/intrusive_ptr.h"
#include <xapian/types.h>
#include <xapian/postingiterator.h>
 
#include "backends/positionlist.h"
#include "weight/weightinternal.h"
 
class OrPositionList;
 
namespace Xapian {
namespace Internal {
 
class PostList {
    void operator=(const PostList &) = delete;
 
    PostList(const PostList &) = delete;
 
  protected:
    Xapian::doccount termfreq;
 
    PostList() { }
 
  public:
    virtual ~PostList();
 
    Xapian::doccount get_termfreq() const { return termfreq; }
 
    virtual Xapian::docid get_docid() const = 0;
 
    virtual Xapian::termcount get_wdf() const;
 
    virtual double get_weight(Xapian::termcount doclen,
                              Xapian::termcount unique_terms,
                              Xapian::termcount wdfdocmax) const = 0;
 
    virtual bool at_end() const = 0;
 
    virtual double recalc_maxweight() = 0;
 
    virtual PositionList * read_position_list();
 
    virtual PositionList * open_position_list() const;
 
    virtual PostList* next(double w_min) = 0;
 
    virtual PostList* skip_to(Xapian::docid did, double w_min) = 0;
 
    virtual PostList* check(Xapian::docid did, double w_min, bool &valid);
 
    PostList* next() { return next(0.0); }
 
    PostList* skip_to(Xapian::docid did) { return skip_to(did, 0.0); }
 
    virtual Xapian::termcount count_matching_subqs() const;
 
    virtual void gather_position_lists(OrPositionList* orposlist);
 
    virtual void get_docid_range(docid& first, docid& last) const;
 
    virtual std::string get_description() const = 0;
};
 
}
}
 
using Xapian::Internal::PostList;
 
#endif // XAPIAN_INCLUDED_POSTLIST_H