mlpack::kernel::TriangularKernel Class Reference

The trivially simple triangular kernel, defined by. More...

List of all members.

Public Member Functions

 TriangularKernel (const double bandwidth=1.0)
 Initialize the triangular kernel with the given bandwidth (default 1.0).
double & Bandwidth ()
 Modify the bandwidth of the kernel.
double Bandwidth () const
 Get the bandwidth of the kernel.
double Evaluate (const double distance) const
 Evaluate the triangular kernel given that the distance between the two points is known.
template<typename Vec1Type , typename Vec2Type >
double Evaluate (const Vec1Type &a, const Vec2Type &b) const
 Evaluate the triangular kernel for the two given vectors.

Private Attributes

double bandwidth
 The bandwidth of the kernel.

Detailed Description

The trivially simple triangular kernel, defined by.

\[ K(x, y) = \max \{ 0, 1 - \frac{|| x - y ||_2}{b} \} \]

where $ b $ is the bandwidth of the kernel.

Definition at line 40 of file triangular_kernel.hpp.


Constructor & Destructor Documentation

mlpack::kernel::TriangularKernel::TriangularKernel ( const double  bandwidth = 1.0  )  [inline]

Initialize the triangular kernel with the given bandwidth (default 1.0).

Parameters:
bandwidth Bandwidth of the triangular kernel.

Definition at line 48 of file triangular_kernel.hpp.


Member Function Documentation

double& mlpack::kernel::TriangularKernel::Bandwidth (  )  [inline]

Modify the bandwidth of the kernel.

Definition at line 77 of file triangular_kernel.hpp.

References bandwidth.

double mlpack::kernel::TriangularKernel::Bandwidth (  )  const [inline]

Get the bandwidth of the kernel.

Definition at line 75 of file triangular_kernel.hpp.

References bandwidth.

double mlpack::kernel::TriangularKernel::Evaluate ( const double  distance  )  const [inline]

Evaluate the triangular kernel given that the distance between the two points is known.

Parameters:
distance The distance between the two points.

Definition at line 69 of file triangular_kernel.hpp.

References bandwidth.

template<typename Vec1Type , typename Vec2Type >
double mlpack::kernel::TriangularKernel::Evaluate ( const Vec1Type &  a,
const Vec2Type &  b 
) const [inline]

Evaluate the triangular kernel for the two given vectors.

Parameters:
a First vector.
b Second vector.

Definition at line 57 of file triangular_kernel.hpp.

References bandwidth, and mlpack::metric::LMetric< Power, TakeRoot >::Evaluate().


Member Data Documentation

The bandwidth of the kernel.

Definition at line 81 of file triangular_kernel.hpp.

Referenced by Bandwidth(), and Evaluate().


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

Generated on 13 Aug 2014 for MLPACK by  doxygen 1.6.1