Skip to content

Commit

Permalink
Document field changes from Integer to Int in MCMC types.
Browse files Browse the repository at this point in the history
  • Loading branch information
brian-j-smith committed Jul 27, 2015
1 parent d6e2bf5 commit 62ebc6f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/mcmc/chains.rst
Expand Up @@ -25,7 +25,7 @@ Fields
* ``value::Array{Float64,3}`` : a 3-dimensional array of sampled values whose first, second, and third dimensions index the iterations, parameter elements, and runs of an MCMC sampler, respectively.
* ``range::Range{Int}`` : range of iterations stored in the rows of the ``value`` array.
* ``names::Vector{String}`` : names assigned to the parameter elements.
* ``chains::Vector{Integer}`` : indices to the MCMC runs.
* ``chains::Vector{Int}`` : indices to the MCMC runs.
* ``model::Model`` : the model from which the sampled values were generated (``ModelChain`` only).

Constructors
Expand Down
6 changes: 3 additions & 3 deletions doc/mcmc/dependent.rst
Expand Up @@ -20,7 +20,7 @@ Fields

* ``value::T`` : a scalar or array of ``Float64`` values that represent samples from a target distribution.
* ``symbol::Symbol`` : an identifying symbol for the node.
* ``linklength::Integer`` : number of elements returned by the ``link`` method defined on the type. Generally, this will be the number of unique elements in the node. In most cases, ``linklength`` will be equal to ``length(value)``. However, for some structures, like stochastic covariance matrices, ``linklength`` may be smaller.
* ``linklength::Int`` : number of elements returned by the ``link`` method defined on the type. Generally, this will be the number of unique elements in the node. In most cases, ``linklength`` will be equal to ``length(value)``. However, for some structures, like stochastic covariance matrices, ``linklength`` may be smaller.
* ``monitor::Vector{Int}`` : indices identifying elements of the ``value`` field to include in monitored MCMC sampler output.
* ``eval::Function`` : a function for updating the state of the node.
* ``sources::Vector{Symbol}`` : symbols of other nodes upon whom the values of this one depends.
Expand Down Expand Up @@ -126,7 +126,7 @@ Fields

* ``value`` : values of type ``Float64`` for ``ScalarLogical`` nodes and ``Array{Float64}`` for ``ArrayLogical`` nodes that represent samples from a target distribution.
* ``symbol::Symbol`` : an identifying symbol for the node.
* ``linklength::Integer`` : number of elements returned by the ``link`` method defined on the type.
* ``linklength::Int`` : number of elements returned by the ``link`` method defined on the type.
* ``monitor::Vector{Int}`` : indices identifying elements of the ``value`` field to include in monitored MCMC sampler output.
* ``eval::Function`` : a function for updating values stored in ``value``.
* ``sources::Vector{Symbol}`` : symbols of other nodes upon whom the values of this one depends.
Expand Down Expand Up @@ -217,7 +217,7 @@ Fields

* ``value`` : values of type ``Float64`` for ``ScalarStochastic`` nodes and ``Array{Float64}`` for ``ArrayStochastic`` nodes that represent samples from a target distribution.
* ``symbol::Symbol`` : an identifying symbol for the node.
* ``linklength::Integer`` : number of elements returned by the ``link`` method defined on the type.
* ``linklength::Int`` : number of elements returned by the ``link`` method defined on the type.
* ``monitor::Vector{Int}`` : indices identifying elements of the ``value`` field to include in monitored MCMC sampler output.
* ``eval::Function`` : a function for updating the ``distr`` field for the node.
* ``sources::Vector{Symbol}`` : symbols of other nodes upon whom the distributional specification for this one depends.
Expand Down
6 changes: 3 additions & 3 deletions doc/mcmc/model.rst
Expand Up @@ -19,9 +19,9 @@ Fields
* ``dependents::Vector{Symbol}`` : symbols of all ``Dependent`` nodes in topologically sorted order so that a given node in the vector is conditionally independent of subsequent nodes, given the previous ones.
* ``samplers::Vector{Sampler}`` : sampling functions for updating blocks of stochastic nodes.
* ``states::Vector{Vector{Float64}}`` : states of chains at the end of a possible series of MCMC runs.
* ``iter::Integer`` : current MCMC draw from the target distribution.
* ``burnin::Integer`` : number of initial draws to discard as a burn-in sequence to allow for convergence.
* ``chain::Integer`` : current run of an MCMC simulator in a possible series of runs.
* ``iter::Int`` : current MCMC draw from the target distribution.
* ``burnin::Int`` : number of initial draws to discard as a burn-in sequence to allow for convergence.
* ``chain::Int`` : current run of an MCMC simulator in a possible series of runs.
* ``hasinputs::Bool`` : whether values have been assigned to the input nodes.
* ``hasinits::Bool`` : whether initial values have been assigned to stochastic nodes.

Expand Down

0 comments on commit 62ebc6f

Please sign in to comment.