tnagler · tnagler · Oct 19, 2021 · Oct 13, 2021 · Oct 13, 2021 · Oct 13, 2021
diff --git a/NEWS.md b/NEWS.md
@@ -2,6 +2,9 @@
 
 * Add R function `detectCores()` (#48).
 
+* Add classes `ProgressCounter` and `ProgressBar` for tracking progress in long-
+  running loops (#49).
+
 
 # RcppThread 1.0.0
 

diff --git a/README.md b/README.md
@@ -14,7 +14,8 @@ Provides R-friendly threading functionality:
    [`std::thread`](http://en.cppreference.com/w/cpp/thread/thread),
   * classes for the [thread pool
     pattern](https://en.wikipedia.org/wiki/Thread_pool) and parallel for loops
-    for easy and flexible parallelism.
+    for easy and flexible parallelism,
+  * thread safe progress tracking.
 
 The library is header-only, platform-independent, and only 
 requires a 
@@ -26,6 +27,30 @@ For a detailed description of its functionality and examples, see the associated
 [JSS paper](https://doi.org/10.18637/jss.v097.c01)
 or the [API documentation](https://tnagler.github.io/RcppThread/).
 
+Since then, the following features have been added:
+
+- An R function `RcppThread::detectCores()` to determine the number of (logical)
+  cores on your machine.
+
+- C++ classes `ProgressCounter` and `ProgressBar` for tracking progress in 
+  long-running loops.  
+  **Example usage:**
+  ``` cpp
+    // 20 iterations in loop, update progress every 1 sec
+    RcppThread::ProgressBar bar(20, 1);
+    RcppThread::parallelFor(0, 20, [&] (int i) {
+        std::this_thread::sleep_for(std::chrono::milliseconds(200));
+        bar++;
+    });
+  ```
+  **Output:** (just one line that is continuously updated)
+  ``` 
+  ...
+  Computing: [==========================              ] 65% (~1s remaining)       
+  ...
+  Computing: [========================================] 100% (done) 
+  ```
+
 ## Installation
 
 Release version from CRAN:

diff --git a/docs/annotated.html b/docs/annotated.html
@@ -55,6 +55,9 @@ <h1>Classes</h1>
           <li class="m-doc-collapsible">
             <a href="#" onclick="return toggle(this)">namespace</a> <a href="namespaceRcppThread.html" class="m-doc">RcppThread</a> <span class="m-doc"><code>RcppThread</code> functionality</span>
             <ul class="m-doc">
+              <li>class <a href="classRcppThread_1_1ProgressBar.html" class="m-doc">ProgressBar</a> <span class="m-doc">A progress bar showing progress in percent.</span></li>
+              <li>class <a href="classRcppThread_1_1ProgressCounter.html" class="m-doc">ProgressCounter</a> <span class="m-doc">A counter showing progress in percent.</span></li>
+              <li>class <a href="classRcppThread_1_1ProgressPrinter.html" class="m-doc">ProgressPrinter</a> <span class="m-doc">Abstract class for printing progress.</span></li>
               <li>class <a href="classRcppThread_1_1RMonitor.html" class="m-doc">RMonitor</a> <span class="m-doc">Singleton class for tracking threads and safe communication.</span></li>
               <li>class <a href="classRcppThread_1_1RPrinter.html" class="m-doc">RPrinter</a> <span class="m-doc">Safely printing to the R console from threaded code.</span></li>
               <li>class <a href="classRcppThread_1_1Thread.html" class="m-doc">Thread</a> <span class="m-doc">R-friendly version of <code>std::thread</code>.</span></li>

diff --git a/docs/classRcppThread_1_1ProgressBar.html b/docs/classRcppThread_1_1ProgressBar.html
@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <title>RcppThread::ProgressBar class | RcppThread R-friendly
+threading
+in
+C++</title>
+  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
+  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
+  <link rel="icon" href="favicon-dark.png" type="image/png" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <meta name="theme-color" content="#22272e" />
+</head>
+<body>
+<header><nav id="navigation">
+  <div class="m-container">
+    <div class="m-row">
+      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
+        <a href="https://github.com/tnagler/RcppThread">RcppThread</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">R-friendly
+threading
+in
+C++</a>
+      </span>
+      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
+        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
+          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
+        </svg></a>
+        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
+        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
+      </div>
+      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
+        <div class="m-row">
+          <ol class="m-col-t-6 m-col-m-none">
+            <li><a href="namespaceRcppThread.html">RcppThread</a></li>
+            <li><a href="overrides.html">Automatic overrides</a></li>
+          </ol>
+          <ol class="m-col-t-6 m-col-m-none" start="3">
+            <li><a href="https://github.com/tnagler/RcppThread">GitHub</a></li>
+            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
+              <use href="#m-doc-search-icon-path" />
+            </svg></a></li>
+          </ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</nav></header>
+<main><article>
+  <div class="m-container m-container-inflatable">
+    <div class="m-row">
+      <div class="m-col-l-10 m-push-l-1">
+        <h1>
+          <span class="m-breadcrumb"><a href="namespaceRcppThread.html">RcppThread</a>::<wbr/></span>ProgressBar <span class="m-thin">class</span>
+        </h1>
+        <p>A progress bar showing progress in percent.</p>
+        <div class="m-block m-default">
+          <h3>Contents</h3>
+          <ul>
+            <li>
+              Reference
+              <ul>
+                <li><a href="#base-classes">Base classes</a></li>
+                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
+                <li><a href="#pri-methods">Private functions</a></li>
+              </ul>
+            </li>
+          </ul>
+        </div>
+<p>Prints to the R console in a thread safe manner using <code>Rcout</code> (an instance of <code>RcppThread::Rprinter</code>).</p>
+        <section id="base-classes">
+          <h2><a href="#base-classes">Base classes</a></h2>
+          <dl class="m-doc">
+            <dt>
+              class <a href="classRcppThread_1_1ProgressPrinter.html" class="m-doc">ProgressPrinter</a>
+            </dt>
+            <dd>Abstract class for printing progress.</dd>
+          </dl>
+        </section>
+        <section id="typeless-methods">
+          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
+          <dl class="m-doc">
+            <dt>
+              <span class="m-doc-wrap-bumper"><a href="#a09bdaf2e551442af08b10b7ef19ab7ba" class="m-doc">ProgressBar</a>(</span><span class="m-doc-wrap">size_t numIt,
+              size_t printEvery)</span>
+            </dt>
+            <dd></dd>
+          </dl>
+        </section>
+        <section id="pri-methods">
+          <h2><a href="#pri-methods">Private functions</a></h2>
+          <dl class="m-doc">
+            <dt>
+              <span class="m-doc-wrap-bumper">void <a href="#a39f9b31c61cd22cc7548abea097336ce" class="m-doc">printProgress</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">virtual</span></span>
+            </dt>
+            <dd></dd>
+          </dl>
+        </section>
+        <section>
+          <h2>Function documentation</h2>
+          <section class="m-doc-details" id="a09bdaf2e551442af08b10b7ef19ab7ba"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper"> RcppThread::<wbr />ProgressBar::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a09bdaf2e551442af08b10b7ef19ab7ba" class="m-doc-self">ProgressBar</a>(</span><span class="m-doc-wrap">size_t numIt,
+              size_t printEvery)</span></span>
+            </h3>
+            <table class="m-table m-fullwidth m-flat">
+              <thead>
+                <tr><th colspan="2">Parameters</th></tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td style="width: 1%">numIt</td>
+                  <td>total number of iterations.</td>
+                </tr>
+                <tr>
+                  <td>printEvery</td>
+                  <td>how regularly to print updates (in seconds).</td>
+                </tr>
+              </tbody>
+            </table>
+<p>constructs a progress bar.</p>
+          </div></section>
+          <section class="m-doc-details" id="a39f9b31c61cd22cc7548abea097336ce"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper">void RcppThread::<wbr />ProgressBar::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a39f9b31c61cd22cc7548abea097336ce" class="m-doc-self">printProgress</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">virtual</span> <span class="m-label m-danger">private</span></span></span>
+            </h3>
+<p>prints a progress bar to the R console (+ an estimate of remaining time).</p>
+          </div></section>
+        </section>
+      </div>
+    </div>
+  </div>
+</article></main>
+<div class="m-doc-search" id="search">
+  <a href="#!" onclick="return hideSearch()"></a>
+  <div class="m-container">
+    <div class="m-row">
+      <div class="m-col-m-8 m-push-m-2">
+        <div class="m-doc-search-header m-text m-small">
+          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
+          <div id="search-symbolcount">&hellip;</div>
+        </div>
+        <div class="m-doc-search-content">
+          <form>
+            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
+          </form>
+          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
+          <div id="search-help" class="m-text m-dim m-text-center">
+            <p class="m-noindent">Search for symbols, directories, files, pages, OpenGL, GLSL, Vulkan and OpenAL APIs. You can omit any prefix from the symbol or file path; adding a <code>:</code> or <code>/</code> suffix lists all members of given symbol or directory.</p> <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span> / <span class="m-label m-dim">&uarr;</span> to navigate through the list, <span class="m-label m-dim">Enter</span> to go. <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> produces a Markdown link.</p>
+          </div>
+          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
+          <ul id="search-results"></ul>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+<script src="search-v1.js"></script>
+<script src="searchdata-v1.js" async="async"></script>
+<footer><nav>
+  <div class="m-container">
+    <div class="m-row">
+      <div class="m-col-l-10 m-push-l-1">
+        <p>RcppThread docs. copyright © <a href="http://tnagler.com/">Thomas Nagler</a> 2021.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.8.17 and <a href="https://mcss.mosra.cz/">m.css</a>. Contact the author via <a href="https://github.com/tnagler/RcppThread">GitHub</a> or  <a href="mailto:mail@tnagler.com">e-mail</a>
+      </div>
+    </div>
+  </div>
+</nav></footer>
+</body>
+</html>