fgt_kde_main.cc File Reference

Driver for the fast Gauss transform based KDE algorithm. More...

Include dependency graph for fgt_kde_main.cc:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	main (int argc, char *argv[])
	Main function which reads parameters and determines which algorithms to run.

---

Detailed Description

Driver for the fast Gauss transform based KDE algorithm.

Author:

Dongryeol Lee (dongryel)

Definition in file fgt_kde_main.cc.

---

Function Documentation

int main	(	int	argc,
		char *	argv[]
	)

Main function which reads parameters and determines which algorithms to run.

In order to compile this driver, do: fl-build fgt_kde_bin --mode=fast

In order to run this driver for the FGT-based KDE algorithm, type the following (which consists of both required and optional arguments) in a single command line:

./fgt_kde_bin --data=name_of_the_reference_dataset --query=name_of_the_query_dataset --kde/bandwidth=0.0130619 --kde/scaling=range --kde/fgt_kde_output=fgt_kde_output.txt --kde/naive_kde_output=naive_kde_output.txt --kde/do_naive --kde/absolute_error=0.1

Explanations for the arguments listed with possible values:

1. data (required): the name of the reference dataset

2. query (optional): the name of the query dataset (if missing, the query dataset is assumed to be the same as the reference dataset)

3. kde/bandwidth (required): smoothing parameter used for KDE; this has to be positive.

4. kde/scaling (optional): whether to prescale the dataset - range: scales both the query and the reference sets to be within the unit hypercube [0, 1]^D where D is the dimensionality. - none: default value; no scaling

5. kde/do_naive (optional): run the naive algorithm after the fast algorithm.

6. kde/fgt_kde_output (optional): if this flag is present, the approximated density estimates are output to the filename provided after it.

7. kde/naive_kde_output (optional): if this flag is present, the exact density estimates computed by the naive algorithm are output to the filename provided after it. This flag is not ignored if --kde/do_naive flag is not present.

8. kde/absolute_error (optional): absolute error criterion for the fast algorithm; default value is 0.1 (0.1 absolute error for all query density estimates).

Definition at line 95 of file fgt_kde_main.cc.

References NaiveKde< TKernel >::Compute(), FGTKde::Compute(), NaiveKde< TKernel >::ComputeMaximumRelativeError(), fx_done(), fx_param_exists(), fx_param_str(), fx_param_str_req(), fx_root, fx_submodule(), FGTKde::get_density_estimates(), FGTKde::Init(), data::Load(), NaiveKde< TKernel >::PrintDebug(), FGTKde::PrintDebug(), and DatasetScaler::ScaleDataByMinMax().