Skip to content

Commit 172d26a

Browse files
committed
Add limitations to @turbo docstring.
1 parent 35257f3 commit 172d26a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/constructors.jl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,14 @@ Annotate a `for` loop, or a set of nested `for` loops whose bounds are constant
138138
end
139139
end
140140
141-
The macro models the set of nested loops, and chooses an ordering of the three loops to
142-
minimize predicted computation time.
141+
The macro models the set of nested loops, and chooses an ordering of the three loops to minimize predicted computation time.
142+
143+
Current limitations:
144+
145+
1. It assumes that loop iterations are independent.
146+
2. It does not perform bounds checks.
147+
3. It assumes that each loop iterates at least once. (Use `@turbo check_empty=true` to lift this assumption.)
148+
4. That there is only one loop at each level of the nest.
143149
144150
It may also apply to broadcasts:
145151

0 commit comments

Comments
 (0)