KDEWrapperBase is a base wrapper class for holding all KDE types supported by KDEModel. More...
#include <kde_model.hpp>
Inheritance diagram for mlpack::kde::KDEWrapperBase:
Public Member Functions | |
| KDEWrapperBase () | |
| Create the KDEWrapperBase object. More... | |
| virtual KDEWrapperBase * | Clone () const =0 |
| Create a new KDEWrapperBase that is the same as this one. More... | |
| virtual | ~KDEWrapperBase () |
| Destruct the KDEWrapperBase (nothing to do). | |
| virtual void | Bandwidth (const double bw)=0 |
| Modify the bandwidth of the kernel. | |
| virtual void | RelativeError (const double relError)=0 |
| Modify the relative error tolerance. | |
| virtual void | AbsoluteError (const double absError)=0 |
| Modify the absolute error tolerance. | |
| virtual bool | MonteCarlo () const =0 |
| Get whether Monte Carlo search is being used. | |
| virtual bool & | MonteCarlo ()=0 |
| Modify whether Monte Carlo search is being used. | |
| virtual void | MCProb (const double mcProb)=0 |
| Modify the Monte Carlo probability. | |
| virtual size_t | MCInitialSampleSize () const =0 |
| Get the Monte Carlo sample size. | |
| virtual size_t & | MCInitialSampleSize ()=0 |
| Modify the Monte Carlo sample size. | |
| virtual void | MCEntryCoef (const double entryCoef)=0 |
| Modify the Monte Carlo entry coefficient. | |
| virtual void | MCBreakCoef (const double breakCoef)=0 |
| Modify the Monte Carlo break coefficient. | |
| virtual KDEMode | Mode () const =0 |
| Get the search mode. | |
| virtual KDEMode & | Mode ()=0 |
| Modify the search mode. | |
| virtual void | Train (arma::mat &&referenceSet)=0 |
| Train the model (build the tree). | |
| virtual void | Evaluate (arma::mat &&querySet, arma::vec &estimates)=0 |
| Perform bichromatic KDE (i.e. KDE with a separate query set). | |
| virtual void | Evaluate (arma::vec &estimates)=0 |
| Perform monochromatic KDE (i.e. with the reference set as the query set). | |
Detailed Description
KDEWrapperBase is a base wrapper class for holding all KDE types supported by KDEModel.
All KDE type wrappers inheirt from this class, allowing a simple interface via inheritance for all the different types we want to support.
Constructor & Destructor Documentation
◆ KDEWrapperBase()
|
inline |
Create the KDEWrapperBase object.
The base class does not hold anything, so this constructor does nothing.
Member Function Documentation
◆ Clone()
|
pure virtual |
Create a new KDEWrapperBase that is the same as this one.
This function will properly handle polymorphism.
Implemented in mlpack::kde::KDEWrapper< KernelType, TreeType >.
The documentation for this class was generated from the following file:
- src/mlpack/methods/kde/kde_model.hpp
