/usr/include/xapian/postingiterator.h is in libxapian-dev 1.2.16-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | /** \file postingiterator.h
* \brief Classes for iterating through posting lists
*/
/* Copyright 1999,2000,2001 BrightStation PLC
* Copyright 2002 Ananova Ltd
* Copyright 2003,2004,2005,2007,2008,2009,2012 Olly Betts
*
* 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_POSTINGITERATOR_H
#define XAPIAN_INCLUDED_POSTINGITERATOR_H
#include <iterator>
#include <string>
#include <xapian/base.h>
#include <xapian/derefwrapper.h>
#include <xapian/types.h>
#include <xapian/positioniterator.h>
#include <xapian/visibility.h>
namespace Xapian {
class Database;
/** An iterator pointing to items in a list of postings.
*/
class XAPIAN_VISIBILITY_DEFAULT PostingIterator {
public:
class Internal;
/// @private @internal Reference counted internals.
Xapian::Internal::RefCntPtr<Internal> internal;
private:
friend class Database; // So Database can construct us
explicit PostingIterator(Internal *internal_);
public:
friend bool operator==(const PostingIterator &a,
const PostingIterator &b);
/// Default constructor - for declaring an uninitialised iterator
PostingIterator();
/// Destructor
~PostingIterator();
/** Copying is allowed. The internals are reference counted, so
* copying is also cheap.
*/
PostingIterator(const PostingIterator &other);
/** Assignment is allowed. The internals are reference counted,
* so assignment is also cheap.
*/
void operator=(const PostingIterator &other);
/// Advance the iterator to the next position.
PostingIterator & operator++();
/// Advance the iterator to the next position (postfix version).
DerefWrapper_<docid> operator++(int) {
Xapian::docid tmp = **this;
operator++();
return DerefWrapper_<docid>(tmp);
}
/** Advance the iterator to the specified docid.
*
* If the specified docid isn't in the list, position ourselves on the
* first document after it (or at_end() if no greater docids are
* present).
*/
void skip_to(Xapian::docid did);
/// Get the document id at the current position in the postlist.
Xapian::docid operator *() const;
/** Get the length of the document at the current position in the
* postlist.
*
* This information may be stored in the postlist, in which case
* this lookup should be extremely fast (indeed, not require further
* disk access). If the information is not present in the postlist,
* it will be retrieved from the database, at a greater performance
* cost.
*/
Xapian::termcount get_doclength() const;
/** Get the within document frequency of the document at the
* current position in the postlist.
*/
Xapian::termcount get_wdf() const;
/** Return PositionIterator pointing to start of positionlist for
* current document.
*/
PositionIterator positionlist_begin() const;
/** Return PositionIterator pointing to end of positionlist for
* current document.
*/
PositionIterator positionlist_end() const {
return PositionIterator();
}
// Don't expose these methods here. A container iterator doesn't
// provide a method to find the size of the container...
// Xapian::doccount get_termfreq() const;
// Xapian::termcount get_collection_freq() const;
/// Return a string describing this object.
std::string get_description() const;
/// Allow use as an STL iterator
//@{
typedef std::input_iterator_tag iterator_category;
typedef Xapian::docid value_type;
typedef Xapian::doccount_diff difference_type;
typedef Xapian::docid * pointer;
typedef Xapian::docid & reference;
//@}
};
/// Test equality of two PostingIterators
inline bool operator==(const PostingIterator &a, const PostingIterator &b)
{
return (a.internal.get() == b.internal.get());
}
/// Test inequality of two PostingIterators
inline bool operator!=(const PostingIterator &a, const PostingIterator &b)
{
return !(a == b);
}
}
#endif /* XAPIAN_INCLUDED_POSTINGITERATOR_H */
|