PLearn 0.1
Smoother.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // Smoother.cc
00004 // 
00005 // Copyright (C) 2002 Xavier Saint-Mleux
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: Smoother.cc 6861 2007-04-09 19:04:15Z saintmlx $ 
00037  ******************************************************* */
00038 
00040 #include "Smoother.h"
00041 
00042 namespace PLearn {
00043 using namespace std;
00044 
00045 Smoother::Smoother() 
00046     :Object()
00047 /* ### Initialise all fields to their default value */
00048 {
00049     // ...
00050 
00051     // ### You may or may not want to call build_() to finish building the object
00052     // build_();
00053 }
00054 
00055 
00056 PLEARN_IMPLEMENT_ABSTRACT_OBJECT(Smoother, "ONE LINE DESCR", "NO HELP");
00057 
00058 void Smoother::declareOptions(OptionList& ol)
00059 {
00060     // ### Declare all of this object's options here
00061     // ### For the "flags" of each option, you should typically specify  
00062     // ### one of OptionBase::buildoption, OptionBase::learntoption or 
00063     // ### OptionBase::tuningoption. Another possible flag to be combined with
00064     // ### is OptionBase::nosave
00065 
00066     // ### ex:
00067     // declareOption(ol, "myoption", &Smoother::myoption, OptionBase::buildoption,
00068     //               "Help text describing this option");
00069     // ...
00070 
00071     // Now call the parent class' declareOptions
00072     inherited::declareOptions(ol);
00073 }
00074 
00075 void Smoother::build_()
00076 {
00077     // ### This method should do the real building of the object,
00078     // ### according to set 'options', in *any* situation. 
00079     // ### Typical situations include:
00080     // ###  - Initial building of an object from a few user-specified options
00081     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00082     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00083     // ### You should assume that the parent class' build_() has already been called.
00084 }
00085 
00086 // ### Nothing to add here, simply calls build_
00087 void Smoother::build()
00088 {
00089     inherited::build();
00090     build_();
00091 }
00092 
00093 
00094 void Smoother::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00095 {
00096     inherited::makeDeepCopyFromShallowCopy(copies);
00097 
00098     // ### Call deepCopyField on all "pointer-like" fields 
00099     // ### that you wish to be deepCopied rather than 
00100     // ### shallow-copied.
00101     // ### ex:
00102     // deepCopyField(trainvec, copies);
00103 
00104     // ### Remove this line when you have fully implemented this method.
00105     PLERROR("Smoother::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
00106 }
00107 
00108 } // end of namespace PLearn
00109 
00110 
00111 /*
00112   Local Variables:
00113   mode:c++
00114   c-basic-offset:4
00115   c-file-style:"stroustrup"
00116   c-file-offsets:((innamespace . 0)(inline-open . 0))
00117   indent-tabs-mode:nil
00118   fill-column:79
00119   End:
00120 */
00121 // 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