PLearn 0.1
SurfaceTemplateLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SurfaceTemplateLearner.h
00004 //
00005 // Copyright (C) 2006 Pascal Lamblin and Olivier Delalleau
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 and Olivier Delalleau
00036 
00040 #ifndef SurfaceTemplateLearner_INC
00041 #define SurfaceTemplateLearner_INC
00042 
00043 #include <plearn_learners/generic/NNet.h>
00044 #include "MoleculeTemplate.h"
00045 
00046 namespace PLearn {
00047 
00058 class SurfaceTemplateLearner : public NNet
00059 {
00060     typedef NNet inherited;
00061 
00062 public:
00063     //#####  Public Build Options  ############################################
00064 
00065     real min_feature_dev;
00066     real min_geom_dev;
00067 
00068     bool simple_mixture;
00069 
00070     VMat templates_source;
00071 
00072 protected:
00073     //#####  Protected Options  ###############################################
00074 
00075 public:
00076     //#####  Public Member Functions  #########################################
00077 
00079     SurfaceTemplateLearner();
00080 
00081     //#####  PLearner Member Functions  #######################################
00082 
00086     // virtual void forget();
00087 
00090     virtual void train();
00091 
00093     // virtual void computeOutput(const Vec& input, Vec& output) const;
00094 
00096     /*
00097     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00098                                          const Vec& target, Vec& costs) const;
00099                                          */
00100 
00102     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00103 
00105     virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs=0, VMat testcosts=0) const;
00106 
00107     // *** SUBCLASS WRITING: ***
00108     // While in general not necessary, in case of particular needs
00109     // (efficiency concerns for ex) you may also want to overload
00110     // some of the following methods:
00111     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, Vec& output, Vec& costs) const;
00112     // virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs) const;
00113     // virtual int nTestCosts() const;
00114     // virtual int nTrainCosts() const;
00115     // virtual void resetInternalState();
00116     // virtual bool isStatefulLearner() const;
00117 
00118     //#####  PLearn::Object Protocol  #########################################
00119 
00120     // Declares other standard object methods.
00121     PLEARN_DECLARE_OBJECT(SurfaceTemplateLearner);
00122 
00123     // Simply calls inherited::build() then build_()
00124     virtual void build();
00125 
00127     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00128 
00129 protected:
00130     //#####  Protected Member Functions  ######################################
00131 
00133     static void declareOptions(OptionList& ol);
00134 
00135 private:
00136     //#####  Private Member Functions  ########################################
00137 
00139     void build_();
00140 
00141 private:
00142     //#####  Private Data Members  ############################################
00143 
00144     // The rest of the private stuff goes here
00145 };
00146 
00147 // Declares a few other classes and functions related to this class
00148 DECLARE_OBJECT_PTR(SurfaceTemplateLearner);
00149 
00150 } // end of namespace PLearn
00151 
00152 #endif
00153 
00154 
00155 /*
00156   Local Variables:
00157   mode:c++
00158   c-basic-offset:4
00159   c-file-style:"stroustrup"
00160   c-file-offsets:((innamespace . 0)(inline-open . 0))
00161   indent-tabs-mode:nil
00162   fill-column:79
00163   End:
00164 */
00165 // 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