Skip to content

Commit

Permalink
Add information on methods for mcse (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
rikhuijzer committed Jul 4, 2021
1 parent c5125f4 commit f9a3eb5
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/mcse.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
#################### Monte Carlo Standard Errors ####################

"""
mcse(x::AbstractVector{<:Real}; method::Symbol=:imse, kwargs...)
Compute the Monte Carlo standard error (MCSE) of samples `x`.
The optional argument `method` describes how the errors are estimated. Possible options are:
- `:bm` for batch means [^Glynn1991]
- `:imse` initial monotone sequence estimator [^Geyer1992]
- `:ipse` initial positive sequence estimator [^Geyer1992]
[^Glynn1991]: Glynn, P. W., & Whitt, W. (1991). Estimating the asymptotic variance with batch means. Operations Research Letters, 10(8), 431-435.
[^Geyer1992]: Geyer, C. J. (1992). Practical Markov Chain Monte Carlo. Statistical Science, 473-483.
"""
function mcse(x::AbstractVector{<:Real}; method::Symbol=:imse, kwargs...)
return if method === :bm
Expand Down

0 comments on commit f9a3eb5

Please sign in to comment.