[api change] directional_weighted_semivariance is no longer public function

Author: SimonMolinsky

CHANGELOG.rst

@@ -24,6 +24,7 @@ Changes - from version >= 1.x
 * [enhancement] `build_experimental_variogram()` function has the new parameters `values` and `geometries`, that might be provided instead of `ds` parameter
 * [tests] Added basic tests for `build_experimental_variogram()` function
 * [enhancement] `VariogramCloud()` class has the new parameters `values` and `geometries`, that might be provided instead of `ds` parameter
+* [api change] `directional_weighted_semivariance()` function is now private: `_directional_weighted_semivariance()`
 
 
 2025-10-11

dev/profile/semivariogram/experimental/profile_from_ellipse_weighted.py

@@ -1,6 +1,6 @@
 import numpy as np
 from pyinterpolate.semivariogram.experimental.functions.directional import \
-    directional_weighted_semivariance
+    _directional_weighted_semivariance
 
 
 def profile_select_in_ellipse():
@@ -9,7 +9,7 @@ def profile_select_in_ellipse():
     step_size = 0.05
     max_range = 0.6
 
-    _ = directional_weighted_semivariance(
+    _ = _directional_weighted_semivariance(
         points=points,
         lags=np.linspace(step_size, max_range, 10),
         custom_weights=weights,

src/pyinterpolate/semivariogram/experimental/experimental_semivariogram.py

@@ -9,7 +9,7 @@
     validate_semivariance_weights, validate_direction_and_tolerance, \
     validate_bins
 from pyinterpolate.semivariogram.experimental.functions.directional import \
-    directional_weighted_semivariance, from_ellipse, from_ellipse_cloud
+    _directional_weighted_semivariance, from_ellipse, from_ellipse_cloud
 from pyinterpolate.semivariogram.experimental.functions.general import \
     omnidirectional_variogram, omnidirectional_semivariogram_cloud
 from pyinterpolate.semivariogram.experimental.functions.semivariance import \
@@ -335,7 +335,7 @@ def directional_semivariance(points: np.ndarray,
             direction,
             tolerance)
     else:
-        output_semivariances = directional_weighted_semivariance(
+        output_semivariances = _directional_weighted_semivariance(
             points,
             lags,
             custom_weights,

src/pyinterpolate/semivariogram/experimental/functions/directional.py

@@ -133,7 +133,7 @@ def from_ellipse_cloud(
     return point_cloud
 
 
-def directional_weighted_semivariance(
+def _directional_weighted_semivariance(
         points: np.array,
         lags: np.array,
         custom_weights: np.array,