mlpack::metric::IPMetric< KernelType > Class Template Reference

List of all members.

Public Member Functions

 IPMetric (KernelType &kernel)
 Create the IPMetric with an instantiated kernel.
 IPMetric ()
 Create the IPMetric without an instantiated kernel.
 ~IPMetric ()
 Destroy the IPMetric object.
template<typename Vec1Type , typename Vec2Type >
double Evaluate (const Vec1Type &a, const Vec2Type &b)
 Evaluate the metric.
KernelType & Kernel ()
 Modify the kernel.
const KernelType & Kernel () const
 Get the kernel.

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 >
mlpack::metric::IPMetric< KernelType >::IPMetric (  ) 

Create the IPMetric without an instantiated kernel.

template<typename KernelType >
mlpack::metric::IPMetric< KernelType >::IPMetric ( KernelType &  kernel  ) 

Create the IPMetric with an instantiated kernel.

template<typename KernelType >
mlpack::metric::IPMetric< KernelType >::~IPMetric (  ) 

Destroy the IPMetric object.


Member Function Documentation

template<typename KernelType >
template<typename Vec1Type , typename Vec2Type >
double mlpack::metric::IPMetric< KernelType >::Evaluate ( const Vec1Type &  a,
const Vec2Type &  b 
) [inline]

Evaluate the metric.

template<typename KernelType >
KernelType& mlpack::metric::IPMetric< KernelType >::Kernel (  )  [inline]

Modify the kernel.

Definition at line 51 of file ip_metric.hpp.

template<typename KernelType >
const KernelType& mlpack::metric::IPMetric< KernelType >::Kernel (  )  const [inline]

Get the kernel.

Definition at line 49 of file ip_metric.hpp.


Member Data Documentation

template<typename KernelType >
KernelType& mlpack::metric::IPMetric< KernelType >::kernel [private]

The reference to the kernel that is being used.

Definition at line 57 of file ip_metric.hpp.

template<typename KernelType >
KernelType* mlpack::metric::IPMetric< KernelType >::localKernel [private]

The locally stored kernel, if it is necessary.

Definition at line 55 of file ip_metric.hpp.


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

Generated on 29 Sep 2016 for MLPACK by  doxygen 1.6.1