00001 00002 00003 // -*- C++ -*- 00004 00005 // Binner.h 00006 // 00007 // Copyright (C) *YEAR* *AUTHOR(S)* 00008 // ... 00009 // Copyright (C) *YEAR* *AUTHOR(S)* 00010 // 00011 // Redistribution and use in source and binary forms, with or without 00012 // modification, are permitted provided that the following conditions are met: 00013 // 00014 // 1. Redistributions of source code must retain the above copyright 00015 // notice, this list of conditions and the following disclaimer. 00016 // 00017 // 2. Redistributions in binary form must reproduce the above copyright 00018 // notice, this list of conditions and the following disclaimer in the 00019 // documentation and/or other materials provided with the distribution. 00020 // 00021 // 3. The name of the authors may not be used to endorse or promote 00022 // products derived from this software without specific prior written 00023 // permission. 00024 // 00025 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00026 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00027 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 00028 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00029 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 00030 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00031 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00032 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00033 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00034 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00035 // 00036 // This file is part of the PLearn library. For more information on the PLearn 00037 // library, go to the PLearn Web site at www.plearn.org 00038 00039 /* ******************************************************* 00040 * $Id: Binner.h,v 1.7 2004/07/21 16:30:53 chrish42 Exp $ 00041 ******************************************************* */ 00042 00044 #ifndef Binner_INC 00045 #define Binner_INC 00046 00047 #include <plearn/base/Object.h> 00048 #include <plearn/vmat/VMat.h> 00049 #include <plearn/base/RealMapping.h> 00050 00051 namespace PLearn { 00052 using namespace std; 00053 00054 class Binner: public Object 00055 { 00056 protected: 00057 // ********************* 00058 // * protected options * 00059 // ********************* 00060 00061 // ### declare protected option fields (such as learnt parameters) here 00062 // ... 00063 00064 public: 00065 00066 typedef Object inherited; 00067 00068 // ************************ 00069 // * public build options * 00070 // ************************ 00071 00072 // ### declare public option fields (such as build options) here 00073 // ... 00074 00075 // **************** 00076 // * Constructors * 00077 // **************** 00078 00079 // Default constructor, make sure the implementation in the .cc 00080 // initializes all fields to reasonable default values. 00081 Binner(); 00082 00083 00084 // ****************** 00085 // * Object methods * 00086 // ****************** 00087 00088 private: 00090 // (Please implement in .cc) 00091 void build_(); 00092 00093 protected: 00095 // (Please implement in .cc) 00096 static void declareOptions(OptionList& ol); 00097 00098 public: 00099 // simply calls inherited::build() then build_() 00100 virtual void build(); 00101 00103 virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies); 00104 00106 virtual PP<RealMapping> getBinning(VMat v) const; 00107 00109 PLEARN_DECLARE_OBJECT(Binner); 00110 00111 }; 00112 00113 // Declares a few other classes and functions related to this class 00114 DECLARE_OBJECT_PTR(Binner); 00115 00116 } // end of namespace PLearn 00117 00118 #endif