HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_TaskList.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: UT_TaskList.h (UT Library, C++)
7  *
8  * COMMENTS:
9  */
10 
11 #ifndef __UT_TASKLIST_H_INCLUDED__
12 #define __UT_TASKLIST_H_INCLUDED__
13 
14 #include "UT_Array.h"
15 #include "UT_Assert.h"
16 #include "UT_Function.h"
17 #include "UT_TaskScope.h"
18 #include "UT_Thread.h"
19 #include <SYS/SYS_Deprecated.h>
20 #include <tbb/parallel_for.h>
21 #include <tbb/task_group.h>
22 #include <type_traits>
23 #include <utility>
24 
25 /// @note Consider using UT_TaskGroup instead, except that UT_TaskGroup will
26 /// NOT spawn with a UT_TaskScope (you need to do this yourself).
27 class SYS_DEPRECATED_REPLACE(19.5, UT_TaskGroup()) UT_TaskList
28 {
29 public:
30 
31  /// Returns true when number of tasks is non-zero
32  bool isEmpty() const
33  {
34  return myTasks.isEmpty();
35  }
36 
37  /// Removes all tasks
38  void clear()
39  {
40  myTasks.clear();
41  }
42 
43  /// Append a task
44  template <typename Body>
45  void append(Body&& task)
46  {
47  myTasks.emplace_back(std::forward<Body>(task));
48  }
49 
50  /// Spawn this task list as root tasks and wait
51  void spawnRootAndWait()
52  {
53  tbb::task_group tg;
54  const UT_TaskScope *parent = UT_TaskScope::getCurrent();
55  for (auto&& task : myTasks)
56  {
57  tg.run([parent, task]() {
58  UT_TaskScope task_scope(parent);
59  task();
60  });
61  }
62  (void) tg.wait();
63  }
64 
65  /// Run this task list in serial
66  void runSerial()
67  {
68  for (auto&& task : myTasks)
69  task();
70  }
71 
72 private:
73  UT_Array<UT_Function<void()>> myTasks;
74 };
75 
76 SYS_DEPRECATED_PUSH_DISABLE()
77 
78 /// Append a UTparallelFor() task to a UT_TaskList for later spawning en masse.
79 /// @see UTparallelFor(), UT_TaskList
80 template <typename RANGE, typename BODY>
81 SYS_DEPRECATED_REPLACE(19.5, UTparallelForRunInTaskGroup())
82 void
83 UTparallelForAppendToTaskList(
84  UT_TaskList &task_list,
85  RANGE &&range,
86  BODY &&body)
87 {
88  // We forward range and body into the lambda so that if they were movable
89  // temporaries, this can avoid an extra copy.
90  task_list.append(
91  [range = std::forward<RANGE>(range), body = std::forward<BODY>(body)]()
92  {
93  UT_ASSERT(UT_Thread::isThreadingEnabled());
94  tbb::parallel_for(range, body, tbb::simple_partitioner());
95  });
96 }
97 
98 SYS_DEPRECATED_POP_DISABLE()
99 
100 #endif // __UT_TASKLIST_H_INCLUDED__
parallel_for
void parallel_for(int64_t start, int64_t end, std::function< void(int64_t index)> &&task, parallel_options opt=parallel_options(0, Split_Y, 1))
Definition: parallel.h:127
UT_TaskScope
Definition: UT_TaskScope.h:42
range
GLenum GLint * range
Definition: glcorearb.h:1925
UT_TaskList::spawnRootAndWait
void spawnRootAndWait()
Spawn this task list as root tasks and wait.
Definition: UT_TaskList.h:51
void
void
Definition: png.h:1083
UT_TaskScope::getCurrent
static const UT_TaskScope * getCurrent()
Definition: UT_TaskScope.h:96
SYS_DEPRECATED_PUSH_DISABLE
#define SYS_DEPRECATED_PUSH_DISABLE()
Definition: SYS_Deprecated.h:62
SYS_DEPRECATED_POP_DISABLE
#define SYS_DEPRECATED_POP_DISABLE()
Definition: SYS_Deprecated.h:64
UT_TaskGroup
Definition: UT_TaskGroup.h:89
UT_TaskList::append
void append(Body &&task)
Append a task.
Definition: UT_TaskList.h:45
UT_Array.h
UT_Assert.h
UT_Array
Definition: BV_KDOPTree.h:18
UT_Thread::isThreadingEnabled
static bool isThreadingEnabled()
SYS_DEPRECATED_REPLACE
#define SYS_DEPRECATED_REPLACE(__V__, __R__)
Definition: SYS_Deprecated.h:39
UTparallelForAppendToTaskList
void UTparallelForAppendToTaskList(UT_TaskList &task_list, RANGE &&range, BODY &&body)
Definition: UT_TaskList.h:83
UT_TaskScope.h
UTparallelForRunInTaskGroup
void UTparallelForRunInTaskGroup(UT_TaskGroup &task_group, RANGE &&range, BODY &&body)
Definition: UT_TaskGroup.h:139
UT_Function.h
UT_TaskList
Definition: UT_TaskList.h:27
UT_TaskList::clear
void clear()
Removes all tasks.
Definition: UT_TaskList.h:38
UT_TaskList::isEmpty
bool isEmpty() const
Returns true when number of tasks is non-zero.
Definition: UT_TaskList.h:32
UT_ASSERT
#define UT_ASSERT(ZZ)
Definition: UT_Assert.h:156
SYS_Deprecated.h
UT_Thread.h
UT_TaskList::runSerial
void runSerial()
Run this task list in serial.
Definition: UT_TaskList.h:66