Skip to content

Commit 00e7ee3

Browse files
authored
Clarify is_unconstrained docstring (#790)
1 parent 7a140bc commit 00e7ee3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/varnamedvector.jl

+6-4
Original file line numberDiff line numberDiff line change
@@ -159,10 +159,12 @@ struct VarNamedVector{
159159
transforms::TTrans
160160

161161
"""
162-
vector of booleans indicating whether a variable has been transformed to unconstrained
163-
Euclidean space or not, i.e. whether its domain is all of `ℝ^ⁿ`. Having
164-
`is_unconstrained[varname_to_index[vn]] == false` does not necessarily mean that a
165-
variable is constrained, but rather that it's not guaranteed to not be.
162+
vector of booleans indicating whether a variable has been explicitly transformed to
163+
unconstrained Euclidean space, i.e. whether its domain is all of `ℝ^ⁿ`. If
164+
`is_unconstrained[varname_to_index[vn]]` is true, it guarantees that the variable
165+
`vn` is not constrained. However, the converse does not hold: if `is_unconstrained`
166+
is false, the variable `vn` may still happen to be unconstrained, e.g. if its
167+
original distribution is itself unconstrained (like a normal distribution).
166168
"""
167169
is_unconstrained::BitVector
168170

0 commit comments

Comments
 (0)