Skip to content

Commit

Permalink
Merge branch '3-metric-doc'
Browse files Browse the repository at this point in the history
* closes #10
* 3-metric-doc:
  document two separate packages
  • Loading branch information
jefferis committed Apr 14, 2015
2 parents 6a935ff + 63d3b44 commit d7dadc5
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# RANN
[![Build Status](https://travis-ci.org/jefferis/RANN.svg)](https://travis-ci.org/jefferis/RANN)
# RANN [![Build Status](https://travis-ci.org/jefferis/RANN.svg)](https://travis-ci.org/jefferis/RANN)

Finds the k nearest neighbours for every point in a given dataset
in O(N log N) time using Arya and Mount's ANN library (v1.1.3). There is
support for approximate as well as exact searches, fixed radius searches
and bd as well as kd trees.

This package implements nearest neighbors for the Euclidean (L2) metric.
For the Manhattan (L1) metric, install the [RANN1](https://github.com/jefferis/RANN/tree/master-L1) package.

For further details on the underlying ANN library, see http://www.cs.umd.edu/~mount/ANN.

## Installation
Expand All @@ -22,8 +24,7 @@ You can, however, download the [tar ball](https://github.com/jefferis/RANN/tarba
```r
# install.packages("devtools")

library(devtools)
install_github("jefferis/RANN")
devtools::install_github("jefferis/RANN")
```

Note: Windows users need [Rtools](http://www.murdoch-sutherland.com/Rtools/) and [devtools](http://CRAN.R-project.org/package=devtools) to install this way.
Expand Down

0 comments on commit d7dadc5

Please sign in to comment.