FGTKde Class Reference

A computation class for FGT based kernel density estimation. More...

Collaboration diagram for FGTKde:

[legend]

List of all members.

Public Member Functions
void	Compute ()
	Compute KDE estimates using fast Gauss transform.
	FGTKde ()
	Constructor that does not do anything.
void	get_density_estimates (Vector *results)
	Get the density estimates.
void	Init (Matrix &qset, Matrix &rset, struct datanode *module_in)
	Initialize with the given query and the reference datasets.
void	PrintDebug ()
	Output KDE results to a stream.
	~FGTKde ()
	Destructor that does not do anything.

---

Detailed Description

A computation class for FGT based kernel density estimation.

This class is only inteded to compute once per instantiation.

Example use:

    FGTKde fgt_kde;
    struct datanode* fgt_kde_module;
    Vector results;

    fgt_kde_module = fx_submodule(NULL, "kde", "fgt_kde_module");
    fgt_kde.Init(queries, references, fgt_kde_module);
    fgt_kde.Compute();

    // important to make sure that you don't call Init on results!
    fgt_kde.get_density_estimates(&results);

Definition at line 85 of file fgt_kde.h.

---

Constructor & Destructor Documentation

FGTKde::FGTKde

(

)

[inline]

Constructor that does not do anything.

Definition at line 1170 of file fgt_kde.h.

FGTKde::~FGTKde

(

)

[inline]

Destructor that does not do anything.

Definition at line 1173 of file fgt_kde.h.

References GaussianKernel::CalcNormConstant().

---

Member Function Documentation

void FGTKde::Compute

(

)

[inline]

Compute KDE estimates using fast Gauss transform.

Definition at line 1219 of file fgt_kde.h.

Referenced by main().

void FGTKde::get_density_estimates

(

Vector *

results

)

[inline]

Get the density estimates.

Parameters:

results

An uninitialized vector which will be initialized with the computed density estimates.

Definition at line 1182 of file fgt_kde.h.

Referenced by main().

void FGTKde::Init	(	Matrix &	qset,
		Matrix &	rset,
		struct datanode *	module_in
	)			[inline]

Initialize with the given query and the reference datasets.

Parameters:

	qset	The column-oriented query dataset.
	rset	The column-oriented reference dataset.
	module_in	The module holding the parameters for execution.

Definition at line 1199 of file fgt_kde.h.

Referenced by main().

void FGTKde::PrintDebug

(

)

[inline]

Output KDE results to a stream.

If the user provided "--fgt_kde_output=" argument, then the output will be directed to a file whose name is provided after the equality sign. Otherwise, it will be provided to the screen.

Definition at line 1295 of file fgt_kde.h.

Referenced by main().

---

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

• mlpack/kde/fgt_kde.h