disclaimer on parallel_for

mlivesu · May 3, 2021 · 95057b5 · 95057b5
1 parent e712df6
commit 95057b5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/include/cinolib/parallel_for.h b/include/cinolib/parallel_for.h
@@ -45,6 +45,12 @@ namespace cinolib
 /* OpenMP-like parallel for loop realized in plain C++11
  * Thanks to Jeremy Dumas for his code (https://ideone.com/Z7zldb)
  *
+ * DISCLAIMER: this routine is as good as OpenMP with STATIC scheduling.
+ * That is, it works best when computational cost is equally distributed
+ * across all threads. In case of unbalanced distribution, performances
+ * may degrade, and using the DYNAMIC scheduling of a library such as OpenMP
+ * will greatly benefit performances.
+ *
  * PARALLEL_FOR has three arguments
  *
  *     beg,end             : define a range of indices