.TH "mlpack::kernel::PolynomialKernel" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::kernel::PolynomialKernel \- 
.PP
The simple polynomial kernel\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBPolynomialKernel\fP (const double \fBdegree\fP=2\&.0, const double \fBoffset\fP=0\&.0)"
.br
.RI "\fIConstruct the Polynomial Kernel with the given offset and degree\&. \fP"
.ti -1c
.RI "const double & \fBDegree\fP () const "
.br
.RI "\fIGet the degree of the polynomial\&. \fP"
.ti -1c
.RI "double & \fBDegree\fP ()"
.br
.RI "\fIModify the degree of the polynomial\&. \fP"
.ti -1c
.RI "template<typename VecType > double \fBEvaluate\fP (const VecType &a, const VecType &b) const "
.br
.RI "\fISimple evaluation of the dot product\&. \fP"
.ti -1c
.RI "const double & \fBOffset\fP () const "
.br
.RI "\fIGet the offset of the dot product of the arguments\&. \fP"
.ti -1c
.RI "double & \fBOffset\fP ()"
.br
.RI "\fIModify the offset of the dot product of the arguments\&. \fP"
.ti -1c
.RI "std::string \fBToString\fP () const "
.br
.RI "\fIReturn a string representation of the kernel\&. \fP"
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "double \fBdegree\fP"
.br
.RI "\fIThe degree of the polynomial\&. \fP"
.ti -1c
.RI "double \fBoffset\fP"
.br
.RI "\fIThe offset of the dot product of the arguments\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
The simple polynomial kernel\&. 

For any two vectors $ x $, $ y $, $ degree $ and $ offset $,
.PP
\[ K(x, y) = (x^T * y + offset) ^ {degree}. \] 
.PP
Definition at line 38 of file polynomial_kernel\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "mlpack::kernel::PolynomialKernel::PolynomialKernel (const doubledegree = \fC2\&.0\fP, const doubleoffset = \fC0\&.0\fP)\fC [inline]\fP"

.PP
Construct the Polynomial Kernel with the given offset and degree\&. If the arguments are omitted, the default degree is 2 and the default offset is 0\&.
.PP
\fBParameters:\fP
.RS 4
\fIoffset\fP Offset of the dot product of the arguments\&. 
.br
\fIdegree\fP Degree of the polynomial\&. 
.RE
.PP

.PP
Definition at line 48 of file polynomial_kernel\&.hpp\&.
.SH "Member Function Documentation"
.PP 
.SS "const double& mlpack::kernel::PolynomialKernel::Degree () const\fC [inline]\fP"

.PP
Get the degree of the polynomial\&. 
.PP
Definition at line 69 of file polynomial_kernel\&.hpp\&.
.PP
References degree\&.
.SS "double& mlpack::kernel::PolynomialKernel::Degree ()\fC [inline]\fP"

.PP
Modify the degree of the polynomial\&. 
.PP
Definition at line 71 of file polynomial_kernel\&.hpp\&.
.PP
References degree\&.
.SS "template<typename VecType > double mlpack::kernel::PolynomialKernel::Evaluate (const VecType &a, const VecType &b) const\fC [inline]\fP"

.PP
Simple evaluation of the dot product\&. This evaluation uses Armadillo's dot() function\&.
.PP
\fBTemplate Parameters:\fP
.RS 4
\fIVecType\fP Type of vector (should be arma::vec or arma::spvec)\&. 
.RE
.PP
\fBParameters:\fP
.RS 4
\fIa\fP First vector\&. 
.br
\fIb\fP Second vector\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
K(a, b)\&. 
.RE
.PP

.PP
Definition at line 63 of file polynomial_kernel\&.hpp\&.
.PP
References degree, and offset\&.
.SS "const double& mlpack::kernel::PolynomialKernel::Offset () const\fC [inline]\fP"

.PP
Get the offset of the dot product of the arguments\&. 
.PP
Definition at line 74 of file polynomial_kernel\&.hpp\&.
.PP
References offset\&.
.SS "double& mlpack::kernel::PolynomialKernel::Offset ()\fC [inline]\fP"

.PP
Modify the offset of the dot product of the arguments\&. 
.PP
Definition at line 76 of file polynomial_kernel\&.hpp\&.
.PP
References offset\&.
.SS "std::string mlpack::kernel::PolynomialKernel::ToString () const\fC [inline]\fP"

.PP
Return a string representation of the kernel\&. 
.PP
Definition at line 79 of file polynomial_kernel\&.hpp\&.
.PP
References degree, and offset\&.
.SH "Member Data Documentation"
.PP 
.SS "double mlpack::kernel::PolynomialKernel::degree\fC [private]\fP"

.PP
The degree of the polynomial\&. 
.PP
Definition at line 90 of file polynomial_kernel\&.hpp\&.
.PP
Referenced by Degree(), Evaluate(), and ToString()\&.
.SS "double mlpack::kernel::PolynomialKernel::offset\fC [private]\fP"

.PP
The offset of the dot product of the arguments\&. 
.PP
Definition at line 92 of file polynomial_kernel\&.hpp\&.
.PP
Referenced by Evaluate(), Offset(), and ToString()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MLPACK from the source code\&.