From 67bfab09033d3192d79defb79e1c313c2da03900 Mon Sep 17 00:00:00 2001 From: Miles Cranmer Date: Sun, 28 Jul 2024 11:24:16 +0900 Subject: [PATCH] docs: tweak `EvalOptions` descriptions --- src/Evaluate.jl | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/Evaluate.jl b/src/Evaluate.jl index 784b5a78..c5cedb93 100644 --- a/src/Evaluate.jl +++ b/src/Evaluate.jl @@ -35,15 +35,16 @@ This holds options for expression evaluation, such as evaluation backend. # Fields -- `turbo::Val{T}`: If `Val{true}`, use LoopVectorization.jl for faster +- `turbo::Val{T}=Val(false)`: If `Val{true}`, use LoopVectorization.jl for faster evaluation. -- `bumper::Val{B}`: If `Val{true}`, use Bumper.jl for faster evaluation. -- `early_exit::Val{E}`: If `Val{true}`, any element of any step becoming - `NaN` or `Inf` will terminate the computation and the whole buffer will be - returned with `NaN`s. This makes sure that expressions with singularities - don't wast compute cycles. Setting `Val{false}` will continue the computation - as usual and thus result in `NaN`s only in the elements that actually have - `NaN`s. +- `bumper::Val{B}=Val(false)`: If `Val{true}`, use Bumper.jl for faster evaluation. +- `early_exit::Val{E}=Val(true)`: If `Val{true}`, any element of any step becoming + `NaN` or `Inf` will terminate the computation. For `eval_tree_array`, this will + result in the second return value, the completion flag, being `false`. For + calling an expression using `tree(X)`, this will result in `NaN`s filling + the entire buffer. This early exit is performed to avoid wasting compute cycles. + Setting `Val{false}` will continue the computation as usual and thus result in + `NaN`s only in the elements that actually have `NaN`s. """ struct EvalOptions{T,B,E} turbo::Val{T}