.\" Text automatically generated by txt2man
.TH mlpack_kfn 1 "12 December 2020" "mlpack-3.4.2" "User Commands"
.SH NAME
\fBmlpack_kfn \fP- k-furthest-neighbors search
.SH SYNOPSIS
.nf
.fam C
 \fBmlpack_kfn\fP [\fB-a\fP \fIstring\fP] [\fB-e\fP \fIdouble\fP] [\fB-m\fP \fIunknown\fP] [\fB-k\fP \fIint\fP] [\fB-l\fP \fIint\fP] [\fB-p\fP \fIdouble\fP] [\fB-q\fP \fIstring\fP] [\fB-R\fP \fIbool\fP] [\fB-r\fP \fIstring\fP] [\fB-s\fP \fIint\fP] [\fB-t\fP \fIstring\fP] [\fB-D\fP \fIstring\fP] [\fB-T\fP \fIstring\fP] [\fB-V\fP \fIbool\fP] [\fB-d\fP \fIstring\fP] [\fB-n\fP \fIstring\fP] [\fB-M\fP \fIunknown\fP] [\fB-h\fP \fB-v\fP] 
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION


This program will calculate the k-furthest-neighbors of a set of points. You
may specify a separate set of reference points and query points, or just a
reference set which will be used as both the reference and query set.
.PP
For example, the following will calculate the 5 furthest neighbors of
eachpoint in 'input.csv' and store the distances in 'distances.csv' and the
neighbors in 'neighbors.csv': 
.PP
$ \fBmlpack_kfn\fP \fB--k\fP 5 \fB--reference_file\fP input.csv \fB--distances_file\fP distances.csv
\fB--neighbors_file\fP neighbors.csv
.PP
The output files are organized such that row i and column j in the neighbors
output matrix corresponds to the index of the point in the reference set which
is the j'th furthest neighbor from the point in the query set with index i. 
Row i and column j in the distances output file corresponds to the distance
between those two points.
.RE
.PP

.SH OPTIONAL INPUT OPTIONS 

.TP
.B
\fB--algorithm\fP (\fB-a\fP) [\fIstring\fP]
Type of neighbor search: 'naive', 'single_tree', 'dual_tree', 'greedy'. Default value 'dual_tree'. 
.TP
.B
\fB--epsilon\fP (\fB-e\fP) [\fIdouble\fP]
If specified, will do approximate furthest neighbor search with given relative error. Must be in the range [0,1). Default value 0. 
.TP
.B
\fB--help\fP (\fB-h\fP) [\fIbool\fP]
Default help info. 
.TP
.B
\fB--info\fP [\fIstring\fP]
Print help on a specific option. Default value ''. 
.TP
.B
\fB--input_model_file\fP (\fB-m\fP) [\fIunknown\fP]
Pre-trained kFN model. 
.TP
.B
\fB--k\fP (\fB-k\fP) [\fIint\fP]
Number of furthest neighbors to find. Default value 0. 
.TP
.B
\fB--leaf_size\fP (\fB-l\fP) [\fIint\fP]
Leaf size for tree building (used for kd-trees, vp trees, random projection trees, UB trees, R trees, R* trees, X trees, Hilbert R trees, R+ trees, R++ trees, and octrees). Default value 20. 
.TP
.B
\fB--percentage\fP (\fB-p\fP) [\fIdouble\fP]
If specified, will do approximate furthest neighbor search. Must be in the range (0,1] (decimal form). Resultant neighbors will be at least (p*100) % of the distance as the true furthest neighbor. Default value 1. 
.TP
.B
\fB--query_file\fP (\fB-q\fP) [\fIstring\fP]
Matrix containing query points (optional). 
.TP
.B
\fB--random_basis\fP (\fB-R\fP) [\fIbool\fP]
Before tree-building, project the data onto a random orthogonal basis. 
.TP
.B
\fB--reference_file\fP (\fB-r\fP) [\fIstring\fP]
Matrix containing the reference dataset. 
.TP
.B
\fB--seed\fP (\fB-s\fP) [\fIint\fP]
Random seed (if 0, \fBstd::time\fP(NULL) is used).  Default value 0. 
.TP
.B
\fB--tree_type\fP (\fB-t\fP) [\fIstring\fP]
Type of tree to use: 'kd', 'vp', 'rp', 'max-rp', 'ub', 'cover', 'r', 'r-star', 'x', 'ball', 'hilbert-r', 'r-plus', 'r-plus-plus', 'oct'.  Default value 'kd'. 
.TP
.B
\fB--true_distances_file\fP (\fB-D\fP) [\fIstring\fP]
Matrix of true distances to compute the effective error (average relative error) (it is printed when \fB-v\fP is specified). 
.TP
.B
\fB--true_neighbors_file\fP (\fB-T\fP) [\fIstring\fP]
Matrix of true neighbors to compute the recall (it is printed when \fB-v\fP is specified). 
.TP
.B
\fB--verbose\fP (\fB-v\fP) [\fIbool\fP]
Display informational messages and the full list of parameters and timers at the end of execution. 
.TP
.B
\fB--version\fP (\fB-V\fP) [\fIbool\fP]
Display the version of mlpack.  
.SH OPTIONAL OUTPUT OPTIONS 

.TP
.B
\fB--distances_file\fP (\fB-d\fP) [\fIstring\fP]
Matrix to output distances into. 
.TP
.B
\fB--neighbors_file\fP (\fB-n\fP) [\fIstring\fP]
Matrix to output neighbors into. 
.TP
.B
\fB--output_model_file\fP (\fB-M\fP) [\fIunknown\fP]
If specified, the kFN model will be output here.
.SH ADDITIONAL INFORMATION

For further information, including relevant papers, citations, and theory,
consult the documentation found at http://www.mlpack.org or included with your
distribution of mlpack.