Skip to content

Clarify is_unconstrained docstring #790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Clarify is_unconstrained docstring #790

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/varnamedvector.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading