-
Notifications
You must be signed in to change notification settings - Fork 0
/
eff_sample_size.jl
69 lines (49 loc) · 1.79 KB
/
eff_sample_size.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# This file is a part of BATBase.jl, licensed under the MIT License (MIT).
"""
abstract type EffSampleSizeAlgorithm
Abstract type for integrated autocorrelation length estimation algorithms.
"""
abstract type EffSampleSizeAlgorithm end
export EffSampleSizeAlgorithm
"""
bat_eff_sample_size(
v::Union{AbstractVector{<:Real},AbstractVectorOfSimilarVectors{<:Real}},
[algorithm::EffSampleSizeAlgorithm]
)
bat_eff_sample_size(
smpls::DensitySampleVector,
[algorithm::EffSampleSizeAlgorithm]
)
Estimate effective sample size estimation for variate series `v`, resp.
density samples `smpls`, separately for each degree of freedom.
Returns a NamedTuple of the shape
```julia
(result = eff_sample_size, ...)
```
Result properties not listed here are algorithm-specific and are not part
of the stable public API.
!!! note
Do not add add methods to `bat_eff_sample_size`, add methods to
`bat_eff_sample_size_impl` instead.
"""
function bat_eff_sample_size end
export bat_eff_sample_size
function bat_eff_sample_size_impl end
function bat_eff_sample_size(
v::Union{AbstractVector{<:Real},AbstractVectorOfSimilarVectors{<:Real}},
algorithm = bat_default_withdebug(bat_eff_sample_size, Val(:algorithm), v)
)
r = bat_eff_sample_size_impl(v, algorithm)
result_with_args(r, (algorithm = algorithm,))
end
function bat_eff_sample_size(
smpls::AbstractDensitySampleVector,
algorithm = bat_default_withdebug(bat_eff_sample_size, Val(:algorithm), smpls);
kwargs...
)
r = bat_eff_sample_size_impl(smpls, algorithm; kwargs...)
result_with_args(r, (algorithm = algorithm,))
end
function argchoice_msg(::typeof(bat_eff_sample_size), ::Val{:algorithm}, x::EffSampleSizeAlgorithm)
"Using integrated autocorrelation length estimator $x"
end