The spherical kernel, which is 1 when the distance between the two argument points is less than or equal to the bandwidth, or 0 otherwise. More...
Public Member Functions | |
| SphericalKernel (const double bandwidth=1.0) | |
| Construct the SphericalKernel with the given bandwidth. More... | |
template < typename VecTypeA , typename VecTypeB > | |
| double | ConvolutionIntegral (const VecTypeA &a, const VecTypeB &b) const |
| Obtains the convolution integral [integral K(||x-a||)K(||b-x||)dx] for the two vectors. More... | |
template < typename VecTypeA , typename VecTypeB > | |
| double | Evaluate (const VecTypeA &a, const VecTypeB &b) const |
| Evaluate the spherical kernel with the given two vectors. More... | |
| double | Evaluate (const double t) const |
| Evaluate the kernel when only a distance is given, not two points. More... | |
| double | Gradient (double t) |
| double | Normalizer (size_t dimension) const |
template < typename Archive > | |
| void | serialize (Archive &ar, const uint32_t) |
| Serialize the object. More... | |
Detailed Description
The spherical kernel, which is 1 when the distance between the two argument points is less than or equal to the bandwidth, or 0 otherwise.
Definition at line 23 of file spherical_kernel.hpp.
Constructor & Destructor Documentation
◆ SphericalKernel()
|
inline |
Construct the SphericalKernel with the given bandwidth.
Definition at line 29 of file spherical_kernel.hpp.
Member Function Documentation
◆ ConvolutionIntegral()
|
inline |
Obtains the convolution integral [integral K(||x-a||)K(||b-x||)dx] for the two vectors.
- Template Parameters
-
VecTypeA Type of first vector (arma::vec, arma::sp_vec should be expected). VecTypeB Type of second vector.
- Parameters
-
a First vector. b Second vector.
- Returns
- The convolution integral value.
Definition at line 62 of file spherical_kernel.hpp.
References LMetric< TPower, TTakeRoot >::Evaluate(), Log::Fatal, and SphericalKernel::Normalizer().
◆ Evaluate() [1/2]
|
inline |
Evaluate the spherical kernel with the given two vectors.
- Template Parameters
-
VecTypeA Type of first vector. VecTypeB Type of second vector.
- Parameters
-
a First vector. b Second vector.
- Returns
- The kernel evaluation between the two vectors.
Definition at line 44 of file spherical_kernel.hpp.
References LMetric< TPower, TTakeRoot >::Evaluate().
◆ Evaluate() [2/2]
|
inline |
Evaluate the kernel when only a distance is given, not two points.
- Parameters
-
t Argument to kernel.
Definition at line 96 of file spherical_kernel.hpp.
◆ Gradient()
|
inline |
Definition at line 100 of file spherical_kernel.hpp.
◆ Normalizer()
|
inline |
Definition at line 85 of file spherical_kernel.hpp.
References M_PI.
Referenced by SphericalKernel::ConvolutionIntegral().
◆ serialize()
|
inline |
Serialize the object.
Definition at line 107 of file spherical_kernel.hpp.
The documentation for this class was generated from the following file:
- /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/core/kernels/spherical_kernel.hpp