PLearn 0.1
DEPRECATED/RBMLayer.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMLayer.cc
00004 //
00005 // Copyright (C) 2006 Pascal Lamblin & Dan Popovici
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 // Authors: Pascal Lamblin & Dan Popovici
00036 
00039 #include "RBMLayer.h"
00040 #include <plearn/math/TMat_maths.h>
00041 #include <plearn/math/PRandom.h>
00042 #include "RBMParameters.h"
00043 
00044 namespace PLearn {
00045 using namespace std;
00046 
00047 PLEARN_IMPLEMENT_ABSTRACT_OBJECT(
00048     RBMLayer,
00049     "Virtual class for a layer of an RBM",
00050     "");
00051 
00052 RBMLayer::RBMLayer() :
00053     size(-1),
00054     expectation_is_up_to_date(false)
00055 {
00056 }
00057 
00058 void RBMLayer::reset()
00059 {
00060     activations.clear();
00061     sample.clear();
00062     expectation.clear();
00063     expectation_is_up_to_date = false;
00064 }
00065 
00066 void RBMLayer::declareOptions(OptionList& ol)
00067 {
00068     declareOption(ol, "units_types", &RBMLayer::units_types,
00069                   OptionBase::learntoption,
00070                   "Each character of this string describes the type of an"
00071                   " up unit:\n"
00072                   "  - 'l' if the energy function of this unit is linear\n"
00073                   "    (binomial or multinomial unit),\n"
00074                   "  - 'q' if it is quadratic (for a gaussian unit).\n");
00075 
00076     declareOption(ol, "random_gen", &RBMLayer::random_gen,
00077                   OptionBase::buildoption,
00078                   "Random generator.");
00079 
00080     declareOption(ol, "size", &RBMLayer::size,
00081                   OptionBase::buildoption,
00082                   "Numer of units.");
00083 
00084 
00085     // Now call the parent class' declareOptions
00086     inherited::declareOptions(ol);
00087 }
00088 
00089 void RBMLayer::build_()
00090 {
00091     if( size <= 0 )
00092         return;
00093 
00094     if( !random_gen )
00095         random_gen = new PRandom();
00096     random_gen->build();
00097 }
00098 
00099 void RBMLayer::build()
00100 {
00101     inherited::build();
00102     build_();
00103 }
00104 
00105 
00106 void RBMLayer::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00107 {
00108     inherited::makeDeepCopyFromShallowCopy(copies);
00109 
00110     deepCopyField(random_gen, copies);
00111     deepCopyField(activations, copies);
00112     deepCopyField(sample, copies);
00113     deepCopyField(expectation, copies);
00114 }
00115 
00116 
00117 } // end of namespace PLearn
00118 
00119 
00120 /*
00121   Local Variables:
00122   mode:c++
00123   c-basic-offset:4
00124   c-file-style:"stroustrup"
00125   c-file-offsets:((innamespace . 0)(inline-open . 0))
00126   indent-tabs-mode:nil
00127   fill-column:79
00128   End:
00129 */
00130 // 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