Dictionary.h

Go to the documentation of this file.

// -*- C++ -*-

// Dictionary.h
//
// Copyright (C) 2004 Hugo Larochelle Christopher Kermorvant
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org

/* *******************************************************      
   * $Id: Dictionary.h,v 1.2 2004/08/13 15:16:34 kermorvc Exp $ 
   ******************************************************* */

// Authors: Hugo Larochelle, Christopher Kermorvant

#ifndef Dictionary_INC
#define Dictionary_INC
#include <plearn/base/stringutils.h>
#include <plearn/base/Object.h>
#include <map>
#include <string>
#include <plearn_learners/language/WordNet/WordNetOntology.h>

#define VECTOR_DICTIONARY   1
#define FILE_DICTIONARY     2
#define WORDNET_WORD_DICTIONARY  3
#define WORDNET_SENSE_DICTIONARY 4

#define NO_UPDATE 0
#define UPDATE 1
#define DEFAULT_UPDATE 0

// For words only
#define NO_STEM 0
#define STEM 1
#define OOV_TAG "<oov>"

//for WordNet senses only
// No sense exists for this word
#define NO_SENSE -1
// Sense exists but is hidden (un-known)
#define HIDDEN_SENSE 0

namespace PLearn {
using namespace std;

class Dictionary: public Object
{

private:
  
  typedef Object inherited;

protected:
  // *********************
  // * protected options *
  // *********************

  // ### declare protected option fields (such as learnt parameters) here
  // ...
    
public:

  // ************************
  // * public build options *
  // ************************

  map<string,int> string_to_int;
  map<int,string> int_to_string;
  WordNetOntology *wno;
  int dict_type;
  int update_mode;
  int stem_mode;
  string file_name_dict;
  TVec<string> vector_dict;
  
  // ### declare public option fields (such as build options) here
  // ...

  // ****************
  // * Constructors *
  // ****************

  // ### Make sure the implementation in the .cc
  // ### initializes all fields to reasonable default values.
  Dictionary();



  Dictionary(string file_name,bool up_mode=DEFAULT_UPDATE);


  Dictionary(TVec<string> symbols,bool up_mode=DEFAULT_UPDATE);
  

  Dictionary(WordNetOntology *ont,int ontology_type,bool up_mode=DEFAULT_UPDATE, bool stem =NO_STEM);
    
  
  // ******************
  // * Object methods *
  // ******************

private: 
  void build_();

protected: 
  static void declareOptions(OptionList& ol);

public:
  // Declares other standard object methods.
  // ### If your class is not instantiatable (it has pure virtual methods)
  // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
  PLEARN_DECLARE_OBJECT(Dictionary);

  int size();

  void  setUpdateMode(bool up_mode);

  void  setStemMode(bool stem);
    
  void  setDictionaryType(int type);

  int getId(string symbol);
  
  string getSymbol(int id);
  
  // simply calls inherited::build() then build_() 
  virtual void build();

  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);

};

// Declares a few other classes and functions related to this class
DECLARE_OBJECT_PTR(Dictionary);
  
} // end of namespace PLearn

#endif

---