From 716db17d039ef6e299b02dd2c71be1cc054a09ba Mon Sep 17 00:00:00 2001 From: Tino Bog Date: Tue, 17 May 2016 20:26:34 +0200 Subject: [PATCH] Update README.md Fixed some typos and modified code formatting --- README.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9f0c2b6..0c28e8c 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ A thread pool is a programming pattern for parallel execution of jobs, http://en 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. +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 simultaneously. For example, time consuming event handlers may be processed in a thread pool to make UI more responsive. 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 +- simple but efficient solution, one header only, no need to compile a binary library - query the number of idle threads and resize the pool dynamically -- one API to push to the thread pool any collable object: lambdas, functors, functions, result of bind expression -- collable objects with variadic number of parameters plus index of the thread running the object +- one API to push to the thread pool any callable object: lambdas, functors, functions, result of bind expression +- callable objects with variadic number of parameters plus index of the thread running the object - automatic template argument deduction - get returned value of any type with standard c++ futures - get fired exceptions with standard c++ futures @@ -23,37 +23,38 @@ Features: - 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) {} +void third(int id, const std::string & additional_param) {} -int main () { +int main () { - ctpl::thread_pool p(2 /* two threads in the pool */); +ctpl::thread_pool p(2); // two threads in the pool - p.push(first); // function +p.push(first); // function - p.push(third, "additional_param"); +p.push(third, "additional_param"); - p.push( [] (int id){ +p.push( [](int id){ std::cout << "hello from " << id << '\n'; -}); // lambda +}); // lambda - p.push(std::ref(second)); // functor, reference +p.push(std::ref(second)); // functor, reference - p.push(const_cast<const Second &>(second)); // functor, copy ctor +p.push(const_cast(second)); // functor, copy ctor - p.push(std::move(second)); // functor, move ctor - -} +p.push(std::move(second)); // functor, move ctor +} +```