mlpack_kernel_HyperbolicTangentKernel (3)

Public Member Functions

HyperbolicTangentKernel ()

This constructor sets the default scale to 1.0 and offset to 0.0. HyperbolicTangentKernel (double scale, double offset)

Construct the hyperbolic tangent kernel with custom scale factor and offset. template<typename VecType > double Evaluate (const VecType &a, const VecType &b)

Evaluate the hyperbolic tangent kernel. double Offset () const

Get offset for the kernel. double & Offset ()

Modify offset for the kernel. double Scale () const

Get scale factor. double & Scale ()

Modify scale factor. std::string ToString () const

Convert object to string.

Private Attributes

double offset

double scale

Hyperbolic tangent kernel.

For any two vectors $ x $, $ y $ and a given scale $ s $ and offset $ t $

\[ K(x, y) = \tanh(s <x, y> + t) \]

Definition at line 38 of file hyperbolic_tangent_kernel.hpp.

mlpack::kernel::HyperbolicTangentKernel::HyperbolicTangentKernel ()\fC [inline]\fP

This constructor sets the default scale to 1.0 and offset to 0.0.

Definition at line 44 of file hyperbolic_tangent_kernel.hpp.

mlpack::kernel::HyperbolicTangentKernel::HyperbolicTangentKernel (doublescale, doubleoffset)\fC [inline]\fP

Construct the hyperbolic tangent kernel with custom scale factor and offset.

Parameters:

scale Scaling factor for <x, y>.

offset Kernel offset.

Definition at line 54 of file hyperbolic_tangent_kernel.hpp.

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

Evaluate the hyperbolic tangent kernel. This evaluation uses Armadillo's dot() function.

Template Parameters:

VecType Type of vector (should be arma::vec or arma::spvec).

Parameters:

a First vector.

b Second vector.

Returns:

K(a, b).

Definition at line 68 of file hyperbolic_tangent_kernel.hpp.

References offset, and scale.

double mlpack::kernel::HyperbolicTangentKernel::Offset () const\fC [inline]\fP

Get offset for the kernel.

Definition at line 79 of file hyperbolic_tangent_kernel.hpp.

References offset.

double& mlpack::kernel::HyperbolicTangentKernel::Offset ()\fC [inline]\fP

Modify offset for the kernel.

Definition at line 81 of file hyperbolic_tangent_kernel.hpp.

References offset.

double mlpack::kernel::HyperbolicTangentKernel::Scale () const\fC [inline]\fP

Get scale factor.

Definition at line 74 of file hyperbolic_tangent_kernel.hpp.

References scale.

double& mlpack::kernel::HyperbolicTangentKernel::Scale ()\fC [inline]\fP

Modify scale factor.

Definition at line 76 of file hyperbolic_tangent_kernel.hpp.

References scale.

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

Convert object to string.

Definition at line 84 of file hyperbolic_tangent_kernel.hpp.

References offset, and scale.

double mlpack::kernel::HyperbolicTangentKernel::offset\fC [private]\fP

Definition at line 95 of file hyperbolic_tangent_kernel.hpp.

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

double mlpack::kernel::HyperbolicTangentKernel::scale\fC [private]\fP

Definition at line 94 of file hyperbolic_tangent_kernel.hpp.

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

Generated automatically by Doxygen for MLPACK from the source code.