Skip to content

Commit

Permalink
Rename fittable -> stationarymodels
Browse files Browse the repository at this point in the history
  • Loading branch information
juliohm committed Oct 24, 2024
1 parent fa9be00 commit 4792f49
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/fitting.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
# Licensed under the MIT License. See LICENSE in the project root.
# ------------------------------------------------------------------

# models that can be fitted currently
# stationary models with `range`, `sill` and `nugget`
# code to generate the model list:
# filter(isstationary, setdiff(subtypes(Variogram), (NuggetEffect, NestedVariogram))) |> Tuple
fittable() = (
stationarymodels() = (
CircularVariogram,
CubicVariogram,
ExponentialVariogram,
Expand Down Expand Up @@ -83,7 +83,7 @@ end
"""
fit(Variogram, g, algo=WeightedLeastSquares(); kwargs...)
Fit all "fittable" subtypes of `Variogram` to empirical variogram `g`
Fit all stationary `Variogram` models to empirical variogram `g`
using algorithm `algo` and return the one with minimum error.
## Examples
Expand All @@ -94,7 +94,7 @@ julia> fit(Variogram, g, WeightedLeastSquares())
```
"""
fit(::Type{Variogram}, g::EmpiricalVariogram, algo::FitAlgo=WeightedLeastSquares(); kwargs...) =
fit(fittable(), g, algo; kwargs...)
fit(stationarymodels(), g, algo; kwargs...)

"""
fit(V, g, weightfun; kwargs...)
Expand Down

0 comments on commit 4792f49

Please sign in to comment.