Refactoring

Author: juliohm

src/PointPatterns.jl

@@ -23,11 +23,11 @@ export
   ishomogeneous,
 
   # algorithms
-  SamplingAlgorithm,
+  PointPatternAlgorithm,
   LewisShedler,
 
   # thinning methods
-  AbstractThinning,
+  ThinningMethod,
   RandomThinning,
   thin
 

src/processes.jl

@@ -50,24 +50,24 @@ on geometry or domain `g`.
 """
 function default_sampling_algorithm end
 
-# --------------------
-# SAMPLING ALGORITHMS
-# --------------------
+# -------------------------
+# POINT PATTERN ALGORITHMS
+# -------------------------
 
 """
-    SamplingAlgorithm
+    PointPatternAlgorithm
 
-A sampling algorithm for point processes.
+An algorithm for sampling point patterns.
 """
-abstract type SamplingAlgorithm end
+abstract type PointPatternAlgorithm end
 
 """
     LewisShedler(λmax)
 
 Generate sample using Lewis-Shedler algorithm (1979) with
 maximum real value `λmax` of the intensity function.
 """
-struct LewisShedler{T<:Real} <: SamplingAlgorithm
+struct LewisShedler{T<:Real} <: PointPatternAlgorithm
   λmax::T
 end
 
@@ -77,9 +77,9 @@ end
 Generate sample assuming the intensity is constant over a `Geometry`
 or piecewise constant over a `Domain`.
 """
-struct DiscretizedSampling <: SamplingAlgorithm end
+struct DiscretizedSampling <: PointPatternAlgorithm end
 
-struct UnionSampling <: SamplingAlgorithm end
+struct UnionSampling <: PointPatternAlgorithm end
 
 #-----------------
 # IMPLEMENTATIONS

src/thinning.jl

@@ -3,25 +3,25 @@
 # ------------------------------------------------------------------
 
 """
-    AbstractThinning
+    ThinningMethod
 
 A method for thinning spatial point processes and patterns.
 """
-abstract type AbstractThinning end
+abstract type ThinningMethod end
 
 """
-    thin(p, t)
+    thin(process, method)
 
-Thin spatial point process `p` with thinning method `t`.
+Thin spatial point `process` with thinning `method`.
 """
 function thin end
 
 """
-    thin(pp, t)
+    thin(pattern, method)
 
-Thin spatial point pattern `pp` with thinning method `t`.
+Thin spatial point `pattern` with thinning `method`.
 """
-thin(::PointSet, ::AbstractThinning)
+thin(::PointSet, ::ThinningMethod)
 
 #-----------------
 # IMPLEMENTATIONS

src/thinning/random.jl

@@ -7,7 +7,7 @@
 
 Random thining with retention probability `p`.
 """
-struct RandomThinning{P<:Union{Real,Function}} <: AbstractThinning
+struct RandomThinning{P<:Union{Real,Function}} <: ThinningMethod
   p::P
 end