1mlpack_emst(1)                   User Commands                  mlpack_emst(1)
2
3
4

NAME

6       mlpack_emst - fast euclidean minimum spanning tree
7

SYNOPSIS

9        mlpack_emst -i string [-l int] [-n bool] [-V bool] [-o string] [-h -v]
10

DESCRIPTION

12       This  program  can compute the Euclidean minimum spanning tree of a set
13       of input points using the dual-tree Boruvka algorithm.
14
15       The set to calculate the minimum spanning tree of is specified with the
16--input_file  (-i)'  parameter,  and  the output may be saved with the
17--output_file (-o)' output parameter.
18
19       The '--leaf_size (-l)' parameter controls the leaf size of the  kd-tree
20       that  is  used  to  calculate  the  minimum  spanning  tree, and if the
21       '--naive (-n)' option is given, then brute-force search is  used  (this
22       is  typically  much  slower  in low dimensions). The leaf size does not
23       affect the results, but it may have some effect on the runtime  of  the
24       algorithm.
25
26       For  example, the minimum spanning tree of the input dataset 'data.csv'
27       can be calculated  with  a  leaf  size  of  20  and  stored  as  'span‐
28       ning_tree.csv' using the following command:
29
30       $   emst  --input_file  data.csv  --leaf_size  20  --output_file  span‐
31       ning_tree.csv
32
33       The output matrix is a three-dimensional matrix, where each  row  indi‐
34       cates  an  edge. The first dimension corresponds to the lesser index of
35       the edge; the second dimension corresponds to the greater index of  the
36       edge;  and the third column corresponds to the distance between the two
37       points.
38

REQUIRED INPUT OPTIONS

40       --input_file (-i) [string]
41              Input data matrix.
42

OPTIONAL INPUT OPTIONS

44       --help (-h) [bool]
45              Default help info.
46
47       --info [string]
48              Get help on a specific module or option.  Default value ''.
49
50       --leaf_size (-l) [int]
51              Leaf size in the kd-tree. One-element leaves  give  the  empiri‐
52              cally  best  performance,  but  at  the  cost  of greater memory
53              requirements.  Default value 1.
54
55       --naive (-n) [bool]
56              Compute the MST using O(n^2) naive algorithm.
57
58       --verbose (-v) [bool]
59              Display informational messages and the full list  of  parameters
60              and timers at the end of execution.
61
62       --version (-V) [bool]
63              Display the version of mlpack.
64

OPTIONAL OUTPUT OPTIONS

66       --output_file (-o) [string]
67              Output data. Stored as an edge list. Default value ''.
68

ADDITIONAL INFORMATION

70       For further information, including relevant papers, citations, and the‐
71       ory,  consult  the  documentation  found  at  http://www.mlpack.org  or
72       included with your distribution of mlpack.
73
74
75
76mlpack-3.0.4                   21 February 2019                 mlpack_emst(1)
Impressum