From e75efe0527fdcab353471f1aa209ebed2f78049a Mon Sep 17 00:00:00 2001 From: Tiaan Louw Date: Sat, 16 Nov 2024 00:32:53 +0100 Subject: [PATCH] Clean up README --- README.md | 50 ++++++++++++++++++++------------------------------ 1 file changed, 20 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 9f0c2b6..f8781b8 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ -CTPL -==== +# CTPL Modern and efficient C++ Thread Pool Library - A thread pool is a programming pattern for parallel execution of jobs, http://en.wikipedia.org/wiki/Thread_pool_pattern. More specifically, there are some threads dedicated to the pool and a container of jobs. The jobs come to the pool dynamically. A job is fetched and deleted from the container when there is an idle thread. The job is then run on that thread. A thread pool is helpful when you want to minimize time of loading and destroying threads and when you want to limit the number of parallel jobs that run simultanuasly. For example, time consuming event handlers may be processed in a thread pool to make UI more responsive. -Features: +## Features: - standard c++ language, tested to compile on MS Visual Studio 2013 (2012?), gcc 4.8.2 and mingw 4.8.1(with posix threads) - simple but effiecient solution, one header only, no need to compile a binary library - query the number of idle threads and resize the pool dynamically @@ -22,38 +20,30 @@ Features: - use for any purpose under Apache license - two variants, one depends on Boost Lockfree Queue library, http://boost.org, which is a header only library +## Sample usage -Sample usage - -void first(int id) { +```c++ +void first(int id) { std::cout << "hello from " << id << '\n'; -} +} - struct Second { +struct Second { void operator()(int id) const { std::cout << "hello from " << id << '\n'; } } second; -void third(int id, const std::string & additional_param) {} - - -int main () { - - ctpl::thread_pool p(2 /* two threads in the pool */); - - p.push(first); // function +void third(int id, const std::string & additional_param) {} - p.push(third, "additional_param"); - - p.push( [] (int id){ - std::cout << "hello from " << id << '\n'; -}); // lambda - - p.push(std::ref(second)); // functor, reference - - p.push(const_cast<const Second &>(second)); // functor, copy ctor - - p.push(std::move(second)); // functor, move ctor - -} +int main () { + ctpl::thread_pool p(2); // two threads in the pool + p.push(first); // function + p.push(third, "additional_param"); + p.push([] (int id){ + std::cout << "hello from " << id << '\n'; + }); // lambda + p.push(std::ref(second)); // functor, reference + p.push(const_cast(second)); // functor, copy ctor + p.push(std::move(second)); // functor, move ctor +} +```