PLearn 0.1
EpanechnikovKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // EpanechnikovKernel.h
00004 //
00005 // Copyright (C) 2004 Nicolas Chapados 
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: EpanechnikovKernel.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Nicolas Chapados
00040 
00044 #ifndef EpanechnikovKernel_INC
00045 #define EpanechnikovKernel_INC
00046 
00047 #include <plearn/ker/Kernel.h>
00048 
00049 namespace PLearn {
00050 
00051 class EpanechnikovKernel: public Kernel
00052 {
00053     typedef Kernel inherited;
00054   
00055 public:
00056 
00057     // ************************
00058     // * Public build options *
00059     // ************************
00060 
00062     real gamma;
00063 
00064     // ****************
00065     // * Constructors *
00066     // ****************
00067 
00069     EpanechnikovKernel();
00070 
00071     // ******************
00072     // * Kernel methods *
00073     // ******************
00074 
00075 private: 
00076 
00078     // (Please implement in .cc)
00079     void build_();
00080 
00081 protected: 
00082   
00084     // (Please implement in .cc)
00085     static void declareOptions(OptionList& ol);
00086 
00087 public:
00088 
00089     // ************************
00090     // **** Object methods ****
00091     // ************************
00092 
00094     virtual void build();
00095 
00097     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00098 
00099     // Declares other standard object methods.
00100     // If your class is not instantiatable (it has pure virtual methods)
00101     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS.
00102     PLEARN_DECLARE_OBJECT(EpanechnikovKernel);
00103 
00104     // ************************
00105     // **** Kernel methods ****
00106     // ************************
00107 
00109     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00110 };
00111 
00112 // Declares a few other classes and functions related to this class.
00113 DECLARE_OBJECT_PTR(EpanechnikovKernel);
00114   
00115 } // end of namespace PLearn
00116 
00117 #endif
00118 
00119 
00120 /*
00121   Local Variables:
00122   mode:c++
00123   c-basic-offset:4
00124   c-file-style:"stroustrup"
00125   c-file-offsets:((innamespace . 0)(inline-open . 0))
00126   indent-tabs-mode:nil
00127   fill-column:79
00128   End:
00129 */
00130 // 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