SYNOPSIS

Public Member Functions

TriangularKernel (const double bandwidth=1.0)

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

Get the bandwidth of the kernel. double & Bandwidth ()

Modify the bandwidth of the kernel. template<typename Vec1Type , typename Vec2Type > double Evaluate (const Vec1Type &a, const Vec2Type &b) const

Evaluate the triangular kernel for the two given vectors. double Evaluate (const double distance) const

Evaluate the triangular kernel given that the distance between the two points is known. std::string ToString () const

Return a string representation of the kernel.

Private Attributes

double bandwidth

The bandwidth of the kernel.

Detailed Description

The trivially simple triangular kernel, defined by.

\[ K(x, y) = \max { 0, 1 - ac{|| 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 doublebandwidth = \fC1.0\fP)\fC [inline]\fP

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 () const\fC [inline]\fP

Get the bandwidth of the kernel.

Definition at line 75 of file triangular_kernel.hpp.

References bandwidth.

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

Modify the bandwidth of the kernel.

Definition at line 77 of file triangular_kernel.hpp.

References bandwidth.

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

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().

double mlpack::kernel::TriangularKernel::Evaluate (const doubledistance) const\fC [inline]\fP

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.

std::string mlpack::kernel::TriangularKernel::ToString () const\fC [inline]\fP

Return a string representation of the kernel.

Definition at line 80 of file triangular_kernel.hpp.

References bandwidth.

Member Data Documentation

double mlpack::kernel::TriangularKernel::bandwidth\fC [private]\fP

The bandwidth of the kernel.

Definition at line 90 of file triangular_kernel.hpp.

Referenced by Bandwidth(), Evaluate(), and ToString().

Author

Generated automatically by Doxygen for MLPACK from the source code.