Skip to content

Commit 23b9119

Browse files
committed
renamed parameters and setparameters!! to values and setvalues!!
1 parent de0e5b2 commit 23b9119

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/src/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ AbstractMCMC.chainsstack
8181

8282
To make it a bit easier to interact with some arbitrary sampler state, we encourage implementations of `AbstractSampler` to implement the following methods:
8383
```@docs
84-
AbstractMCMC.parameters
85-
AbstractMCMC.setparameters!!
84+
AbstractMCMC.values
85+
AbstractMCMC.setvalues!!
8686
```
8787
and optionally
8888
```@docs

src/AbstractMCMC.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,27 +84,27 @@ struct MCMCSerial <: AbstractMCMCEnsemble end
8484
8585
Return new instance of `state` using information from `transition_prev` and, optionally, `state_prev`.
8686
87-
Defaults to `setparameters!!(state, parameters(transition_prev))`.
87+
Defaults to `setvalues!!(state, values(transition_prev))`.
8888
"""
8989
updatestate!!(state, transition_prev, state_prev) = updatestate!!(state, transition_prev)
90-
updatestate!!(state, transition) = setparameters!!(state, parameters(transition))
90+
updatestate!!(state, transition) = setvalues!!(state, values(transition))
9191

9292
"""
93-
setparameters!!(state, parameters)
93+
setvalues!!(state, values)
9494
95-
Update the parameters of the `state` with `parameters` and return it.
95+
Update the values of the `state` with `values` and return it.
9696
9797
If `state` can be updated in-place, it is expected that this function returns `state` with updated
98-
parameters. Otherwise a new `state` object with the new `parameters` is returned.
98+
values. Otherwise a new `state` object with the new `values` is returned.
9999
"""
100-
function setparameters!! end
100+
function setvalues!! end
101101

102102
"""
103-
parameters(transition)
103+
values(transition)
104104
105-
Return parameters in `transition`.
105+
Return values in `transition`.
106106
"""
107-
function parameters end
107+
function values end
108108

109109

110110
include("samplingstats.jl")

0 commit comments

Comments
 (0)