ph_types.h

Go to the documentation of this file.

// -*- C++ -*-
/*
  Phrasehunter - index and query text corpora
  Copyright (C) 2006  Torsten Marek (shlomme@gmx.de) &
                      Armin Schmidt (armin.sch@gmail.com)
  
  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 Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

/**
   \file py_types.h
   \brief global type definitions, constants, and forward decls
*/

#ifndef PH_TYPES 
#define PH_TYPES PH_TYPES

#include <vector>
#include <map>
#include <boost/shared_ptr.hpp>

namespace PhraseHunter 
{

class TextSaver;
class IndexManager;
class Token;
class Tokenizer;
class CorpusManager;
class SearchEngine;
class StatisticsEngine;
class ContextReader;
class TokenContext;

//! The ID of a document in the data base.
typedef uint32_t DocID;
//! The ID of Token in the data base.
typedef uint32_t TokenID;
//! The byte offset of a Token in a document.
typedef uint32_t IdxPos;

//! The positions of a Token in a document.
typedef std::vector<IdxPos> PositionList;
//! Documents and positions for a Token.
typedef std::map<DocID, PositionList> OccurrenceMap;

//! Pointer to a Token object.
typedef boost::shared_ptr<Token> TokenPtr;
//! Pointer to a TokenContext object.
typedef boost::shared_ptr<TokenContext> TokenContextPtr;

//! A vector of TokenPtr
typedef std::vector<TokenPtr> TokenVector;

static const TokenID InvalidTokenID = 0;
static const DocID InvalidDocID = 0;

}


#endif // PH_TYPES

---