v1.5.1 pypi is available

yahoojapan · Jan 17, 2019 · 9929c12 · 9929c12
1 parent bc5a163
commit 9929c12
Show file tree

Hide file tree

Showing 51 changed files with 431 additions and 144 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,11 +2,11 @@ cmake_minimum_required(VERSION 2.8)
 
 project(ngt)
 
-set(ngt_VERSION_MAJOR 1)
-set(ngt_VERSION_MINOR 5)
-set(ngt_VERSION_PATCH 0)
+file(STRINGS "VERSION" ngt_VERSION)
+message(STATUS "VERSION: ${ngt_VERSION}")
+string(REGEX MATCH "^[0-9]+" ngt_VERSION_MAJOR ${ngt_VERSION})
 
-set(ngt_VERSION ${ngt_VERSION_MAJOR}.${ngt_VERSION_MINOR}.${ngt_VERSION_PATCH})
+set(ngt_VERSION ${ngt_VERSION})
 set(ngt_SOVERSION ${ngt_VERSION_MAJOR})
 
 if (NOT CMAKE_BUILD_TYPE)
@@ -22,39 +22,54 @@ if(${UNIX})
     set(GIT_DATE_OPTION "-DGIT_DATE=\"\\\"`git log -1 --format='%cd'`\\\"\"")
     set(GIT_TAG_OPTION "-DGIT_TAG=\"\\\"`git describe --abbrev=0`\\\"\"")
     set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
+
     if(CMAKE_VERSION VERSION_LESS 3.1)
-	set(BASE_OPTIONS "-Wall -std=gnu++0x -lrt ${BUILD_DATE_OPTION} ${GIT_HASH_OPTION} ${GIT_DATE_OPTION} ${GIT_TAG_OPTION}")
-	if(${NGT_AVX_DISABLED})
-		message(STATUS "AVX will not be used to compute distances.")
-	else()
-		set(BASE_OPTIONS "${BASE_OPTIONS} -mavx")
-	endif()
-	if(${NGT_OPENMP_DISABLE})
-		message(STATUS "OpenMP is disabled.")
-	else()
-		set(BASE_OPTIONS "${BASE_OPTIONS} -fopenmp")
-	endif()
-	set(CMAKE_CXX_FLAGS_DEBUG "-g ${BASE_OPTIONS}")
-	set(CMAKE_CXX_FLAGS_RELEASE "-O3 -march=native ${BASE_OPTIONS}")
+        set(BASE_OPTIONS "-Wall -std=gnu++0x -lrt ${BUILD_DATE_OPTION} ${GIT_HASH_OPTION} ${GIT_DATE_OPTION} ${GIT_TAG_OPTION}")
+
+        if(${NGT_AVX_DISABLED})
+            message(STATUS "AVX will not be used to compute distances.")
+        else()
+            set(BASE_OPTIONS "${BASE_OPTIONS} -mavx")
+        endif()
+
+        if(${NGT_OPENMP_DISABLE})
+            message(STATUS "OpenMP is disabled.")
+        else()
+            set(BASE_OPTIONS "${BASE_OPTIONS} -fopenmp")
+        endif()
+
+        set(CMAKE_CXX_FLAGS_DEBUG "-g ${BASE_OPTIONS}")
+
+        if(${NGT_MARCH_NATIVE_DISABLED})
+            message(STATUS "Compile option -march=native is disabled.")
+            set(CMAKE_CXX_FLAGS_RELEASE "-O2 ${BASE_OPTIONS}")
+        else()
+            set(CMAKE_CXX_FLAGS_RELEASE "-O3 -march=native ${BASE_OPTIONS}")
+        endif()
     else()
         add_definitions(${BUILD_DATE_OPTION} ${GIT_HASH_OPTION} ${GIT_DATE_OPTION} ${GIT_TAG_OPTION})
-	if (CMAKE_BUILD_TYPE_LOWER STREQUAL "release")
+        if (CMAKE_BUILD_TYPE_LOWER STREQUAL "release")
             set(CMAKE_CXX_FLAGS_RELEASE "")
-	    add_compile_options(-Ofast -march=native -DNDEBUG)
+            if(${NGT_MARCH_NATIVE_DISABLED})
+                message(STATUS "Compile option -march=native is disabled.")
+                add_compile_options(-O2 -DNDEBUG)
+            else()
+                add_compile_options(-Ofast -march=native -DNDEBUG)
+            endif()
+        endif()
+        add_compile_options(-Wall -lrt)
+        if(${NGT_AVX_DISABLED})
+            message(STATUS "AVX will not be used to compute distances.")
+        else()
+            add_compile_options(-mavx)
+        endif()
+        if(${NGT_OPENMP_DISABLE})
+            message(STATUS "OpenMP is disabled.")
+        else()
+            add_compile_options(-fopenmp)
         endif()
- 	add_compile_options(-Wall -lrt)
-	if(${NGT_AVX_DISABLED})
-		message(STATUS "AVX will not be used to compute distances.")
-	else()
-		add_compile_options(-mavx)
-	endif()
-	if(${NGT_OPENMP_DISABLE})
-		message(STATUS "OpenMP is disabled.")
-	else()
-		add_compile_options(-fopenmp)
-	endif()
- 	set(CMAKE_CXX_STANDARD 11) # for std::unordered_set, std::unique_ptr
- 	set(CMAKE_CXX_STANDARD_REQUIRED ON)
+        set(CMAKE_CXX_STANDARD 11) # for std::unordered_set, std::unique_ptr
+        set(CMAKE_CXX_STANDARD_REQUIRED ON)
     endif() 
 
 	add_subdirectory("${PROJECT_SOURCE_DIR}/lib")

diff --git a/README-jp.md b/README-jp.md
@@ -28,7 +28,7 @@ Neighborhood Graph and Tree for Indexing High-dimensional Data
       $ cmake ..
       $ make 
       $ make install
-      $ ldconfig
+      $ ldconfig /usr/local/lib
 
 #### 共有メモリの利用
 
@@ -86,5 +86,5 @@ Neighborhood Graph and Tree for Indexing High-dimensional Data
 ##### [ANNG](bin/ngt/README-jp.md#anng)
 - Iwasaki, M.: Proximity search in metric spaces using approximate k nearest neigh-bor graph (in Japanese). IPSJ Trans. on Database 3(1) (2010) 18-28. ([pdf](https://s.yimg.jp/i/docs/research_lab/articles/miwasaki-ipsj-tod-2010.pdf))
 
-Copyright &copy; 2015-2018 Yahoo Japan Corporation All Rights Reserved.
+Copyright &copy; 2015-2019 Yahoo Japan Corporation All Rights Reserved.
 
diff --git a/README.jp b/README.jp
@@ -6,4 +6,4 @@ READMEは以下の場所に移動致しました。
 https://github.com/yahoojapan/NGT/blob/master/README-jp.md
 
 ---
-Copyright (C) 2015-2018 Yahoo! JAPAN Research
+Copyright (C) 2015-2019 Yahoo! JAPAN Research
diff --git a/README.md b/README.md
@@ -21,14 +21,33 @@ Installation
 
 ### Build
 
+#### On Linux
+
+      $ unzip NGT-x.x.x.zip
+      $ cd NGT-x.x.x
+      $ mkdir build
+      $ cd build 
+      $ cmake ..
+      $ make 
+      $ make install
+      $ ldconfig /usr/local/lib
+
+#### On Mac using homebrew
+
+      $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+      $ brew install cmake
+      $ brew install gcc
+      $ ln -s ./gcc-8 /usr/local/bin/gcc
+      $ ln -s ./g++-8 /usr/local/bin/g++
+      $ export CXX=g++
+      $ export CC=gcc
       $ unzip NGT-x.x.x.zip
       $ cd NGT-x.x.x
       $ mkdir build
       $ cd build 
       $ cmake ..
       $ make 
       $ make install
-      $ ldconfig
 
 #### Shared memory use
 
@@ -55,7 +74,7 @@ Supported Programming Languages
 License
 -------
 
-Copyright (C) 2015-2018 Yahoo Japan Corporation
+Copyright (C) 2015-2019 Yahoo Japan Corporation
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at
 
@@ -89,5 +108,5 @@ Publications
 ##### [ANNG](bin/ngt/README.md#anng)
 - Iwasaki, M.: Proximity search in metric spaces using approximate k nearest neigh-bor graph (in Japanese). IPSJ Trans. on Database 3(1) (2010) 18-28. ([pdf](https://s.yimg.jp/i/docs/research_lab/articles/miwasaki-ipsj-tod-2010.pdf))
 
-Copyright &copy; 2015-2018 Yahoo Japan Corporation All Rights Reserved.
+Copyright &copy; 2015-2019 Yahoo Japan Corporation All Rights Reserved.
 
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+1.5.1
diff --git a/bin/ngt/ngt.cpp b/bin/ngt/ngt.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/bin/ngtq/README.md b/bin/ngtq/README.md
@@ -120,5 +120,5 @@ Specifies the search mode.
 - __r__: searches using exact distances after screening by approximate distances. (recommended if you need exact distances)
 
 **-E** *approximate\_expansion*  
-Specifies the expansion ratio of the number of approximate search results to the number of search results. For example, when the retio is 10 and the number of search results is 20, the number of the approximate search results is set to 200.
+Specifies the expansion ratio of the number of approximate search results to the number of search results. For example, when the ratio is 10 and the number of search results is 20, the number of the approximate search results is set to 200.
 
diff --git a/bin/ngtq/ngtq.cpp b/bin/ngtq/ngtq.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2016-2018 Yahoo Japan Corporation
+// Copyright (C) 2016-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/bin/search/search.cpp b/bin/search/search.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/ArrayFile.cpp b/lib/NGT/ArrayFile.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/ArrayFile.h b/lib/NGT/ArrayFile.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/CMakeLists.txt b/lib/NGT/CMakeLists.txt
@@ -9,14 +9,18 @@ if( ${UNIX} )
 
 	add_library(ngtstatic STATIC ${NGT_SOURCES})
 	set_target_properties(ngtstatic PROPERTIES OUTPUT_NAME ngt) 
+	set_target_properties(ngtstatic PROPERTIES COMPILE_FLAGS "-fPIC")
 	target_link_libraries(ngtstatic)
 
-
 	add_library(ngt SHARED ${NGT_SOURCES})
 	set_target_properties(ngt PROPERTIES VERSION ${ngt_VERSION}) 
 	set_target_properties(ngt PROPERTIES SOVERSION ${ngt_SOVERSION}) 
 	add_dependencies(ngt ngtstatic) 
-	target_link_libraries(ngt gomp)
+	if(${APPLE})
+		target_link_libraries(ngt gomp)
+	else(${APPLE})
+		target_link_libraries(ngt gomp rt)
+	endif(${APPLE})
 
 	install(TARGETS
 		ngt

diff --git a/lib/NGT/Capi.cpp b/lib/NGT/Capi.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Capi.h b/lib/NGT/Capi.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Clustering.h b/lib/NGT/Clustering.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Command.cpp b/lib/NGT/Command.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Command.h b/lib/NGT/Command.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Common.h b/lib/NGT/Common.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Graph.cpp b/lib/NGT/Graph.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Graph.h b/lib/NGT/Graph.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/GraphReconstructor.h b/lib/NGT/GraphReconstructor.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/HashBasedBooleanSet.h b/lib/NGT/HashBasedBooleanSet.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Index.cpp b/lib/NGT/Index.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Index.h b/lib/NGT/Index.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -288,7 +288,7 @@ namespace NGT {
     static void createGraphAndTree(const string &database, NGT::Property &prop) { createGraphAndTree(database, prop, ""); }
     static void createGraph(const string &database, NGT::Property &prop, const string &dataFile, size_t dataSize = 0);
     template<typename T> size_t insert(vector<T> &object);
-    static void append(const string &database, const string &dataFile, size_t threadSize, size_t dataSize);
+    static void append(const string &database, const string &dataFile, size_t threadSize, size_t dataSize); 
     static void append(const string &database, const float *data, size_t dataSize, size_t threadSize);
     static void remove(const string &database, vector<ObjectID> &objects);
     static void exportIndex(const string &database, const string &file);
@@ -1080,6 +1080,10 @@ namespace NGT {
 
     // GraphIndex
     virtual void search(NGT::SearchContainer &sc, ObjectDistances &seeds) {
+      if (sc.size == 0) {
+	while (!sc.workingResult.empty()) sc.workingResult.pop();
+	return;
+      }
       if (seeds.size() == 0) {
 #if defined(NGT_SHARED_MEMORY_ALLOCATOR) || !defined(NGT_GRAPH_READ_ONLY_GRAPH)
 	getSeedsFromGraph(repository, seeds);

diff --git a/lib/NGT/MmapManager.cpp b/lib/NGT/MmapManager.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/MmapManager.h b/lib/NGT/MmapManager.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/MmapManagerDefs.h b/lib/NGT/MmapManagerDefs.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/MmapManagerException.h b/lib/NGT/MmapManagerException.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/MmapManagerImpl.hpp b/lib/NGT/MmapManagerImpl.hpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/NGTQ/Command.h b/lib/NGT/NGTQ/Command.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2016-2018 Yahoo Japan Corporation
+// Copyright (C) 2016-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/NGTQ/Quantizer.h b/lib/NGT/NGTQ/Quantizer.h
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2016-2018 Yahoo Japan Corporation
+// Copyright (C) 2016-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/lib/NGT/Node.cpp b/lib/NGT/Node.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright (C) 2015-2018 Yahoo Japan Corporation
+// Copyright (C) 2015-2019 Yahoo Japan Corporation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.