PLearn 0.1
PolynomialKernel.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PLearn (A C++ Machine Learning Library)
00004 // Copyright (C) 1998 Pascal Vincent
00005 // Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio, Rejean Ducharme and University of Montreal
00006 // Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
00007 // Copyright (C) 2002 Xiangdong Wang, Christian Dorion
00008 
00009 // Redistribution and use in source and binary forms, with or without
00010 // modification, are permitted provided that the following conditions are met:
00011 // 
00012 //  1. Redistributions of source code must retain the above copyright
00013 //     notice, this list of conditions and the following disclaimer.
00014 // 
00015 //  2. Redistributions in binary form must reproduce the above copyright
00016 //     notice, this list of conditions and the following disclaimer in the
00017 //     documentation and/or other materials provided with the distribution.
00018 // 
00019 //  3. The name of the authors may not be used to endorse or promote
00020 //     products derived from this software without specific prior written
00021 //     permission.
00022 // 
00023 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00024 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00025 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00028 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 // 
00034 // This file is part of the PLearn library. For more information on the PLearn
00035 // library, go to the PLearn Web site at www.plearn.org
00036 
00037 
00038 /* *******************************************************      
00039  * $Id: PolynomialKernel.cc 6802 2007-03-29 15:19:55Z tihocan $
00040  * This file is part of the PLearn library.
00041  ******************************************************* */
00042 
00043 #include "PolynomialKernel.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 
00049 
00050 PLEARN_IMPLEMENT_OBJECT(PolynomialKernel,
00051         "Polynomial kernel.",
00052         "Compute K(x,y) = (1 + beta * <x,y>)^n."
00053 );
00054 
00056 // PolynomialKernel //
00058 PolynomialKernel::PolynomialKernel():
00059     n(2),
00060     beta(1)
00061 {}
00062 
00063 PolynomialKernel::PolynomialKernel(int degree, real the_beta,
00064                                    bool call_build_):
00065     inherited(true, call_build_),
00066     n(degree),
00067     beta(the_beta)
00068 {
00069     if (call_build_)
00070         build_();
00071 }
00072 
00074 // declareOptions //
00076 void PolynomialKernel::declareOptions(OptionList &ol)
00077 {
00078     declareOption(ol, "n", &PolynomialKernel::n, OptionBase::buildoption,
00079                   "Degree of the kernel.");
00080 
00081     declareOption(ol, "beta", &PolynomialKernel::beta, OptionBase::buildoption,
00082                   "Scaling coefficient for the dot product.");
00083 
00084     // Declare options inherited from parent class.
00085     inherited::declareOptions(ol);
00086 }
00087 
00088 
00090 // build //
00092 void PolynomialKernel::build()
00093 {
00094     inherited::build();
00095     build_();
00096 }
00097 
00099 // build_ //
00101 void PolynomialKernel::build_()
00102 {
00103     PLASSERT(n >= 1 && beta > 0);
00104 }
00105 
00107 // evaluate //
00109 real PolynomialKernel::evaluate(const Vec& x1, const Vec& x2) const
00110 { return evaluateFromDot(dot(x1,x2)); }
00111 
00113 // evaluate_i_j //
00115 real PolynomialKernel::evaluate_i_j(int i, int j) const
00116 { return evaluateFromDot(data->dot(i,j)); }
00117 
00119 // evaluate_i_x //
00121 real PolynomialKernel::evaluate_i_x(int i, const Vec& x, real squared_norm_of_x) const 
00122 { return evaluateFromDot(data->dot(i,x)); } 
00123 
00125 // evaluate_x_i //
00127 real PolynomialKernel::evaluate_x_i(const Vec& x, int i, real squared_norm_of_x) const
00128 { return evaluateFromDot(data->dot(i,x)); } 
00129 
00131 // makeDeepCopyFromShallowCopy //
00133 void PolynomialKernel::makeDeepCopyFromShallowCopy(CopiesMap& copies) {
00134     inherited::makeDeepCopyFromShallowCopy(copies);
00135 }
00136 
00137 } // end of namespace PLearn
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