PLearn 0.1
VecDictionary.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // VecDictionary.h
00004 //
00005 // Copyright (C) 2004 Hugo Larochelle Christopher Kermorvant
00006 // 
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 // 
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 // 
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 // 
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 // 
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 // 
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 /* *******************************************************      
00036  * $Id: VecDictionary.h 6338 2006-10-23 20:33:09Z larocheh $ 
00037  ******************************************************* */
00038 
00039 // Authors: Hugo Larochelle, Christopher Kermorvant
00040 
00044 #ifndef VecDictionary_INC
00045 #define VecDictionary_INC
00046 #include "Dictionary.h"
00047 
00048 #define NO_UPDATE 0
00049 #define UPDATE 1
00050 // Default mode for the dicionary
00051 #define DEFAULT_UPDATE 0
00052 
00053 namespace PLearn {
00054 using namespace std;
00055 
00060 class VecDictionary: public Dictionary
00061 {
00062 
00063 private:
00064   
00065     typedef Dictionary inherited;
00066 
00067 protected:
00068     // *********************
00069     // * protected options *
00070     // *********************
00071 
00072 public:
00073 
00074     // ************************
00075     // * public build options *
00076     // ************************
00078     TVec<string> vector_dict;
00079   
00080     // ****************
00081     // * Constructors *
00082     // ****************
00083 
00085     // ### Make sure the implementation in the .cc
00086     // ### initializes all fields to reasonable default values.
00087     VecDictionary();
00088 
00089 
00091 
00095     VecDictionary(TVec<string> symbols,bool up_mode=NO_UPDATE);
00096   
00097     // ******************
00098     // * Object methods *
00099     // ******************
00100 
00101 private: 
00103     void build_();
00104 
00105 protected: 
00107     static void declareOptions(OptionList& ol);
00108 
00109 public:
00110 
00111     PLEARN_DECLARE_OBJECT(VecDictionary);
00112 
00113     // simply calls inherited::build() then build_() 
00114     virtual void build();
00115 
00117     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00118 
00119 };
00120 
00121 // Declares a few other classes and functions related to this class
00122 DECLARE_OBJECT_PTR(VecDictionary);
00123   
00124 } // end of namespace PLearn
00125 
00126 #endif
00127 
00128 
00129 /*
00130   Local Variables:
00131   mode:c++
00132   c-basic-offset:4
00133   c-file-style:"stroustrup"
00134   c-file-offsets:((innamespace . 0)(inline-open . 0))
00135   indent-tabs-mode:nil
00136   fill-column:79
00137   End:
00138 */
00139 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines