File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed
Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change @@ -12,6 +12,21 @@ matrices of values.
1212Note that, despite its name, an `AbstractChain` can store multiple chains (e.g. when
1313sampling in parallel, or when combining chains from multiple runs). The main reason why this
1414needs to be a singular form is because the package name is already AbstractChains (plural).
15+
16+ ## Interface
17+
18+ To implement a new subtype of `AbstractChain`, you need to define the following methods:
19+
20+ - `Base.size` should return a tuple of ints (the exact meaning is left to you)
21+ - `Base.keys` should return a list of keys
22+ - [`AbstractChains.get_data`](@ref)`(chn, key)`
23+ - [`AbstractChains.iter_indices`](@ref)`(chn)`
24+ - [`AbstractChains.chain_indices`](@ref)`(chn)`
25+
26+ You can optionally define the following methods for efficiency:
27+
28+ - [`AbstractChains.niters`](@ref)`(chn)`
29+ - [`AbstractChains.nchains`](@ref)`(chn)`
1530"""
1631abstract type AbstractChain end
1732
You can’t perform that action at this time.
0 commit comments