MLPACK: mlpack::kernel::PolynomialKernel Class Reference

MLPACK 1.0.4

The simple polynomial kernel. More...

List of all members.

Public Member Functions
	PolynomialKernel ()
	Default constructor; sets offset to 0.0 and degree to 1.0.
	PolynomialKernel (double offset, double degree)
const double &	Degree () const
	Get the degree of the polynomial.
template<typename VecType >
double	Evaluate (const VecType &a, const VecType &b)
	Simple evaluation of the dot product.
const double &	Offset () const
	Get the offset.
Private Attributes
double	degree
double	offset

Detailed Description

The simple polynomial kernel.

For any two vectors $ x $ , $ y $ , $ degree $ and $ offset $

$K(x, y) = (x^T * y + offset) ^ {degree}$

Definition at line 39 of file polynomial_kernel.hpp.

Constructor & Destructor Documentation

mlpack::kernel::PolynomialKernel::PolynomialKernel ( ) [inline]

Default constructor; sets offset to 0.0 and degree to 1.0.

Definition at line 45 of file polynomial_kernel.hpp.

mlpack::kernel::PolynomialKernel::PolynomialKernel	(	double	offset,
		double	degree
	)		`[inline]`

Definition at line 56 of file polynomial_kernel.hpp.

Member Function Documentation

const double& mlpack::kernel::PolynomialKernel::Degree ( ) const [inline]

Get the degree of the polynomial.

Definition at line 79 of file polynomial_kernel.hpp.

References degree.

template<typename VecType >

double mlpack::kernel::PolynomialKernel::Evaluate	(	const VecType &	a,
		const VecType &	b
	)		`[inline]`

Simple evaluation of the dot product.

This evaluation uses Armadillo's dot() function.

Template Parameters:

VecType Type of vector (should be arma::vec or arma::spvec).

Parameters:

a	First vector.
b	Second vector.

Returns:: K(a, b).

Definition at line 71 of file polynomial_kernel.hpp.

References degree, and offset.

const double& mlpack::kernel::PolynomialKernel::Offset ( ) const [inline]

Get the offset.

Definition at line 77 of file polynomial_kernel.hpp.

References offset.

Member Data Documentation

double mlpack::kernel::PolynomialKernel::degree [private]

Definition at line 83 of file polynomial_kernel.hpp.

Referenced by Degree(), and Evaluate().

double mlpack::kernel::PolynomialKernel::offset [private]

Definition at line 82 of file polynomial_kernel.hpp.

Referenced by Evaluate(), and Offset().

The documentation for this class was generated from the following file:

src/mlpack/core/kernels/polynomial_kernel.hpp