PLearn 0.1
SoftHistogramBinner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SoftHistogramBinner.h
00004 //
00005 // Copyright (C) 2004 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 /* *******************************************************      
00036  * $Id: SoftHistogramBinner.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #ifndef SoftHistogramBinner_INC
00045 #define SoftHistogramBinner_INC
00046 
00047 #include <plearn/math/Binner.h>
00048 
00049 namespace PLearn {
00050 
00051 class SoftHistogramBinner: public Binner
00052 {
00053 
00054 private:
00055 
00056     typedef Binner inherited;  
00057 
00058 protected:
00059 
00060     // *********************
00061     // * protected options *
00062     // *********************
00063 
00064     // ### declare protected option fields (such as learnt parameters) here
00065     // ...
00066     
00067 public:
00068 
00069     // ************************
00070     // * public build options *
00071     // ************************
00072 
00073     int n_bins;
00074     real samples_per_bin;
00075 
00076     // ****************
00077     // * Constructors *
00078     // ****************
00079 
00081     // ### make sure the implementation in the .cc
00082     // ### initializes all fields to reasonable default values.
00083     SoftHistogramBinner();
00084 
00085     // ******************
00086     // * Object methods *
00087     // ******************
00088 
00089 private: 
00090 
00092     // (Please implement in .cc)
00093     void build_();
00094 
00095 protected: 
00096 
00098     // (Please implement in .cc)
00099     static void declareOptions(OptionList& ol);
00100 
00101 public:
00102 
00103     // Simply calls inherited::build() then build_().
00104     virtual void build();
00105 
00107     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00108 
00110     PLEARN_DECLARE_OBJECT(SoftHistogramBinner);
00111 
00112     // ******************
00113     // * Binner methods *
00114     // ******************
00115 
00116 public:
00117 
00118     /*
00120     virtual PP<RealMapping> getBinning(VMat v) const;
00121     */
00122 
00125     virtual TVec< TVec<int> > getBins(const Vec& v) const;
00126 
00128     virtual int nBins() const;
00129 
00130 };
00131 
00132 // Declares a few other classes and functions related to this class
00133 DECLARE_OBJECT_PTR(SoftHistogramBinner);
00134   
00135 } // end of namespace PLearn
00136 
00137 #endif
00138 
00139 
00140 /*
00141   Local Variables:
00142   mode:c++
00143   c-basic-offset:4
00144   c-file-style:"stroustrup"
00145   c-file-offsets:((innamespace . 0)(inline-open . 0))
00146   indent-tabs-mode:nil
00147   fill-column:79
00148   End:
00149 */
00150 // 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