Rename variotype to constructor (#16)

* Rename 'variotype' to 'constructor' * Update src/variogram.jl --------- Co-authored-by: Júlio Hoffimann <[email protected]>
JuliaEarth · Jun 26, 2024 · c029148 · c029148
1 parent e071cf4
commit c029148
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 16 deletions.
diff --git a/src/GeoStatsFunctions.jl b/src/GeoStatsFunctions.jl
@@ -63,7 +63,6 @@ export
   sill,
   nugget,
   metricball,
-  variotype,
   isstationary,
   isisotropic,
   structures,

diff --git a/src/variogram.jl b/src/variogram.jl
@@ -10,11 +10,11 @@ A theoretical variogram model (e.g. Gaussian variogram).
 abstract type Variogram end
 
 """
-    variotype(γ)
+    constructor(γ)
 
 Return the type constructor of the variogram `γ`.
 """
-function variotype end
+function constructor end
 
 """
     isstationary(γ)
@@ -65,7 +65,7 @@ Scale metric ball of variogram `γ` with strictly
 positive scaling factor `s`.
 """
 function scale(γ::Variogram, s::Real)
-  V = variotype(γ)
+  V = constructor(γ)
   V(s * metricball(γ); sill=sill(γ), nugget=nugget(γ))
 end
 

diff --git a/src/variogram/circular.jl b/src/variogram/circular.jl
@@ -15,7 +15,7 @@ CircularVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = CircularVariogram
 
 CircularVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) = CircularVariogram(sill, nugget, MetricBall(range))
 
-variotype(::CircularVariogram) = CircularVariogram
+constructor(::CircularVariogram) = CircularVariogram
 
 isstationary(::Type{<:CircularVariogram}) = true
 

diff --git a/src/variogram/cubic.jl b/src/variogram/cubic.jl
@@ -19,7 +19,7 @@ CubicVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = CubicVariogram(sill,
 
 CubicVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) = CubicVariogram(sill, nugget, MetricBall(range))
 
-variotype(::CubicVariogram) = CubicVariogram
+constructor(::CubicVariogram) = CubicVariogram
 
 isstationary(::Type{<:CubicVariogram}) = true
 

diff --git a/src/variogram/exponential.jl b/src/variogram/exponential.jl
@@ -20,7 +20,7 @@ ExponentialVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = ExponentialVar
 ExponentialVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) =
   ExponentialVariogram(sill, nugget, MetricBall(range))
 
-variotype(::ExponentialVariogram) = ExponentialVariogram
+constructor(::ExponentialVariogram) = ExponentialVariogram
 
 isstationary(::Type{<:ExponentialVariogram}) = true
 

diff --git a/src/variogram/gaussian.jl b/src/variogram/gaussian.jl
@@ -19,7 +19,7 @@ GaussianVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = GaussianVariogram
 
 GaussianVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) = GaussianVariogram(sill, nugget, MetricBall(range))
 
-variotype(::GaussianVariogram) = GaussianVariogram
+constructor(::GaussianVariogram) = GaussianVariogram
 
 isstationary(::Type{<:GaussianVariogram}) = true
 

diff --git a/src/variogram/matern.jl b/src/variogram/matern.jl
@@ -22,7 +22,7 @@ MaternVariogram(ball; sill=1.0, nugget=zero(typeof(sill)), order=1.0) = MaternVa
 MaternVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill)), order=1.0) =
   MaternVariogram(sill, nugget, order, MetricBall(range))
 
-variotype(::MaternVariogram) = MaternVariogram
+constructor(::MaternVariogram) = MaternVariogram
 
 isstationary(::Type{<:MaternVariogram}) = true
 

diff --git a/src/variogram/nugget.jl b/src/variogram/nugget.jl
@@ -13,7 +13,7 @@ end
 
 NuggetEffect(; nugget=1.0) = NuggetEffect(nugget)
 
-variotype(::NuggetEffect) = NuggetEffect
+constructor(::NuggetEffect) = NuggetEffect
 
 isstationary(::Type{<:NuggetEffect}) = true
 

diff --git a/src/variogram/pentaspherical.jl b/src/variogram/pentaspherical.jl
@@ -20,7 +20,7 @@ PentasphericalVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = Pentaspheri
 PentasphericalVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) =
   PentasphericalVariogram(sill, nugget, MetricBall(range))
 
-variotype(::PentasphericalVariogram) = PentasphericalVariogram
+constructor(::PentasphericalVariogram) = PentasphericalVariogram
 
 isstationary(::Type{<:PentasphericalVariogram}) = true
 

diff --git a/src/variogram/power.jl b/src/variogram/power.jl
@@ -15,7 +15,7 @@ end
 
 PowerVariogram(; scaling=1.0, nugget=zero(typeof(scaling)), exponent=1.0) = PowerVariogram(scaling, nugget, exponent)
 
-variotype(::PowerVariogram) = PowerVariogram
+constructor(::PowerVariogram) = PowerVariogram
 
 isstationary(::Type{<:PowerVariogram}) = false
 

diff --git a/src/variogram/sinehole.jl b/src/variogram/sinehole.jl
@@ -19,7 +19,7 @@ SineHoleVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = SineHoleVariogram
 
 SineHoleVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) = SineHoleVariogram(sill, nugget, MetricBall(range))
 
-variotype(::SineHoleVariogram) = SineHoleVariogram
+constructor(::SineHoleVariogram) = SineHoleVariogram
 
 isstationary(::Type{<:SineHoleVariogram}) = true
 

diff --git a/src/variogram/spherical.jl b/src/variogram/spherical.jl
@@ -20,7 +20,7 @@ SphericalVariogram(ball; sill=1.0, nugget=zero(typeof(sill))) = SphericalVariogr
 SphericalVariogram(; range=1.0, sill=1.0, nugget=zero(typeof(sill))) =
   SphericalVariogram(sill, nugget, MetricBall(range))
 
-variotype(::SphericalVariogram) = SphericalVariogram
+constructor(::SphericalVariogram) = SphericalVariogram
 
 isstationary(::Type{<:SphericalVariogram}) = true
 

diff --git a/test/variogram.jl b/test/variogram.jl
@@ -156,7 +156,7 @@
   @test size(Γ) == (3, 4)
   @test all(Γ .> 0)
 
-  # variotype
+  # constructor
   for γ in [
     CircularVariogram(),
     CubicVariogram(),
@@ -169,7 +169,7 @@
     SineHoleVariogram(),
     SphericalVariogram()
   ]
-    @test variotype(γ)() == γ
+    @test GeoStatsFunctions.constructor(γ)() == γ
   end
 
   # scale