mlpack::kernel::TriangularKernel Class Reference

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

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

Private Attributes
double	bandwidth
	The bandwidth of the kernel. More...

Detailed Description

The trivially simple triangular kernel, defined by.

where 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 ( ) const

inline

Get the bandwidth of the kernel.

Definition at line 75 of file triangular_kernel.hpp.

References bandwidth.

double& mlpack::kernel::TriangularKernel::Bandwidth ( )

inline

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

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

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.

std::string mlpack::kernel::TriangularKernel::ToString ( ) const

inline

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

private

The bandwidth of the kernel.

Definition at line 90 of file triangular_kernel.hpp.

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

---

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

• src/mlpack/core/kernels/triangular_kernel.hpp