diff --git a/docs/src/api.md b/docs/src/api.md index a16c928b9..638f6f3ee 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -294,18 +294,19 @@ resetlogp!! ```@docs keys getindex -reset! -update! push!! empty!! isempty -getindex_internal -setindex_internal! -update_internal! -insert_internal! -length_internal -loosen_types!! -tighten_types +DynamicPPL.getindex_internal +DynamicPPL.setindex_internal! +DynamicPPL.update_internal! +DynamicPPL.insert_internal! +DynamicPPL.length_internal +DynamicPPL.reset! +DynamicPPL.update! +DynamicPPL.insert! +DynamicPPL.loosen_types!! +DynamicPPL.tighten_types ``` ```@docs diff --git a/docs/src/internals/varinfo.md b/docs/src/internals/varinfo.md index 188e50483..6c2f8b681 100644 --- a/docs/src/internals/varinfo.md +++ b/docs/src/internals/varinfo.md @@ -126,13 +126,13 @@ Hence we obtain a "type-stable when possible"-representation by wrapping it in a ## Efficient storage and iteration -Efficient storage and iteration we achieve through implementation of the `metadata`. In particular, we do so with [`VarNamedVector`](@ref): +Efficient storage and iteration we achieve through implementation of the `metadata`. In particular, we do so with [`DynamicPPL.VarNamedVector`](@ref): ```@docs DynamicPPL.VarNamedVector ``` -In a [`VarNamedVector{<:VarName,T}`](@ref), we achieve the desiderata by storing the values for different `VarName`s contiguously in a `Vector{T}` and keeping track of which ranges correspond to which `VarName`s. +In a [`DynamicPPL.VarNamedVector{<:VarName,T}`](@ref), we achieve the desiderata by storing the values for different `VarName`s contiguously in a `Vector{T}` and keeping track of which ranges correspond to which `VarName`s. This does require a bit of book-keeping, in particular when it comes to insertions and deletions. Internally, this is handled by assigning each `VarName` a unique `Int` index in the `varname_to_index` field, which is then used to index into the following fields: @@ -294,9 +294,9 @@ In the end, we have the following "rough" performance characteristics for `VarNa ## Other methods ```@docs -DynamicPPL.replace_raw_storage(::VarNamedVector, vals::AbstractVector) +DynamicPPL.replace_raw_storage(::DynamicPPL.VarNamedVector, vals::AbstractVector) ``` ```@docs; canonical=false -DynamicPPL.values_as(::VarNamedVector) +DynamicPPL.values_as(::DynamicPPL.VarNamedVector) ```