Skip to content

Commit 9d16e44

Browse files
committed
Delete outdated note about TeamPolicy::set_scratch_size returning a copy and not modifying the underlying policy
1 parent e727fc2 commit 9d16e44

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/source/ProgrammingGuide/HierarchicalParallelism.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ struct functor {
146146
}
147147
};
148148
```
149-
The `set_scratch_size` function of the [`TeamPolicy`](../API/core/policies/TeamPolicy) takes two or three arguments. The first argument specifies the level in the scratch hierarchy for which a specific size is requested. Different levels have different restrictions. Generally, the first level is restricted to a few tens of kilobytes roughly corresponding to L1 cache size. The second level can be used to get an aggregate over all teams of a few gigabyte, corresponding to available space in high-bandwidth memory. The third level mostly falls back to capacity memory in the node. The second and third argument are either per-thread or per-team sizes for scratch memory. Note like previously discussed, the setter function does not modify the instance it is called on, but returns a copy of the policy object with adjusted scratch size request.
149+
The `set_scratch_size` function of the [`TeamPolicy`](../API/core/policies/TeamPolicy) takes two or three arguments. The first argument specifies the level in the scratch hierarchy for which a specific size is requested. Different levels have different restrictions. Generally, the first level is restricted to a few tens of kilobytes roughly corresponding to L1 cache size. The second level can be used to get an aggregate over all teams of a few gigabyte, corresponding to available space in high-bandwidth memory. The third level mostly falls back to capacity memory in the node. The second and third argument are either per-thread or per-team sizes for scratch memory.
150150

151151
Here are some examples:
152152

0 commit comments

Comments
 (0)