From 244ccf23f7823ed9cc180b02d267abc81265012c Mon Sep 17 00:00:00 2001 From: Penelope Yong Date: Sun, 26 Jan 2025 13:13:50 +0000 Subject: [PATCH] Clarify is_unconstrained docstring --- src/varnamedvector.jl | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/varnamedvector.jl b/src/varnamedvector.jl index b324e9134..565e82480 100644 --- a/src/varnamedvector.jl +++ b/src/varnamedvector.jl @@ -159,10 +159,12 @@ struct VarNamedVector{ transforms::TTrans """ - vector of booleans indicating whether a variable has been transformed to unconstrained - Euclidean space or not, i.e. whether its domain is all of `ℝ^ⁿ`. Having - `is_unconstrained[varname_to_index[vn]] == false` does not necessarily mean that a - variable is constrained, but rather that it's not guaranteed to not be. + vector of booleans indicating whether a variable has been explicitly transformed to + unconstrained Euclidean space, i.e. whether its domain is all of `ℝ^ⁿ`. If + `is_unconstrained[varname_to_index[vn]]` is true, it guarantees that the variable + `vn` is not constrained. However, the converse does not hold: if `is_unconstrained` + is false, the variable `vn` may still happen to be unconstrained, e.g. if its + original distribution is itself unconstrained (like a normal distribution). """ is_unconstrained::BitVector