Skip to content

Commit

Permalink
Add readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
andrusha97 committed Oct 17, 2017
1 parent 4b24886 commit 307e149
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Online HNSW
===========
An implementation of the HNSW index for approximate nearest neighbors search for C++14,
that supports incremental insertion and removal of elements.

License
=======
Original parts of this project are licensed under the terms of the Apache 2.0 license.
This project also includes:
* A copy of
[the hopscotch-map project](https://github.com/Tessil/hopscotch-map), which is licensed under the MIT license.
It resides in `include/hnsw/containers/hopscotch-map-1.4.0`.
* Parts of [nmslib](https://github.com/searchivarius/nmslib) which are also licensed under the Apache 2.0 license.

Individual source files have corresponding copyright and license info.

References
==========
* Malkov, Y.A., Yashunin, D.A. [Efficient and robust approximate nearest neighbor search using Hierarchical Navigable Small World graphs](https://arxiv.org/abs/1603.09320)
2 changes: 1 addition & 1 deletion include/hnsw/index.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ struct hnsw_index {
// I avoid use of uniform_real_distribution to control how many times random() is called.
// This makes inserts reproducible across standard libraries.

// NOTE: This works fine for standard random engines because their value_type is required to be unsigned.
// NOTE: This works correctly for standard random engines because their value_type is required to be unsigned.
auto sample = random() - random_t::min();
auto max_rand = random_t::max() - random_t::min();

Expand Down

0 comments on commit 307e149

Please sign in to comment.