PLearn 0.1
CubicSpline.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // CubicSpline.h
00004 //
00005 // Copyright (C) 2007 Christian Dorion
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: Christian Dorion
00036 //   Migrated from Johann Hibschman's <johann@physics.berkeley.edu> Python
00037 //   'spline' module.
00038 
00039 
00043 #ifndef CubicSpline_INC
00044 #define CubicSpline_INC
00045 
00046 #include <plearn_learners/generic/PLearner.h>
00047 
00048 namespace PLearn {
00049 
00060 class CubicSpline : public PLearner
00061 {
00062     typedef PLearner inherited;
00063 
00064 public:
00065     //#####  Public Build Options  ############################################
00066 
00068     real m_low_slope;
00069 
00071     real m_high_slope;
00072     
00073 
00074 public:
00075     //#####  Public Member Functions  #########################################
00076 
00078     CubicSpline();
00079 
00080 
00081     //#####  PLearner Member Functions  #######################################
00082 
00084     virtual int outputsize() const;
00085 
00089     virtual void forget();
00090 
00092     virtual void train();
00093 
00095     virtual void computeOutput(const Vec& input, Vec& output) const;
00096 
00098     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00099                                          const Vec& target, Vec& costs) const;
00100 
00103     virtual TVec<std::string> getTestCostNames() const;
00104 
00107     virtual TVec<std::string> getTrainCostNames() const;
00108 
00109 
00110     //#####  PLearn::Object Protocol  #########################################
00111 
00112     // Declares other standard object methods.
00113     PLEARN_DECLARE_OBJECT(CubicSpline);
00114 
00115     // Simply calls inherited::build() then build_()
00116     virtual void build();
00117 
00119     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00120 
00121 protected:
00122     //#####  Protected Options  ###############################################
00123 
00125     Vec m_inputs;
00126 
00128     Vec m_targets;    
00129     
00131     Vec m_coefficients;
00132 
00133 protected:
00134     //#####  Protected Member Functions  ######################################
00135 
00137     static void declareOptions(OptionList& ol);
00138 
00139 private:
00140     //#####  Private Member Functions  ########################################
00141 
00143     void build_();
00144 
00145 private:
00146     //#####  Private Data Members  ############################################
00147 
00148     // ...
00149 };
00150 
00151 // Declares a few other classes and functions related to this class
00152 DECLARE_OBJECT_PTR(CubicSpline);
00153 
00154 } // end of namespace PLearn
00155 
00156 #endif
00157 
00158 
00159 /*
00160   Local Variables:
00161   mode:c++
00162   c-basic-offset:4
00163   c-file-style:"stroustrup"
00164   c-file-offsets:((innamespace . 0)(inline-open . 0))
00165   indent-tabs-mode:nil
00166   fill-column:79
00167   End:
00168 */
00169 // 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