PLearn 0.1
BetaKernel.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // BetaKernel.h
00004 //
00005 // Copyright (C) 2008 Dumitru Erhan
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 // Authors: Dumitru Erhan
00036 
00040 #ifndef BetaKernel_INC
00041 #define BetaKernel_INC
00042 
00043 #include <plearn/ker/Kernel.h>
00044 
00045 namespace PLearn {
00046 
00057 class BetaKernel : public Kernel
00058 {
00059     typedef Kernel inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00066 
00068     real width; 
00070     string kernel_type;
00072     string output_type;
00073 
00074 public:
00075     //#####  Public Member Functions  #########################################
00076 
00078     // ### Make sure the implementation in the .cc
00079     // ### initializes all fields to reasonable default values.
00080     BetaKernel();
00081 
00082 
00083     //#####  Kernel Member Functions  #########################################
00084 
00086     virtual real evaluate(const Vec& x1, const Vec& x2) const;
00087 
00088     // *** SUBCLASS WRITING: ***
00089     // While in general not necessary, in case of particular needs
00090     // (efficiency concerns for ex) you may also want to overload
00091     // some of the following methods:
00092     // virtual real evaluate_i_j(int i, int j) const;
00093     // virtual real evaluate_i_x(int i, const Vec& x, real squared_norm_of_x=-1) const;
00094     // virtual real evaluate_x_i(const Vec& x, int i, real squared_norm_of_x=-1) const;
00095     // virtual real evaluate_i_x_again(int i, const Vec& x, real squared_norm_of_x=-1, bool first_time = false) const;
00096     // virtual real evaluate_x_i_again(const Vec& x, int i, real squared_norm_of_x=-1, bool first_time = false) const;
00097     // virtual void computeGramMatrix(Mat K) const;
00098     // virtual void setDataForKernelMatrix(VMat the_data);
00099     // virtual void addDataForKernelMatrix(const Vec& newRow);
00100     // virtual void setParameters(Vec paramvec);
00101     // virtual Vec getParameters() const;
00102 
00103 
00104     //#####  PLearn::Object Protocol  #########################################
00105 
00106     // Declares other standard object methods.
00107     // ### If your class is not instantiatable (it has pure virtual methods)
00108     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00109     PLEARN_DECLARE_OBJECT(BetaKernel);
00110 
00111     // Simply calls inherited::build() then build_()
00112     virtual void build();
00113 
00115     // (PLEASE IMPLEMENT IN .cc)
00116     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00117 
00118 protected:
00119     //#####  Protected Options  ###############################################
00120 
00121     // ### Declare protected option fields (such as learned parameters) here
00122     // ...
00123 
00124 protected:
00125     //#####  Protected Member Functions  ######################################
00126 
00128     // (PLEASE IMPLEMENT IN .cc)
00129     static void declareOptions(OptionList& ol);
00130 
00131 private:
00132     //#####  Private Member Functions  ########################################
00133 
00135     // (PLEASE IMPLEMENT IN .cc)
00136     void build_();
00137 
00138 private:
00139     //#####  Private Data Members  ############################################
00140 
00141     // The rest of the private stuff goes here
00142 };
00143 
00144 // Declares a few other classes and functions related to this class
00145 DECLARE_OBJECT_PTR(BetaKernel);
00146 
00147 } // end of namespace PLearn
00148 
00149 #endif
00150 
00151 
00152 /*
00153   Local Variables:
00154   mode:c++
00155   c-basic-offset:4
00156   c-file-style:"stroustrup"
00157   c-file-offsets:((innamespace . 0)(inline-open . 0))
00158   indent-tabs-mode:nil
00159   fill-column:79
00160   End:
00161 */
00162 // 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