mlpack
Public Member Functions | List of all members
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
VecTypeA
,
typename
VecTypeB
>
double Evaluate (const VecTypeA &a, const VecTypeB &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...

 
double Gradient (const double distance) const
 Evaluate the gradient of triangular kernel given that the distance between the two points is known. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const uint32_t)
 Serialize the kernel. More...

 

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 30 of file triangular_kernel.hpp.

Constructor & Destructor Documentation

◆ TriangularKernel()

TriangularKernel ( const double  bandwidth = 1.0)
inline

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

Parameters
bandwidthBandwidth of the triangular kernel.

Definition at line 38 of file triangular_kernel.hpp.

Member Function Documentation

◆ Bandwidth() [1/2]

double Bandwidth ( ) const
inline

Get the bandwidth of the kernel.

Definition at line 90 of file triangular_kernel.hpp.

◆ Bandwidth() [2/2]

double& Bandwidth ( )
inline

Modify the bandwidth of the kernel.

Definition at line 92 of file triangular_kernel.hpp.

◆ Evaluate() [1/2]

double Evaluate ( const VecTypeA &  a,
const VecTypeB &  b 
) const
inline

Evaluate the triangular kernel for the two given vectors.

Template Parameters
VecTypeAType of first vector.
VecTypeBType of second vector.
Parameters
aFirst vector.
bSecond vector.

Definition at line 49 of file triangular_kernel.hpp.

References LMetric< TPower, TTakeRoot >::Evaluate().

◆ Evaluate() [2/2]

double Evaluate ( const double  distance) const
inline

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

Parameters
distanceThe distance between the two points.

Definition at line 61 of file triangular_kernel.hpp.

◆ Gradient()

double Gradient ( const double  distance) const
inline

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

Parameters
distanceThe distance between the two points.

Definition at line 73 of file triangular_kernel.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)
inline

Serialize the kernel.

Definition at line 96 of file triangular_kernel.hpp.

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