PLearn 0.1
SymbolNode.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SymbolNode.h
00004 //
00005 // Copyright (C) 2004 Hugo Larochelle
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: SymbolNode.h 5865 2006-06-14 18:13:50Z larocheh $
00037  ******************************************************* */
00038 
00039 // Authors: Hugo Larochelle
00040 
00044 #ifndef SymbolNode_INC
00045 #define SymbolNode_INC
00046 
00047 #include <plearn/base/Object.h>
00048 #include <plearn/base/ms_hash_wrapper.h>
00049 
00050 namespace PLearn {
00051 using namespace std;
00052 
00053 class SymbolNode: public Object
00054 {
00055 
00056 private:
00057 
00058     typedef Object inherited;
00059 
00060 protected:
00061     // *********************
00062     // * protected options *
00063     // *********************
00064 
00066     int frequence;
00067 
00069     map<int,PP<SymbolNode> > children;
00070     map<int,int> frequencies;
00071 
00072 public:
00073 
00074     // ************************
00075     // * public build options *
00076     // ************************
00077 
00078     int symbol;
00079 
00080     // ****************
00081     // * Constructors *
00082     // ****************
00083 
00085     SymbolNode();
00086 
00087     SymbolNode(int symbol_);
00088 
00089     // ******************
00090     // * Object methods *
00091     // ******************
00092 
00093 private:
00095     void build_();
00096 
00097 protected:
00099     static void declareOptions(OptionList& ol);
00100 
00101 public:
00102     // Declares other standard object methods.
00103     PLEARN_DECLARE_OBJECT(SymbolNode);
00104 
00105     // simply calls inherited::build() then build_()
00106     virtual void build();
00107 
00109     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00110 
00112     PP<SymbolNode> add(int child_);
00113 
00115     void incr(){frequence++;}
00116 
00118     void incr(int symbol);
00119 
00121     int freq(){return frequence;}
00122 
00124     int freq(int symbol);
00125 
00127     int n_children(){return children.size();}
00128 
00130     int n_freq(){return frequencies.size();}
00131 
00133     map<int,int>* freqs(){ return &frequencies;}
00134 
00136     PP<SymbolNode> child(int child_);
00137 
00139     TVec<PP<SymbolNode> > getChildren();
00140 
00141 };
00142 
00143 // Declares a few other classes and functions related to this class
00144 DECLARE_OBJECT_PTR(SymbolNode);
00145 
00146 } // end of namespace PLearn
00147 
00148 #endif
00149 
00150 
00151 /*
00152   Local Variables:
00153   mode:c++
00154   c-basic-offset:4
00155   c-file-style:"stroustrup"
00156   c-file-offsets:((innamespace . 0)(inline-open . 0))
00157   indent-tabs-mode:nil
00158   fill-column:79
00159   End:
00160 */
00161 // 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