autoDoc/HTML/---libInvertedFile-include-CIFListReader-h

    /* -*- mode: c++ -*-
    */
    /*

        GIFT, a flexible content based image retrieval system.
        Copyright (C) 1998, 1999, 2000 CUI, University of Geneva

        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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    */
    /***************************************
    *
    *
    *
    ****************************************
    *
    * modification history:
    *
    * HM 090399 created the documentation
    *
    ****************************************
    *
    * compiler defines used:
    *
    *
    ****************************************/
    #ifndef _CIFLISTREADER
    #define _CIFLISTREADER

    class CInvertedFileAccessor;
    class CWeightingFunction;

    #include "CIFListStart.h"

    /** */
    class CIFListReader{

      /** */
      istream& mInvertedFile;
      /** */
      CInvertedFileAccessor& mAccessor;
      /** */
      CWeightingFunction& mWeightingFunction;

      /** */
      CIFListStart* mListStart;
    public:
      /***************************************
       *
       *
       *
       ***************************************/
      CIFListReader(TID inID,
    		const CInvertedFileAccessor& inAccessor,
    		const CWeightingFunction& inWF);

      /***************************************
       *
       *
       *
       ***************************************/
      void goToFirst();

      /***************************************
       *
       *
       *
       ***************************************/
      double getCurrentBest()const;

      /***************************************
       *
       *
       *
       ***************************************/
      double popCurrentBest()const;

      /***************************************
       *
       *
       *
       ***************************************/
      operator bool()const;

    };

    /**for CIFListReaders
     */
    operator<(const CIFListReader& l,
    	  const CIFListReader& t);
    #endif