mlpack: mlpack::kernel::HyperbolicTangentKernel Class Reference

mlpack master

Hyperbolic tangent kernel. More...

Public Member Functions
	HyperbolicTangentKernel ()
	This constructor sets the default scale to 1.0 and offset to 0.0. More...

	HyperbolicTangentKernel (double scale, double offset)
	Construct the hyperbolic tangent kernel with custom scale factor and offset. More...

template<typename VecTypeA , typename VecTypeB >
double	Evaluate (const VecTypeA &a, const VecTypeB &b)
	Evaluate the hyperbolic tangent kernel. More...

double	Offset () const
	Get offset for the kernel. More...

double &	Offset ()
	Modify offset for the kernel. More...

double	Scale () const
	Get scale factor. More...

double &	Scale ()
	Modify scale factor. More...

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

Private Attributes
double	offset

double	scale

Detailed Description

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 28 of file hyperbolic_tangent_kernel.hpp.

Constructor & Destructor Documentation

mlpack::kernel::HyperbolicTangentKernel::HyperbolicTangentKernel ( )

inline

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

Definition at line 34 of file hyperbolic_tangent_kernel.hpp.

mlpack::kernel::HyperbolicTangentKernel::HyperbolicTangentKernel	(	double	scale,
		double	offset
	)

inline

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

Parameters

scale	Scaling factor for <x, y>.
offset	Kernel offset.

Definition at line 44 of file hyperbolic_tangent_kernel.hpp.

Member Function Documentation

template<typename VecTypeA , typename VecTypeB >

double mlpack::kernel::HyperbolicTangentKernel::Evaluate	(	const VecTypeA &	a,
		const VecTypeB &	b
	)

inline

Evaluate the hyperbolic tangent kernel.

This evaluation uses Armadillo's dot() function.

Template Parameters

VecTypeA	Type of first vector (should be arma::vec or arma::sp_vec).
VecTypeB	Type of second vector (arma::vec / arma::sp_vec).

Parameters

a	First vector.
b	Second vector.

Returns: K(a, b).

Definition at line 60 of file hyperbolic_tangent_kernel.hpp.

References offset, and scale.

double mlpack::kernel::HyperbolicTangentKernel::Offset ( ) const

inline

Get offset for the kernel.

Definition at line 71 of file hyperbolic_tangent_kernel.hpp.

References offset.

double& mlpack::kernel::HyperbolicTangentKernel::Offset ( )

inline

Modify offset for the kernel.

Definition at line 73 of file hyperbolic_tangent_kernel.hpp.

References offset.

double mlpack::kernel::HyperbolicTangentKernel::Scale ( ) const

inline

Get scale factor.

Definition at line 66 of file hyperbolic_tangent_kernel.hpp.

References scale.

double& mlpack::kernel::HyperbolicTangentKernel::Scale ( )

inline

Modify scale factor.

Definition at line 68 of file hyperbolic_tangent_kernel.hpp.

References scale.

template<typename Archive >

void mlpack::kernel::HyperbolicTangentKernel::Serialize	(	Archive &	ar,
		const unsigned	int
	)

inline

Serialize the kernel.

Definition at line 77 of file hyperbolic_tangent_kernel.hpp.

References mlpack::data::CreateNVP(), offset, and scale.

Member Data Documentation

double mlpack::kernel::HyperbolicTangentKernel::offset

private

Definition at line 85 of file hyperbolic_tangent_kernel.hpp.

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

double mlpack::kernel::HyperbolicTangentKernel::scale

private

Definition at line 84 of file hyperbolic_tangent_kernel.hpp.

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

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

src/mlpack/core/kernels/hyperbolic_tangent_kernel.hpp