CompactFV.H

Go to the documentation of this file.

// Copyright (C) 2001, Compaq Computer Corporation
// 
// This file is part of Vesta.
// 
// Vesta is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// 
// Vesta 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
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with Vesta; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

// Created on Mon Mar 30 11:34:17 PST 1998 by heydon
// Last modified on Tue Aug  3 14:01:36 EDT 2004 by ken@xorian.net
//      modified on Fri May  8 14:55:48 PDT 1998 by heydon

#ifndef _COMPACT_FV_H
#define _COMPACT_FV_H

/* This class defines an alternative, compact representation
   for a sequence of names. The names are represented by a
   "PrefixTbl" paired with two arrays. The first array gives
   the indices of the names in the "PrefixTbl", and the second
   array gives the one-character prefix for each name. */

#include <Basics.H>
#include <SRPC.H>
#include <FS.H>
#include "FV.H"
#include "PrefixTbl.H"
#include "BitVector.H"

namespace CompactFV
{
  class List {
  public:
    PrefixTbl tbl;              // table of names
    Basics::int16 num;  // cardinality of "idx" and "types"
    Basics::int16 *idx; // indices of names in "tbl"; has length "num"
    char *types;                // array of types; has length "num"
    // NOTE: Both "idx" and "types" may be NULL if "num == 0".

    List() throw () { /*SKIP*/; }
    List(const FV::List &names) throw (PrefixTbl::Overflow);
    /* Initialize this "CompactFV::List" to represent the
       names "names". */

    List(SRPC &srpc) throw (SRPC::failure)
    { this->Recv(srpc); }
    List(std::ifstream &ifs) throw (FS::Failure, FS::EndOfFile)
    { this->Read(ifs); }

    // convert to FV::List
    void ToFVList(/*INOUT*/ FV::ListApp &fvl) const throw ();
    /* Append the names in this "CompactFV::List" to "fvl", which is
       required to be empty. */

    // write/read
    void Write(std::ostream &ofs) const throw (FS::Failure);
    void Read(std::istream &ifs) throw (FS::EndOfFile, FS::Failure);

    // send/receive
    void Send(SRPC &sprc) const throw (SRPC::failure);
    void Recv(SRPC &sprc) throw (SRPC::failure);

    // print
    void Print(std::ostream &os, int indent) const throw ();
  };
}

#endif // _COMPACT_FV_H

---