diff options
Diffstat (limited to 'vendor/github.com/hongshibao/go-kdtree')
-rw-r--r-- | vendor/github.com/hongshibao/go-kdtree/LICENSE.md | 202 | ||||
-rw-r--r-- | vendor/github.com/hongshibao/go-kdtree/README.md | 92 | ||||
-rw-r--r-- | vendor/github.com/hongshibao/go-kdtree/kdtree.go | 200 |
3 files changed, 0 insertions, 494 deletions
diff --git a/vendor/github.com/hongshibao/go-kdtree/LICENSE.md b/vendor/github.com/hongshibao/go-kdtree/LICENSE.md deleted file mode 100644 index bd12e68..0000000 --- a/vendor/github.com/hongshibao/go-kdtree/LICENSE.md +++ /dev/null @@ -1,202 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2015 thinkpoet (shibaohong@outlook.com) - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - diff --git a/vendor/github.com/hongshibao/go-kdtree/README.md b/vendor/github.com/hongshibao/go-kdtree/README.md deleted file mode 100644 index 85d4550..0000000 --- a/vendor/github.com/hongshibao/go-kdtree/README.md +++ /dev/null @@ -1,92 +0,0 @@ -# KDTree -Golang implementation of KD tree (https://en.wikipedia.org/wiki/K-d_tree) data structure - -## Getting started - -Use go tool to install the package in your packages tree: -``` -go get github.com/hongshibao/go-kdtree -``` -Then you can use it in import section of your Go programs: -```go -import "github.com/hongshibao/go-kdtree" -``` -The package name is ```kdtree```. - -## Basic example - -First you need to implement the ```Point``` interface: -```go -type Point interface { - // Return the total number of dimensions - Dim() int - // Return the value X_{dim}, dim is started from 0 - GetValue(dim int) float64 - // Return the distance between two points - Distance(p Point) float64 - // Return the distance between the point and the plane X_{dim}=val - PlaneDistance(val float64, dim int) float64 -} -``` -Here is an example of implementing ```Point``` interface with square of Euclidean distance as the ```Distance``` definition: -```go -type EuclideanPoint struct { - Point - Vec []float64 -} - -func (p *EuclideanPoint) Dim() int { - return len(p.Vec) -} - -func (p *EuclideanPoint) GetValue(dim int) float64 { - return p.Vec[dim] -} - -func (p *EuclideanPoint) Distance(other Point) float64 { - var ret float64 - for i := 0; i < p.Dim(); i++ { - tmp := p.GetValue(i) - other.GetValue(i) - ret += tmp * tmp - } - return ret -} - -func (p *EuclideanPoint) PlaneDistance(val float64, dim int) float64 { - tmp := p.GetValue(dim) - val - return tmp * tmp -} -``` -Now you can create KD-tree from a list of points and get a list of k nearest neighbours for a target point: -```go -func NewEuclideanPoint(vals ...float64) *EuclideanPoint { - ret := &EuclideanPoint{} - for _, val := range vals { - ret.Vec = append(ret.Vec, val) - } - return ret -} - -func main() { - p1 := NewEuclideanPoint(0.0, 0.0, 0.0) - p2 := NewEuclideanPoint(0.0, 0.0, 1.0) - p3 := NewEuclideanPoint(0.0, 1.0, 0.0) - p4 := NewEuclideanPoint(1.0, 0.0, 0.0) - points := make([]Point, 0) - points = append(points, p1) - points = append(points, p2) - points = append(points, p3) - points = append(points, p4) - tree := NewKDTree(points) - targetPoint := NewEuclideanPoint(0.0, 0.0, 0.1) - neighbours := tree.KNN(targetPoint, 2) - for idx, p := range neighbours { - fmt.Printf("Point %d: (%f", idx, p.GetValue(0)) - for i := 1; i < p.Dim(); i++ { - fmt.Printf(", %f", p.GetValue(i)) - } - fmt.Println(")") - } -} -``` -The returned k nearest neighbours are sorted by their distance with the target point. diff --git a/vendor/github.com/hongshibao/go-kdtree/kdtree.go b/vendor/github.com/hongshibao/go-kdtree/kdtree.go deleted file mode 100644 index 64ecd60..0000000 --- a/vendor/github.com/hongshibao/go-kdtree/kdtree.go +++ /dev/null @@ -1,200 +0,0 @@ -package kdtree - -import ( - "container/heap" - - "github.com/hongshibao/go-algo" -) - -type Point interface { - // Return the total number of dimensions - Dim() int - // Return the value X_{dim}, dim is started from 0 - GetValue(dim int) float64 - // Return the distance between two points - Distance(p Point) float64 - // Return the distance between the point and the plane X_{dim}=val - PlaneDistance(val float64, dim int) float64 -} - -type PointBase struct { - Point - Vec []float64 -} - -func (b PointBase) Dim() int { - return len(b.Vec) -} - -func (b PointBase) GetValue(dim int) float64 { - return b.Vec[dim] -} - -func NewPointBase(vals []float64) PointBase { - ret := PointBase{} - for _, val := range vals { - ret.Vec = append(ret.Vec, val) - } - return ret -} - -type kdTreeNode struct { - axis int - splittingPoint Point - leftChild *kdTreeNode - rightChild *kdTreeNode -} - -type KDTree struct { - root *kdTreeNode - dim int -} - -func (t *KDTree) Dim() int { - return t.dim -} - -func (t *KDTree) KNN(target Point, k int) []Point { - hp := &kNNHeapHelper{} - t.search(t.root, hp, target, k) - ret := make([]Point, 0, hp.Len()) - for hp.Len() > 0 { - item := heap.Pop(hp).(*kNNHeapNode) - ret = append(ret, item.point) - } - for i := len(ret)/2 - 1; i >= 0; i-- { - opp := len(ret) - 1 - i - ret[i], ret[opp] = ret[opp], ret[i] - } - return ret -} - -func (t *KDTree) search(p *kdTreeNode, - hp *kNNHeapHelper, target Point, k int) { - stk := make([]*kdTreeNode, 0) - for p != nil { - stk = append(stk, p) - if target.GetValue(p.axis) < p.splittingPoint.GetValue(p.axis) { - p = p.leftChild - } else { - p = p.rightChild - } - } - for i := len(stk) - 1; i >= 0; i-- { - cur := stk[i] - dist := target.Distance(cur.splittingPoint) - if hp.Len() < k || (*hp)[0].distance >= dist { - heap.Push(hp, &kNNHeapNode{ - point: cur.splittingPoint, - distance: dist, - }) - if hp.Len() > k { - heap.Pop(hp) - } - } - if hp.Len() < k || target.PlaneDistance( - cur.splittingPoint.GetValue(cur.axis), cur.axis) <= - (*hp)[0].distance { - if target.GetValue(cur.axis) < cur.splittingPoint.GetValue(cur.axis) { - t.search(cur.rightChild, hp, target, k) - } else { - t.search(cur.leftChild, hp, target, k) - } - } - } -} - -func NewKDTree(points []Point) *KDTree { - if len(points) == 0 { - return nil - } - ret := &KDTree{ - dim: points[0].Dim(), - root: createKDTree(points, 0), - } - return ret -} - -func createKDTree(points []Point, depth int) *kdTreeNode { - if len(points) == 0 { - return nil - } - dim := points[0].Dim() - ret := &kdTreeNode{ - axis: depth % dim, - } - if len(points) == 1 { - ret.splittingPoint = points[0] - return ret - } - idx := selectSplittingPoint(points, ret.axis) - if idx == -1 { - return nil - } - ret.splittingPoint = points[idx] - ret.leftChild = createKDTree(points[0:idx], depth+1) - ret.rightChild = createKDTree(points[idx+1:len(points)], depth+1) - return ret -} - -type selectionHelper struct { - axis int - points []Point -} - -func (h *selectionHelper) Len() int { - return len(h.points) -} - -func (h *selectionHelper) Less(i, j int) bool { - return h.points[i].GetValue(h.axis) < h.points[j].GetValue(h.axis) -} - -func (h *selectionHelper) Swap(i, j int) { - h.points[i], h.points[j] = h.points[j], h.points[i] -} - -func selectSplittingPoint(points []Point, axis int) int { - helper := &selectionHelper{ - axis: axis, - points: points, - } - mid := len(points)/2 + 1 - err := algo.QuickSelect(helper, mid) - if err != nil { - return -1 - } - return mid - 1 -} - -type kNNHeapNode struct { - point Point - distance float64 -} - -type kNNHeapHelper []*kNNHeapNode - -func (h kNNHeapHelper) Len() int { - return len(h) -} - -func (h kNNHeapHelper) Less(i, j int) bool { - return h[i].distance > h[j].distance -} - -func (h kNNHeapHelper) Swap(i, j int) { - h[i], h[j] = h[j], h[i] -} - -func (h *kNNHeapHelper) Push(x interface{}) { - item := x.(*kNNHeapNode) - *h = append(*h, item) -} - -func (h *kNNHeapHelper) Pop() interface{} { - old := *h - n := len(old) - item := old[n-1] - *h = old[0 : n-1] - return item -} |