mlpack_metric_IPMetric (3)

Mlpack::metric::ipmetric kerneltype -

  1. Carta.tech
  2. Man Pages
  3. Library calls
  4. mlpack_metric_IPMetric: Mlpack::metric::ipmetric kerneltype -
  1. Carta.tech
  2. Packages
  3. mlpack-doc
  4. mlpack_metric_IPMetric: Mlpack::metric::ipmetric kerneltype -

SYNOPSIS

Public Member Functions

IPMetric ()

Create the IPMetric without an instantiated kernel. IPMetric (KernelType &kernel)

Create the IPMetric with an instantiated kernel. ~IPMetric ()

Destroy the IPMetric object. template<typename Vec1Type , typename Vec2Type > double Evaluate (const Vec1Type &a, const Vec2Type &b)

Evaluate the metric. const KernelType & Kernel () const

Get the kernel. KernelType & Kernel ()

Modify the kernel. std::string ToString () const

Returns a string representation of this object.

Private Attributes

KernelType & kernel

The reference to the kernel that is being used. KernelType * localKernel

The locally stored kernel, if it is necessary.

Detailed Description

template<typename KernelType>class mlpack::metric::IPMetric< KernelType >

Definition at line 30 of file ip_metric.hpp.

Constructor & Destructor Documentation

template<typename KernelType > \fBmlpack::metric::IPMetric\fP< KernelType >::\fBIPMetric\fP ()

Create the IPMetric without an instantiated kernel.

template<typename KernelType > \fBmlpack::metric::IPMetric\fP< KernelType >::\fBIPMetric\fP (KernelType &kernel)

Create the IPMetric with an instantiated kernel.

template<typename KernelType > \fBmlpack::metric::IPMetric\fP< KernelType >::~\fBIPMetric\fP ()

Destroy the IPMetric object.

Member Function Documentation

template<typename KernelType > template<typename Vec1Type , typename Vec2Type > double \fBmlpack::metric::IPMetric\fP< KernelType >::Evaluate (const Vec1Type &a, const Vec2Type &b)

Evaluate the metric.

template<typename KernelType > const KernelType& \fBmlpack::metric::IPMetric\fP< KernelType >::Kernel () const\fC [inline]\fP

Get the kernel.

Definition at line 49 of file ip_metric.hpp.

References mlpack::metric::IPMetric< KernelType >::kernel.

template<typename KernelType > KernelType& \fBmlpack::metric::IPMetric\fP< KernelType >::Kernel ()\fC [inline]\fP

Modify the kernel.

Definition at line 51 of file ip_metric.hpp.

References mlpack::metric::IPMetric< KernelType >::kernel.

template<typename KernelType > std::string \fBmlpack::metric::IPMetric\fP< KernelType >::ToString () const

Returns a string representation of this object.

Member Data Documentation

template<typename KernelType > KernelType& \fBmlpack::metric::IPMetric\fP< KernelType >::kernel\fC [private]\fP

The reference to the kernel that is being used.

Definition at line 60 of file ip_metric.hpp.

Referenced by mlpack::metric::IPMetric< KernelType >::Kernel().

template<typename KernelType > KernelType* \fBmlpack::metric::IPMetric\fP< KernelType >::localKernel\fC [private]\fP

The locally stored kernel, if it is necessary.

Definition at line 58 of file ip_metric.hpp.

Author

Generated automatically by Doxygen for MLPACK from the source code.