Deploying to gh-pages from @ 7c21ee3 🚀

computablee · Oct 30, 2023 · b948088 · b948088
1 parent e3f782b
commit b948088
Show file tree

Hide file tree

Showing 100 changed files with 610 additions and 501 deletions.
diff --git a/classDotMP_1_1ForkedRegion.html b/classDotMP_1_1ForkedRegion.html
@@ -223,6 +223,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#aeb2a90e75d37da72c6fed2db
 </div><div class="memdoc">
 
 <p>Starts the threadpool and waits for all threads to complete before returning. </p>
+<dl class="exception"><dt>Exceptions</dt><dd>
+  <table class="exception">
+    <tr><td class="paramname">Exception</td><td>Thrown if an exception is caught in the threadpool. If multiple are thrown, the first one thrown is returned.</td></tr>
+  </table>
+  </dd>
+</dl>
 
 </div>
 </div>

diff --git a/classDotMP_1_1Region-members.html b/classDotMP_1_1Region-members.html
@@ -72,6 +72,8 @@
 
 <p>This is the complete list of members for <a class="el" href="classDotMP_1_1Region.html">DotMP.Region</a>, including all inherited members.</p>
 <table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="classDotMP_1_1Region.html#a714d78358f8699e31df7da0579c34319">CreateThread</a>(Action omp_fn, int tid, uint num_threads)</td><td class="entry"><a class="el" href="classDotMP_1_1Region.html">DotMP.Region</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">package</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classDotMP_1_1Region.html#afe9c4fb11322028e220a9e566d6a5836">ex</a></td><td class="entry"><a class="el" href="classDotMP_1_1Region.html">DotMP.Region</a></td><td class="entry"><span class="mlabel">package</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classDotMP_1_1Region.html#af52a78c9d496c812545e76d38dc872c4">num_threads</a></td><td class="entry"><a class="el" href="classDotMP_1_1Region.html">DotMP.Region</a></td><td class="entry"><span class="mlabel">package</span></td></tr>
   <tr><td class="entry"><a class="el" href="classDotMP_1_1Region.html#a8b47660ccc8e238df34688a39f2c8846">omp_fn</a></td><td class="entry"><a class="el" href="classDotMP_1_1Region.html">DotMP.Region</a></td><td class="entry"><span class="mlabel">package</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classDotMP_1_1Region.html#a5a131ad38ebaac3381b2a7568788818f">Region</a>(uint num_threads, Action omp_fn)</td><td class="entry"><a class="el" href="classDotMP_1_1Region.html">DotMP.Region</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">package</span></td></tr>

diff --git a/classDotMP_1_1Region.html b/classDotMP_1_1Region.html
@@ -79,6 +79,9 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pac-methods"></a>
 Package Functions</h2></td></tr>
+<tr class="memitem:a714d78358f8699e31df7da0579c34319"><td class="memItemLeft" align="right" valign="top">Thread&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDotMP_1_1Region.html#a714d78358f8699e31df7da0579c34319">CreateThread</a> (Action <a class="el" href="classDotMP_1_1Region.html#a8b47660ccc8e238df34688a39f2c8846">omp_fn</a>, int tid, uint <a class="el" href="classDotMP_1_1Region.html#af52a78c9d496c812545e76d38dc872c4">num_threads</a>)</td></tr>
+<tr class="memdesc:a714d78358f8699e31df7da0579c34319"><td class="mdescLeft">&#160;</td><td class="mdescRight">Factory for creating threads in the threadpool.  <a href="classDotMP_1_1Region.html#a714d78358f8699e31df7da0579c34319">More...</a><br /></td></tr>
+<tr class="separator:a714d78358f8699e31df7da0579c34319"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5a131ad38ebaac3381b2a7568788818f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDotMP_1_1Region.html#a5a131ad38ebaac3381b2a7568788818f">Region</a> (uint <a class="el" href="classDotMP_1_1Region.html#af52a78c9d496c812545e76d38dc872c4">num_threads</a>, Action <a class="el" href="classDotMP_1_1Region.html#a8b47660ccc8e238df34688a39f2c8846">omp_fn</a>)</td></tr>
 <tr class="memdesc:a5a131ad38ebaac3381b2a7568788818f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a specified number of threads available to the parallel region, and sets the function to be executed. Also sets other relevant data for the parallel region.  <a href="classDotMP_1_1Region.html#a5a131ad38ebaac3381b2a7568788818f">More...</a><br /></td></tr>
 <tr class="separator:a5a131ad38ebaac3381b2a7568788818f"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -97,6 +100,9 @@
 <tr class="memitem:a8b47660ccc8e238df34688a39f2c8846"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDotMP_1_1Region.html#a8b47660ccc8e238df34688a39f2c8846">omp_fn</a></td></tr>
 <tr class="memdesc:a8b47660ccc8e238df34688a39f2c8846"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function to be executed.  <a href="classDotMP_1_1Region.html#a8b47660ccc8e238df34688a39f2c8846">More...</a><br /></td></tr>
 <tr class="separator:a8b47660ccc8e238df34688a39f2c8846"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afe9c4fb11322028e220a9e566d6a5836"><td class="memItemLeft" align="right" valign="top">Exception&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDotMP_1_1Region.html#afe9c4fb11322028e220a9e566d6a5836">ex</a></td></tr>
+<tr class="memdesc:afe9c4fb11322028e220a9e566d6a5836"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exception caught from threads.  <a href="classDotMP_1_1Region.html#afe9c4fb11322028e220a9e566d6a5836">More...</a><br /></td></tr>
+<tr class="separator:afe9c4fb11322028e220a9e566d6a5836"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Contains relevant internal information about parallel regions, including the threads and the function to be executed. Provides a region-wide lock and SpinWait objects for each thread. </p>
@@ -144,9 +150,87 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5a131ad38ebaac3381b2a756
   </dd>
 </dl>
 
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="a714d78358f8699e31df7da0579c34319"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a714d78358f8699e31df7da0579c34319">&#9670;&nbsp;</a></span>CreateThread()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">Thread DotMP.Region.CreateThread </td>
+          <td>(</td>
+          <td class="paramtype">Action&#160;</td>
+          <td class="paramname"><em>omp_fn</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>tid</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint&#160;</td>
+          <td class="paramname"><em>num_threads</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">package</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Factory for creating threads in the threadpool. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">omp_fn</td><td>The function to execute.</td></tr>
+    <tr><td class="paramname">tid</td><td>The thread ID.</td></tr>
+    <tr><td class="paramname">num_threads</td><td>The total number of threads.</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The created Thread object.</dd></dl>
+
 </div>
 </div>
 <h2 class="groupheader">Member Data Documentation</h2>
+<a id="afe9c4fb11322028e220a9e566d6a5836"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afe9c4fb11322028e220a9e566d6a5836">&#9670;&nbsp;</a></span>ex</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">Exception DotMP.Region.ex</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">package</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Exception caught from threads. </p>
+
+</div>
+</div>
 <a id="af52a78c9d496c812545e76d38dc872c4"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#af52a78c9d496c812545e76d38dc872c4">&#9670;&nbsp;</a></span>num_threads</h2>
 

diff --git a/functions_c.html b/functions_c.html
@@ -107,6 +107,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
 <li>CreateRegion()
 : <a class="el" href="classDotMPTests_1_1ParallelTests.html#a7d5d1bc493c8207aa7e9c4b4dcbf3851">DotMPTests.ParallelTests</a>
 </li>
+<li>CreateThread()
+: <a class="el" href="classDotMP_1_1Region.html#a714d78358f8699e31df7da0579c34319">DotMP.Region</a>
+</li>
 <li>Critical()
 : <a class="el" href="classDotMP_1_1Parallel.html#a79148a921477136e2e534760b9486654">DotMP.Parallel</a>
 </li>

diff --git a/functions_e.html b/functions_e.html
@@ -77,6 +77,9 @@ <h3><a id="index_e"></a>- e -</h3><ul>
 <li>EnqueueTaskloopTask()
 : <a class="el" href="classDotMP_1_1TaskingContainer.html#a6bb8e95ea5f6538cfd685e92076ed7d3">DotMP.TaskingContainer</a>
 </li>
+<li>ex
+: <a class="el" href="classDotMP_1_1Region.html#afe9c4fb11322028e220a9e566d6a5836">DotMP.Region</a>
+</li>
 <li>executed
 : <a class="el" href="classDotMPTests_1_1Serial.html#ad7d41faa8aef4dac9fc06379fd121234">DotMPTests.Serial</a>
 </li>

diff --git a/functions_func.html b/functions_func.html
@@ -124,6 +124,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
 <li>CreateRegion()
 : <a class="el" href="classDotMPTests_1_1ParallelTests.html#a7d5d1bc493c8207aa7e9c4b4dcbf3851">DotMPTests.ParallelTests</a>
 </li>
+<li>CreateThread()
+: <a class="el" href="classDotMP_1_1Region.html#a714d78358f8699e31df7da0579c34319">DotMP.Region</a>
+</li>
 <li>Critical()
 : <a class="el" href="classDotMP_1_1Parallel.html#a79148a921477136e2e534760b9486654">DotMP.Parallel</a>
 </li>

diff --git a/functions_vars.html b/functions_vars.html
@@ -131,6 +131,9 @@ <h3><a id="index_e"></a>- e -</h3><ul>
 , <a class="el" href="classDotMP_1_1StaticScheduler.html#a78fda89e1534274ed0fa940897191443">DotMP.StaticScheduler</a>
 , <a class="el" href="classDotMPTests_1_1Serial.html#a34f327bc394595b729ae8a5ca0ed851a">DotMPTests.Serial</a>
 </li>
+<li>ex
+: <a class="el" href="classDotMP_1_1Region.html#afe9c4fb11322028e220a9e566d6a5836">DotMP.Region</a>
+</li>
 <li>executed
 : <a class="el" href="classDotMPTests_1_1Serial.html#ad7d41faa8aef4dac9fc06379fd121234">DotMPTests.Serial</a>
 </li>

diff --git a/search/all_10.js b/search/all_10.js
diff --git a/search/all_11.js b/search/all_11.js
@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['unmet_5fdependencies_248',['unmet_dependencies',['../classDotMP_1_1DAG.html#ac0dfa3820da4457c21b38d7102a64dce',1,'DotMP::DAG']]],
-  ['unset_249',['Unset',['../classDotMP_1_1Lock.html#a22ed7dfb941d9bfd857ac4933cb35cad',1,'DotMP::Lock']]],
-  ['uuid_250',['uuid',['../classDotMP_1_1TaskUUID.html#a33c84d9706c1a627e3f0fb993892a5df',1,'DotMP::TaskUUID']]]
+  ['unmet_5fdependencies_251',['unmet_dependencies',['../classDotMP_1_1DAG.html#ac0dfa3820da4457c21b38d7102a64dce',1,'DotMP::DAG']]],
+  ['unset_252',['Unset',['../classDotMP_1_1Lock.html#a22ed7dfb941d9bfd857ac4933cb35cad',1,'DotMP::Lock']]],
+  ['uuid_253',['uuid',['../classDotMP_1_1TaskUUID.html#a33c84d9706c1a627e3f0fb993892a5df',1,'DotMP::TaskUUID']]]
 ];
diff --git a/search/all_12.js b/search/all_12.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['validateparams_251',['ValidateParams',['../classDotMP_1_1Parallel.html#ae2c8f1f0d27757de18577068e59fbcdb',1,'DotMP::Parallel']]]
+  ['validateparams_254',['ValidateParams',['../classDotMP_1_1Parallel.html#ae2c8f1f0d27757de18577068e59fbcdb',1,'DotMP::Parallel']]]
 ];
diff --git a/search/all_13.js b/search/all_13.js
@@ -1,8 +1,8 @@
 var searchData=
 [
-  ['working_5fiter_252',['working_iter',['../classDotMP_1_1Thr.html#a25a338cce1a698e8bb9f420d3b27d5dc',1,'DotMP::Thr']]],
-  ['workload_253',['Workload',['../classDotMPTests_1_1ParallelTests.html#a4c04a723fc9a9374f7f848418858bc47',1,'DotMPTests::ParallelTests']]],
-  ['workshare_254',['WorkShare',['../classDotMP_1_1WorkShare.html',1,'DotMP.WorkShare'],['../classDotMP_1_1WorkShare.html#a7897aa29485f79e222e38e06de8a4104',1,'DotMP.WorkShare.WorkShare(uint num_threads, Thread[] threads, int start, int end, uint chunk_size, Operations? op, IScheduler schedule)'],['../classDotMP_1_1WorkShare.html#a0bda53276ee9ae9b08d845a274f8888b',1,'DotMP.WorkShare.WorkShare()']]],
-  ['wrappers_2ecs_255',['Wrappers.cs',['../Wrappers_8cs.html',1,'']]],
-  ['ws_5flock_256',['ws_lock',['../classDotMP_1_1Region.html#a3df81abb19865bf08fda557206462437',1,'DotMP::Region']]]
+  ['working_5fiter_255',['working_iter',['../classDotMP_1_1Thr.html#a25a338cce1a698e8bb9f420d3b27d5dc',1,'DotMP::Thr']]],
+  ['workload_256',['Workload',['../classDotMPTests_1_1ParallelTests.html#a4c04a723fc9a9374f7f848418858bc47',1,'DotMPTests::ParallelTests']]],
+  ['workshare_257',['WorkShare',['../classDotMP_1_1WorkShare.html',1,'DotMP.WorkShare'],['../classDotMP_1_1WorkShare.html#a7897aa29485f79e222e38e06de8a4104',1,'DotMP.WorkShare.WorkShare(uint num_threads, Thread[] threads, int start, int end, uint chunk_size, Operations? op, IScheduler schedule)'],['../classDotMP_1_1WorkShare.html#a0bda53276ee9ae9b08d845a274f8888b',1,'DotMP.WorkShare.WorkShare()']]],
+  ['wrappers_2ecs_258',['Wrappers.cs',['../Wrappers_8cs.html',1,'']]],
+  ['ws_5flock_259',['ws_lock',['../classDotMP_1_1Region.html#a3df81abb19865bf08fda557206462437',1,'DotMP::Region']]]
 ];