PLearn 0.1
Smoother.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // Smoother.h
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.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00040 #ifndef Smoother_INC
00041 #define Smoother_INC
00042 
00043 #include <plearn/base/Object.h>
00044 #include "TVec.h"
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 class Smoother: public Object
00050 {
00051 protected:
00052     // *********************
00053     // * protected options *
00054     // *********************
00055 
00056     // ### declare protected option fields (such as learnt parameters) here
00057     // ...
00058     
00059 public:
00060 
00061     typedef Object inherited;
00062 
00063     // ************************
00064     // * public build options *
00065     // ************************
00066 
00067     // ### declare public option fields (such as build options) here
00068     // ...
00069 
00070     // ****************
00071     // * Constructors *
00072     // ****************
00073 
00074     // Default constructor, make sure the implementation in the .cc
00075     // initializes all fields to reasonable default values.
00076     Smoother();
00077 
00078 
00079     // ******************
00080     // * Object methods *
00081     // ******************
00082 
00083 private: 
00085     // (Please implement in .cc)
00086     void build_();
00087 
00088 protected: 
00090     // (Please implement in .cc)
00091     static void declareOptions(OptionList& ol);
00092 
00093 public:
00094     // simply calls inherited::build() then build_() 
00095     virtual void build();
00096 
00098     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00099 
00101     PLEARN_DECLARE_ABSTRACT_OBJECT(Smoother);
00102 
00103 
00104     /****
00105      * Smoother methods
00106      */
00107 
00108 public:
00109     // The source function is either f(i) = source_function[i] as a function of i
00110     // or if bin_positions is provided (non-zero length), 
00111     //    f(x) = source_function[i]
00112     //      where i is s.t. bin_positions[i]>x>=bin_positions[i+1]
00113     // the optional bin_positions vector has length 0, or 1 more than source_function.
00114     // By default (if not provided) the dest_bin_positions are assumed the same as the source bin_positions.
00115     // Returns integral(smoothed_function).
00116     virtual real smooth(const Vec& source_function, Vec& smoothed_function, 
00117                         Vec bin_positions = Vec(), Vec dest_bin_positions = Vec()) const = 0;
00118 
00119     //   real smooth(const HistogramCDF& source_cdf, HistogramCDF& dest_cdf);
00120 
00121 };
00122 
00123 // Declares a few other classes and functions related to this class
00124 DECLARE_OBJECT_PTR(Smoother);
00125   
00126 } // end of namespace PLearn
00127 
00128 #endif
00129 
00130 
00131 /*
00132   Local Variables:
00133   mode:c++
00134   c-basic-offset:4
00135   c-file-style:"stroustrup"
00136   c-file-offsets:((innamespace . 0)(inline-open . 0))
00137   indent-tabs-mode:nil
00138   fill-column:79
00139   End:
00140 */
00141 // 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