v1.0.0

Author: ConorWilliams

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
 project(
   RiftenThiefpool
-  VERSION 0.2.0
+  VERSION 1.0.0
   LANGUAGES CXX
 )
 

README.md

@@ -1,22 +1,44 @@
 # `riften::Thiefpool`
 
-A Light, fast, work-stealing thread-pool for C++20. Built on the [`riften::Thiefpool`](https://github.com/ConorWilliams/ConcurrentDeque).
+A blazing-fast, lightweight, work-stealing thread-pool for C++20. Built on the lock-free concurrent [`riften::Deque`](https://github.com/ConorWilliams/ConcurrentDeque).
 
 ## Usage
 
 ```C++
-
 #include "riften/thiefpool.hpp"
 
 // Create thread pool with 4 worker threads.
 riften::Thiefpool pool(4);
 
-// Enqueue and store future.
+// Enqueue and return future.
 auto result = pool.enqueue([](int x) { return x; }, 42);
 
 // Get result from future.
 std::cout << result.get() << std::endl;
+```
+
+Additionally, `riften::Thiefpool` supplies a detaching version of enqueue:
 
+```C++
+// Enqueue and return nothing
+pool.enqueue_detach([](int x) { do_work(x); }, x);
 ```
+Which elides the allocation of a `std::future`'s shared state.
 
 ## Installation
+
+The recommended way to consume this library is through [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake), just add:
+
+```CMake
+CPMAddPackage("gh:ConorWilliams/Threadpool#v1.0.0")
+```
+to your `CMakeLists.txt` and you're good to go!
+
+## Tests
+
+To compile and run the tests:
+```zsh
+mkdir build && cd build
+cmake ../test
+make && make test
+```

include/riften/thiefpool.hpp

@@ -19,7 +19,7 @@ namespace riften {
 
 namespace detail {
 
-// Bind F and args... into nullary lambda
+// Bind F and args... into a nullary lambda
 template <typename... Args, std::invocable<Args...> F> auto bind(F &&f, Args &&...arg) {
     return [f = std::forward<F>(f), ... arg = std::forward<Args>(arg)]() mutable -> decltype(auto) {
         return std::invoke(std::forward<F>(f), std::forward<Args>(arg)...);
@@ -53,8 +53,8 @@ template <typename F> NullaryOneShot(F &&) -> NullaryOneShot<F>;
 
 }  // namespace detail
 
-// Lightweight, fast, work-stealing thread-pool for C++20. Built on the `riften::Thiefpool` concurrent
-// deque.
+// Lightweight, fast, work-stealing thread-pool for C++20. Built on the lock-free concurrent `riften::Deque`.
+// Upon destruction the threadpool blocks until all tasks have been completed and all threads have joined.
 class Thiefpool {
   public:
     // Construct a `Thiefpool` with `num_threads` threads.
@@ -89,7 +89,8 @@ class Thiefpool {
     }
 
     // Enqueue callable `f` into the threadpool. It will be called by perfectly forwarding `args...` (unlike
-    // std::async/std::bind/std::thread). Returns a `std::future<...>` which does not block upon destruction.
+    // `std::async`/`std::bind`/`std::thread`). Returns a `std::future<...>` which does not block upon
+    // destruction.
     template <typename... Args, std::invocable<Args...> F> auto enqueue(F &&f, Args &&...args) {
         //
         auto task = detail::NullaryOneShot(detail::bind(std::forward<F>(f), std::forward<Args>(args)...));
@@ -105,8 +106,8 @@ class Thiefpool {
     }
 
     // Enqueue callable `f` into the threadpool. It will be called by perfectly forwarded `args...` (unlike
-    // std::async/std::bind/std::thread). This version does *not* return a handle to the called function and
-    // thus only accepts functions which return void.
+    // `std::async`/`std::bind`/`std::thread`). This version does *not* return a handle to the called function
+    // and thus only accepts functions which return void.
     template <typename... Args, std::invocable<Args...> F> void enqueue_detach(F &&f, Args &&...args) {
         // Cleaner error message than concept
         static_assert(std::is_same_v<void, std::invoke_result_t<F, Args...>>, "Function must return void.");
@@ -139,4 +140,4 @@ class Thiefpool {
     std::vector<std::jthread> _threads;
 };
 
-}  // namespace riften
+}  // namespace riften

test/CMakeLists.txt

@@ -2,9 +2,7 @@ cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
 # ---- Project ----
 
-project(RiftenThiefpoolTest 
-        LANGUAGES CXX
-)
+project(RiftenThiefpoolTest)
 
 # ---- Options ----
 
@@ -42,16 +40,6 @@ add_executable(${PROJECT_NAME} "${sources}")
 # Link dependencies
 target_link_libraries(${PROJECT_NAME} PUBLIC  doctest::doctest RiftenThiefpool::RiftenThiefpool ${CMAKE_THREAD_LIBS_INIT})
 
-# enable compiler warnings
-if(NOT TEST_INSTALLED_VERSION)
-  if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU")
-    target_compile_options(RiftenThiefpool INTERFACE -Wall -Wpedantic -Wextra -Werror)
-  elseif(MSVC)
-    target_compile_options(RiftenThiefpool INTERFACE /W4 /WX)
-    target_compile_definitions(${PROJECT_NAME} PUBLIC DOCTEST_CONFIG_USE_STD_HEADERS)
-  endif()
-endif()
-
 enable_testing()
 
 include(${doctest_SOURCE_DIR}/scripts/cmake/doctest.cmake)