/usr/include/openturns/swig/KDTree_doc.i is in libopenturns-dev 1.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | %feature("docstring") OT::KDTree
"Partition tree data structure.
Allows to store and search points fast.
Parameters
----------
sample : 2-d sequence of float
Points.
Examples
--------
>>> import openturns as ot
>>> sample = ot.Normal(2).getSample(10)
>>> tree = ot.KDTree(sample)
>>> neighbour = tree.getNearestNeighbour([0.1, 0.2])"
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::isEmpty
"Empty flag accessor.
Returns
-------
empty : bool
Whether the collection is empty."
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::insert
"Insert a point in the tree.
Parameters
----------
x : sequence of float
Given point."
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::getNearestNeighboursIndices
"Accessor to the nearest neighbours indices.
Parameters
----------
x : sequence of float
Given point.
k : int
Number of points to return
sorted : bool
Whether to return the points sorted
Returns
-------
indices : :class:`~openturns.Indices`
Indices of the k nearest neighbours."
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::getNearestNeighbours
"Accessor to the nearest neighbours.
Parameters
----------
x : sequence of float
Given point.
k : int
Number of points to return
Returns
-------
neighbours : :class:`~openturns.Sample`
Nearest neighbours."
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::getNearestNeighbourIndex
"Accessor to the nearest neighbour index.
Parameters
----------
x : sequence of float
Given point.
Returns
-------
index : int
Index of the nearest neighbour."
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::getNearestNeighbour
"Accessor to the nearest neighbour.
Parameters
----------
x : sequence of float
Given point.
Returns
-------
neighbour : :class:`~openturns.Point`
Nearest neighbour."
// ---------------------------------------------------------------------
%feature("docstring") OT::KDTree::getPoints
"Collection of points accessor.
Returns
-------
points : :class:`~openturns.Sample`
Collection of points."
|