reapply formatter

.JuliaFormatter.toml

@@ -1,2 +1,3 @@
 style = "sciml"
-format_markdown = true
+format_markdown = true
+format_docstrings = true

README.md

@@ -197,7 +197,7 @@ names = [
     "Shift",
     "Digital Shift",
     "Matousek Scramble",
-    "Owen Scramble",
+    "Owen Scramble"
 ]
 p = [plot(thickness_scaling = 1.5, aspect_ratio = :equal) for i in sequences]
 for (i, x) in enumerate(sequences)

docs/make.jl

@@ -12,7 +12,7 @@ makedocs(sitename = "QuasiMonteCarlo.jl",
     warnonly = [:missing_docs],
     linkcheck_ignore = [
         "https://www.sciencedirect.com/science/article/pii/S0010465509003087",
-        "https://artowen.su.domains/mc/qmcstuff.pdf",
+        "https://artowen.su.domains/mc/qmcstuff.pdf"
     ],
     format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/QuasiMonteCarlo/stable/"),

docs/pages.jl

@@ -5,5 +5,5 @@ pages = [
     "samplers.md",
     "randomization.md",
     "design_matrix.md",
-    "types.md",
+    "types.md"
 ]

docs/src/design_matrix.md

@@ -48,7 +48,8 @@ Using `std(μ)` then gives you the estimated variance of your RQMC prediction.
 
 ```@example 2
 # Or using `generate_design_matrices`. Note that this is less memory efficient since it allocate space for 5 large big matrices.
-μ = [mean(f(c) for c in eachcol(X)) for X in QuasiMonteCarlo.generate_design_matrices(N,
+μ = [mean(f(c) for c in eachcol(X))
+     for X in QuasiMonteCarlo.generate_design_matrices(N,
     d,
     FaureSample(R = OwenScramble(base = b, pad = pad)),
     num_mats)]

docs/src/randomization.md

@@ -143,7 +143,7 @@ names = [
     "Shift",
     "Digital Shift",
     "Matousek Scramble",
-    "Owen Scramble",
+    "Owen Scramble"
 ]
 p = [plot(thickness_scaling = 1.5, aspect_ratio = :equal) for i in sequences]
 for (i, x) in enumerate(sequences)

ext/QuasiMonteCarloDistributionsExt.jl

@@ -22,9 +22,9 @@ Return a point set from a distribution `D`:
   - `ub` is the upper bound. Its dimension must match `length(lb)`.
 """
 function QuasiMonteCarlo.sample(n::Integer,
-    d::Integer,
-    D::Distributions.Sampleable,
-    T = eltype(D))
+        d::Integer,
+        D::Distributions.Sampleable,
+        T = eltype(D))
     @assert n>0 QuasiMonteCarlo.ZERO_SAMPLES_MESSAGE
     x = [[rand(D) for j in 1:d] for i in 1:n]
     return reduce(hcat, x)
@@ -51,8 +51,8 @@ Return a QMC point set where:
 In the first method the type of the point set is specified by `T` while in the second method the output type is inferred from the bound types.
 """
 function QuasiMonteCarlo.sample(n::Integer, lb::T, ub::T,
-    S::D) where {T <: Union{Base.AbstractVecOrTuple, Number},
-    D <: Distributions.Sampleable}
+        S::D) where {T <: Union{Base.AbstractVecOrTuple, Number},
+        D <: Distributions.Sampleable}
     QuasiMonteCarlo._check_sequence(lb, ub, n)
     lb = float.(lb)
     ub = float.(ub)
@@ -61,10 +61,10 @@ function QuasiMonteCarlo.sample(n::Integer, lb::T, ub::T,
 end
 
 function QuasiMonteCarlo.DesignMatrix(N,
-    d,
-    D::Distributions.Sampleable,
-    num_mats,
-    T = Float64)
+        d,
+        D::Distributions.Sampleable,
+        num_mats,
+        T = Float64)
     X = QuasiMonteCarlo.initialize(N, d, D, T)
     return QuasiMonteCarlo.DistributionDesignMat(X, D, num_mats)
 end

src/Faure.jl

@@ -11,7 +11,7 @@ end
 
 # raise a Pascal matrix to a given power.
 @fastmath function pascal_power!(result::UpperTriangular, pascal::UpperTriangular,
-    power::Integer, base::Integer)
+        power::Integer, base::Integer)
     @inbounds @simd for idx in eachindex(pascal)
         i, j = Tuple(idx)
         i ≤ j ? (result[idx] = powermod(power, j - i, base) * pascal[idx]) : result[idx]
@@ -45,7 +45,7 @@ Base.@kwdef struct FaureSample <: DeterministicSamplingAlgorithm
 end
 
 @fastmath function sample(n::Integer, dimension::Integer, S::FaureSample, T = Float64;
-    skipchecks = false)
+        skipchecks = false)
     base = nextprime(dimension)
     n_digits = ceil(Int, log(base, n))
     power = n_digits - 1
@@ -60,7 +60,7 @@ end
 end
 
 @fastmath @views function _faure_samples(n_samples::I, n_digits::I, dimension::I,
-    ::Type{F} = Float64) where {I <: Integer, F}
+        ::Type{F} = Float64) where {I <: Integer, F}
     base = nextprime(dimension)
     inv_base = inv(base)
 

src/Kronecker.jl

@@ -36,7 +36,7 @@ function sample(n::Integer, d::Integer, S::KroneckerSample{Missing}, T = Float64
 end
 
 function sample(n::Integer, d::Integer, k::KroneckerSample{V},
-    T) where {V <: AbstractVector}
+        T) where {V <: AbstractVector}
     @assert eltype(V)==T "Sample type must match generator type."
     return randomize(sample(n, d, k), k.R)
 end

src/Lattices.jl

@@ -12,7 +12,7 @@
 end
 
 function sample(n::Integer, d::Integer, S::GridSample, T = Float64)
-    samples = rand.(range.(zeros(T, d), ones(T,d); length = n+1), Ref(n))
+    samples = rand.(range.(zeros(T, d), ones(T, d); length = n + 1), Ref(n))
     randomize(mapreduce(permutedims, vcat, samples), S.R)
 end
 

src/QuasiMonteCarlo.jl

@@ -97,24 +97,24 @@ include("RandomizedQuasiMonteCarlo/scrambling_base_b.jl")
 include("RandomizedQuasiMonteCarlo/iterators.jl")
 
 export SamplingAlgorithm,
-    GridSample,
-    SobolSample,
-    LatinHypercubeSample,
-    RandomizedHaltonSample,
-    LatticeRuleSample,
-    RandomSample,
-    HaltonSample,
-    VanDerCorputSample,
-    GoldenSample,
-    KroneckerSample,
-    FaureSample,
-    randomize,
-    RandomizationMethod,
-    NoRand,
-    Shift,
-    ScrambleMethod,
-    OwenScramble,
-    MatousekScramble,
-    DigitalShift,
-    DesignMatrix
+       GridSample,
+       SobolSample,
+       LatinHypercubeSample,
+       RandomizedHaltonSample,
+       LatticeRuleSample,
+       RandomSample,
+       HaltonSample,
+       VanDerCorputSample,
+       GoldenSample,
+       KroneckerSample,
+       FaureSample,
+       randomize,
+       RandomizationMethod,
+       NoRand,
+       Shift,
+       ScrambleMethod,
+       OwenScramble,
+       MatousekScramble,
+       DigitalShift,
+       DesignMatrix
 end # module

src/RandomizedQuasiMonteCarlo/iterators.jl

@@ -8,6 +8,7 @@
 
 """
     OwenDesignMat{T<:Real, I<:Integer, F<:Integer} <: AbstractDesignMatrix
+
 Create an Owen scrambling iterator for doing multiple i.i.d. [`OwenScrambling`](@ref) randomization.
 One can use the common[`DesignMatrix`](@ref) interface to create the iterator.
 """
@@ -22,6 +23,7 @@
 
 """
     ScrambleDesignMat{T<:Real, I<:Integer} <: AbstractDesignMatrix
+
 Create a scrambling iterator (Digital Shift or Matousek depending on the `R` field) for doing multiple i.i.d. [`DigitalShift`](@ref) or [`MatousekScrambling`](@ref) randomization.
 One can use the common[`DesignMatrix`](@ref) interface to create the iterator.
 """
@@ -35,6 +37,7 @@
 
 """
     ShiftDesignMat{T<:Real} <: AbstractDesignMatrix
+
 Create a Shift iterator for doing multiple i.i.d [`Shift`](@ref) randomization.
 One can use the common[`DesignMatrix`](@ref) interface to create the iterator.
 """
@@ -46,6 +49,7 @@
 
 """
     DistributionDesignMat{T<:Real} <: AbstractDesignMatrix
+
 Create an iterator for multiple distribution randomization. The distribution is chosen with the field `D`.
 This is equivalent to using `rand!(D, X)` for some matrix `X`.
 One can use the common[`DesignMatrix`](@ref) interface to create the iterator.
@@ -58,6 +62,7 @@
 
 """
     RandomDesignMat{T<:Real} <: AbstractDesignMatrix
+
 Create an iterator for multiple uniform randomization. This it similar to [`DistributionDesignMat`](@ref) with the field `D = Uniform()`
 One can use the common[`DesignMatrix`](@ref) interface to create the iterator.
 """
@@ -76,44 +81,47 @@
 ```julia
 DesignMatrix(n, d, sample_method::DeterministicSamplingAlgorithm, num_mats, T = Float64)
 ```
+
 Create an iterator for doing multiple i.i.d. randomization over QMC sequences where
-- `num_mats` is the length of the iterator
-- `n` is the number of points to sample.
-- `d` is the dimensionality of the point set in `[0, 1)ᵈ`,
-- `sample_method` is the quasi-Monte Carlo sampling strategy used to create a deterministic point set `out`.
-- `T` is the `eltype` of the point sets. For some QMC methods (Faure, Sobol) this can be `Rational`
-It is now compatible with all scrambling methods and shifting. One can also use it with `Distributions.Sampleable` or `RandomSample`.
+
+  - `num_mats` is the length of the iterator
+  - `n` is the number of points to sample.
+  - `d` is the dimensionality of the point set in `[0, 1)ᵈ`,
+  - `sample_method` is the quasi-Monte Carlo sampling strategy used to create a deterministic point set `out`.
+  - `T` is the `eltype` of the point sets. For some QMC methods (Faure, Sobol) this can be `Rational`
+    It is now compatible with all scrambling methods and shifting. One can also use it with `Distributions.Sampleable` or `RandomSample`.
 """
-function DesignMatrix(N, d, S::DeterministicSamplingAlgorithm, num_mats::Integer, T::DataType = Float64)
+function DesignMatrix(
+        N, d, S::DeterministicSamplingAlgorithm, num_mats::Integer, T::DataType = Float64)
     return DesignMatrix(N, d, S, S.R, num_mats, T)
 end
 
 function DesignMatrix(N,
-    d,
-    S::DeterministicSamplingAlgorithm,
-    R::OwenScramble,
-    num_mats::Integer,
-    T::DataType = Float64)
+        d,
+        S::DeterministicSamplingAlgorithm,
+        R::OwenScramble,
+        num_mats::Integer,
+        T::DataType = Float64)
     X, random_bits, bits, indices = initialize(N, d, S, R, T)
     return OwenDesignMat(X, random_bits, bits, indices, R, num_mats)
 end
 
 function DesignMatrix(N,
-    d,
-    S::DeterministicSamplingAlgorithm,
-    R::ScrambleMethod,
-    num_mats::Integer,
-    T = Float64)
+        d,
+        S::DeterministicSamplingAlgorithm,
+        R::ScrambleMethod,
+        num_mats::Integer,
+        T = Float64)
     X, random_bits, bits = initialize(N, d, S, R, T)
     return ScrambleDesignMat(X, random_bits, bits, R, num_mats)
 end
 
 function DesignMatrix(N,
-    d,
-    S::DeterministicSamplingAlgorithm,
-    R::Shift,
-    num_mats,
-    T::DataType = Float64)
+        d,
+        S::DeterministicSamplingAlgorithm,
+        R::Shift,
+        num_mats,
+        T::DataType = Float64)
     X = initialize(N, d, S, R, T)
     return ShiftDesignMat(X, R, num_mats)
 end
@@ -144,10 +152,10 @@
 end
 
 function scramble!(random_points::AbstractArray{T},
-    random_bits,
-    bits,
-    indices,
-    R::OwenScramble) where {T <: Real}
+        random_bits,
+        bits,
+        indices,
+        R::OwenScramble) where {T <: Real}
     randomize_bits!(random_bits, bits, indices, R)
     for i in CartesianIndices(random_points)
         random_points[i] = bits2unif(T, @view(random_bits[:, i]), R.base)
@@ -170,9 +178,9 @@
 end
 
 function scramble!(random_points::AbstractArray{T},
-    random_bits,
-    bits,
-    R::ScrambleMethod) where {T <: Real}
+        random_bits,
+        bits,
+        R::ScrambleMethod) where {T <: Real}
     randomize_bits!(random_bits, bits, R)
     for i in CartesianIndices(random_points)
         random_points[i] = bits2unif(T, @view(random_bits[:, i]), R.base)
@@ -202,31 +210,35 @@
 """
 ```julia
 generate_design_matrices(n, d, sample_method::DeterministicSamplingAlgorithm,
-num_mats, T = Float64)
+    num_mats, T = Float64)
 generate_design_matrices(n, d, sample_method::RandomSamplingAlgorithm,
-num_mats, T = Float64)
+    num_mats, T = Float64)
 generate_design_matrices(n, lb, ub, sample_method,
-num_mats = 2)
+    num_mats = 2)
 ```
+
 Create `num_mats` matrices each containing a QMC point set, where:
-- `n` is the number of points to sample.
-- `d` is the dimensionality of the point set in `[0, 1)ᵈ`,
-- `sample_method` is the quasi-Monte Carlo sampling strategy used to create a deterministic point set `out`.
-- `T` is the `eltype` of the point sets. For some QMC methods (Faure, Sobol) this can be `Rational`
-If the bound `lb` and `ub` are specified instead of `d`, the samples will be transformed into the box `[lb, ub]`.
+
+  - `n` is the number of points to sample.
+  - `d` is the dimensionality of the point set in `[0, 1)ᵈ`,
+  - `sample_method` is the quasi-Monte Carlo sampling strategy used to create a deterministic point set `out`.
+  - `T` is the `eltype` of the point sets. For some QMC methods (Faure, Sobol) this can be `Rational`
+    If the bound `lb` and `ub` are specified instead of `d`, the samples will be transformed into the box `[lb, ub]`.
 """
-function generate_design_matrices(n, d, sampler::DeterministicSamplingAlgorithm, num_mats::Integer,
-    T::DataType = Float64)
+function generate_design_matrices(
+        n, d, sampler::DeterministicSamplingAlgorithm, num_mats::Integer,
+        T::DataType = Float64)
     return generate_design_matrices(n, d, sampler, sampler.R, num_mats, T)
 end
 
-function generate_design_matrices(n, d, sampler::RandomSamplingAlgorithm, num_mats::Integer,
-    T::DataType = Float64)
+function generate_design_matrices(
+        n, d, sampler::RandomSamplingAlgorithm, num_mats::Integer,
+        T::DataType = Float64)
     return [sample(n, d, sampler, T) for j in 1:num_mats]
 end
 
 function generate_design_matrices(n, lb, ub, sampler,
-    num_mats = 2)
+        num_mats = 2)
     if n <= 0
         throw(ZeroSamplesError())
     end
@@ -246,22 +258,24 @@
 
 """
     generate_design_matrices(n, d, sampler, R::NoRand, num_mats, T = Float64)
+
 `R = NoRand()` produces `num_mats` matrices each containing a different deterministic point set in `[0, 1)ᵈ`.
 Note that this is an ad hoc way to produce i.i.d sequence as it creates a deterministic point in dimension `d × num_mats` and split it in `num_mats` point set of dimension `d`.
 This does not have any QMC garantuees.
 """
-function generate_design_matrices(n, d, sampler, R::NoRand, num_mats::Integer, T::DataType = Float64)
+function generate_design_matrices(
+        n, d, sampler, R::NoRand, num_mats::Integer, T::DataType = Float64)
     out = sample(n, num_mats * d, sampler, T)
     @warn "The `generate_design_matrices(n, d, sampler, R = NoRand(), num_mats)` method does not produces true and independent QMC matrices, see [this doc warning](https://docs.sciml.ai/QuasiMonteCarlo/stable/design_matrix/) for more context.
     Prefer using randomization methods such as `R = Shift()`, `R = MatousekScrambling()`, etc., see [documentation](https://docs.sciml.ai/QuasiMonteCarlo/stable/randomization/)"
     return [out[(j * d + 1):((j + 1) * d), :] for j in 0:(num_mats - 1)]
 end
 
 function generate_design_matrices(n,
-    d,
-    sampler,
-    R::RandomizationMethod,
-    num_mats::Integer,
-    T::DataType = Float64)
+        d,
+        sampler,
+        R::RandomizationMethod,
+        num_mats::Integer,
+        T::DataType = Float64)
     return collect(DesignMatrix(n, d, sampler, R, num_mats, T))
 end