common/rset.h

Go to the documentation of this file.

/* rset.h
 *
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2003,2005,2006 Olly Betts
 * Copyright 2007 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 OM_HGUARD_RSET_H
#define OM_HGUARD_RSET_H

#include <set>
#include <map>
#include "omassert.h"
#include "omdebug.h"
#include "xapian/enquire.h"
#include "omenquireinternal.h"

// Forward declaration.
class Stats;

class RSetI {
    private:
        // disallow copy
        RSetI(const RSetI &);
        void operator=(const RSetI &);

        // FIXME: should use one or the other (probably Xapian::Database)
        const Xapian::Database root;
        const Xapian::Database::Internal *dbroot;

        std::map<string, Xapian::doccount> reltermfreqs;
        bool calculated_reltermfreqs;

        void calculate_stats();
    public:
        std::set<Xapian::docid> documents;

        RSetI(const Xapian::Database &root_, const Xapian::RSet & rset);
        RSetI(const Xapian::Database::Internal *dbroot_, const Xapian::RSet & rset);

        void will_want_reltermfreq(string tname);

        void contribute_stats(Stats & stats);

        Xapian::doccount get_rsize() const;
};

// Inline method definitions //

inline
RSetI::RSetI(const Xapian::Database &root_, const Xapian::RSet & rset)
        : root(root_), dbroot(NULL), calculated_reltermfreqs(false),
          documents(rset.internal->get_items())
{
}

inline
RSetI::RSetI(const Xapian::Database::Internal *dbroot_, const Xapian::RSet & rset)
        : dbroot(dbroot_), calculated_reltermfreqs(false),
          documents(rset.internal->get_items())
{
}

inline void
RSetI::will_want_reltermfreq(string tname)
{
    reltermfreqs[tname] = 0;
}

inline Xapian::doccount
RSetI::get_rsize() const
{
    return documents.size();
}

#endif /* OM_HGUARD_RSET_H */

---