@@ -35,15 +35,16 @@ This holds options for expression evaluation, such as evaluation backend.
3535
3636# Fields
3737
38- - `turbo::Val{T}`: If `Val{true}`, use LoopVectorization.jl for faster
38+ - `turbo::Val{T}=Val(false) `: If `Val{true}`, use LoopVectorization.jl for faster
3939 evaluation.
40- - `bumper::Val{B}`: If `Val{true}`, use Bumper.jl for faster evaluation.
41- - `early_exit::Val{E}`: If `Val{true}`, any element of any step becoming
42- `NaN` or `Inf` will terminate the computation and the whole buffer will be
43- returned with `NaN`s. This makes sure that expressions with singularities
44- don't wast compute cycles. Setting `Val{false}` will continue the computation
45- as usual and thus result in `NaN`s only in the elements that actually have
46- `NaN`s.
40+ - `bumper::Val{B}=Val(false)`: If `Val{true}`, use Bumper.jl for faster evaluation.
41+ - `early_exit::Val{E}=Val(true)`: If `Val{true}`, any element of any step becoming
42+ `NaN` or `Inf` will terminate the computation. For `eval_tree_array`, this will
43+ result in the second return value, the completion flag, being `false`. For
44+ calling an expression using `tree(X)`, this will result in `NaN`s filling
45+ the entire buffer. This early exit is performed to avoid wasting compute cycles.
46+ Setting `Val{false}` will continue the computation as usual and thus result in
47+ `NaN`s only in the elements that actually have `NaN`s.
4748"""
4849struct EvalOptions{T,B,E}
4950 turbo:: Val{T}
0 commit comments