added a note to SuRF's constructor

efficient · Nov 13, 2018 · cbf2358 · cbf2358
1 parent 4cf4879
commit cbf2358
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ A simple example can be found [here](https://github.com/efficient/SuRF/blob/mast
 g++ -mpopcnt -std=c++11 simple_example.cpp
 ./a.out
 ```
+Note that the key list passed to the SuRF constructor must be SORTED.
 
 ## Run Unit Tests
     make test

diff --git a/include/surf.hpp b/include/surf.hpp
@@ -53,6 +53,9 @@ class SuRF {
 public:
     SuRF() {};
 
+    //------------------------------------------------------------------
+    // Input keys must be SORTED
+    //------------------------------------------------------------------
     SuRF(const std::vector<std::string>& keys) {
 	create(keys, kIncludeDense, kSparseDenseRatio, kNone, 0, 0);
     }