PLearn 0.1
FileDictionary.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // FileDictionary.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: FileDictionary.h 6338 2006-10-23 20:33:09Z larocheh $ 
00037  ******************************************************* */
00038 
00039 // Authors: Hugo Larochelle, Christopher Kermorvant
00040 
00044 #ifndef FileDictionary_INC
00045 #define FileDictionary_INC
00046 #include "Dictionary.h"
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00056 class FileDictionary: public Dictionary
00057 {
00058 
00059 private:
00060   
00061     typedef Dictionary inherited;
00062 
00063 protected:
00064     // *********************
00065     // * protected options *
00066     // *********************
00067 
00068 public:
00069 
00070     // ************************
00071     // * public build options *
00072     // ************************
00074     string file_name_dict;
00075     
00076     // ****************
00077     // * Constructors *
00078     // ****************
00079 
00081     // ### Make sure the implementation in the .cc
00082     // ### initializes all fields to reasonable default values.
00083     FileDictionary();
00084 
00085 
00087 
00091     FileDictionary(string file_name,bool up_mode=NO_UPDATE);
00092 
00093     // ******************
00094     // * Object methods *
00095     // ******************
00096 
00097 private: 
00099     void build_();
00100 
00101 protected: 
00103     static void declareOptions(OptionList& ol);
00104 
00105 public:
00106     // Declares other standard object methods.
00107     PLEARN_DECLARE_OBJECT(FileDictionary);
00108 
00109     // simply calls inherited::build() then build_() 
00110     virtual void build();
00111 
00113     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00114 
00115 };
00116 
00117 // Declares a few other classes and functions related to this class
00118 DECLARE_OBJECT_PTR(FileDictionary);
00119   
00120 } // end of namespace PLearn
00121 
00122 #endif
00123 
00124 
00125 /*
00126   Local Variables:
00127   mode:c++
00128   c-basic-offset:4
00129   c-file-style:"stroustrup"
00130   c-file-offsets:((innamespace . 0)(inline-open . 0))
00131   indent-tabs-mode:nil
00132   fill-column:79
00133   End:
00134 */
00135 // 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