FsaAccessHeader.h

Go to the documentation of this file.

// Copyright 2002-2013 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
/***************************************************************************
                          compactDict.h  -  description
                             -------------------
    begin                : mer mai 28 2003
    copyright            : (C) 2003 by Olivier Mesnard
    email                : olivier.mesnard@cea.fr
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *  Compact dictionnary based on finite state automata implemented with    *
 *  Boost Graph library.                                                   *
 *  Algorithm is described in article from Daciuk, Mihov, Watson & Watson: *
 *  "Incremental Construction of Minimal Acyclic Finite State Automata"    *
 *  How to use it to compute hash code is explained in  'perfect hashing' *
 *  of document http://odur.let.rug.nl/alfa/fsa_stuff/#PerfHash            *
 *                                                                         *
 ***************************************************************************/
 
#ifndef FSA_ACCESS_HEADER_H
#define FSA_ACCESS_HEADER_H
 
// From standard library
#include <string>
#include "common/FsaAccess/FsaExceptions.h"
 
namespace Lima {
namespace Common {
namespace FsaAccess {
 
enum char_order_type {FORWARD=0,REVERSE=1};
enum dict_packing_type {BUILDER=0,BUILT=1,SPARE=2} ;
 
#define MAGIC_NUMBER "limaFsaDict"
#define HEADER_SIZE 1024
// we autorize around 100 millions simple terms
// higher ids are reserved to identify complex terms  (compound words)
#define MAX_SIMPLE_TID 100000000
 
#define VERTEX_PROPERTY_16 uint64_t
#define MAJOR_VERSION_16 2
#define MINOR_VERSION_16 0
 
class AbstractFsaAccessIStreamWrapper;
class AbstractFsaAccessOStreamWrapper;
 
class FsaAccessHeaderPrivate;
class LIMA_FSAACCESS_EXPORT FsaAccessHeader {
  public:
    FsaAccessHeader(bool trie_direction_fwd);
    virtual ~FsaAccessHeader();
    void read( AbstractFsaAccessIStreamWrapper& iw );
    void write( AbstractFsaAccessOStreamWrapper& ow);
    bool getTrieDirectionForward() const;
    uint64_t getNbVertices() const;
    uint64_t getNbEdges() const;
    void setPackingStatus(uint8_t packingStatus);
    void setNbVertices(uint64_t nbVerts);
    void setNbEdges(uint64_t nbEdges);
//    uint64_t getMaxSimpleId() const;
//    uint64_t  int getCompoundsDataOffset();
//    uint64_t getNbCompounds() const;
//    void setStreamPos(std::ifstream& is);
//    const long& getStreamPos();
protected:
  FsaAccessHeader(const FsaAccessHeader& h);
  FsaAccessHeader& operator=(const FsaAccessHeader& h);
  FsaAccessHeaderPrivate* m_d;
};
 
} // namespace FsaAccess
} // namespace Common
} // namespace Lima
 
#endif   //FSA_ACCESS_HEADER_H