PLearn 0.1
ManualBinner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ManualBinner.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: ManualBinner.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00040 #ifndef ManualBinner_INC
00041 #define ManualBinner_INC
00042 
00043 #include "Binner.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 class ManualBinner: public Binner
00049 {
00050 protected:
00051     // *********************
00052     // * protected options *
00053     // *********************
00054 
00055     PP<RealMapping> the_mapping; 
00056     
00057 public:
00058 
00059     typedef Binner inherited;
00060 
00061     // ************************
00062     // * public build options *
00063     // ************************
00064 
00066     Vec bin_positions;
00067 
00068     // ****************
00069     // * Constructors *
00070     // ****************
00071 
00072     // Default constructor, make sure the implementation in the .cc
00073     // initializes all fields to reasonable default values.
00074     ManualBinner();
00075 
00077     ManualBinner(Vec bin_positions_);
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_OBJECT(ManualBinner);
00102 
00103     // ******************
00104     // * Binner methods *
00105     // ******************
00106 
00107 public:
00109     virtual PP<RealMapping> getBinning(VMat v) const;
00110 
00111     virtual PP<RealMapping> getBinning() const;
00112 
00113 };
00114 
00115 // Declares a few other classes and functions related to this class
00116 DECLARE_OBJECT_PTR(ManualBinner);
00117   
00118 } // end of namespace PLearn
00119 
00120 #endif
00121 
00122 
00123 /*
00124   Local Variables:
00125   mode:c++
00126   c-basic-offset:4
00127   c-file-style:"stroustrup"
00128   c-file-offsets:((innamespace . 0)(inline-open . 0))
00129   indent-tabs-mode:nil
00130   fill-column:79
00131   End:
00132 */
00133 // 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