loop-interpolation 0.1.0__tar.gz → 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/PKG-INFO +3 -1
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/pyproject.toml +2 -1
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_discrete_interpolator.py +111 -15
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_finite_difference_interpolator.py +24 -7
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_interpolator_builder.py +12 -0
- loop_interpolation-0.2.0/src/loop_interpolation/_native.py +562 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_solver_pipeline.py +70 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_solver_strategy.py +14 -7
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation.egg-info/PKG-INFO +3 -1
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation.egg-info/SOURCES.txt +6 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation.egg-info/requires.txt +3 -0
- loop_interpolation-0.2.0/tests/test_native_errors.py +254 -0
- loop_interpolation-0.2.0/tests/test_native_inequality.py +347 -0
- loop_interpolation-0.2.0/tests/test_native_no_rows.py +263 -0
- loop_interpolation-0.2.0/tests/test_native_parity.py +342 -0
- loop_interpolation-0.2.0/tests/test_native_warm_start_ridge.py +116 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_solver_pipeline.py +39 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_solver_strategy.py +68 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/LICENSE +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/README.md +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/setup.cfg +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/__init__.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_builders.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_constant_norm.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_diagnostics.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_discrete_fold_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_fd_fold_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_fold_event.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_fold_norm_alignment.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_fold_setup.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_geological_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_interpolator_factory.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_interpolatortype.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_operator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_p1interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_p2_fold_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_p2interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_quadrature.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_regularisation.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_surfe_wrapper.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_svariogram.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/_validation.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/constraints.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/fold_function/__init__.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/fold_function/_base_fold_rotation_angle.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/fold_function/_fourier_series_fold_rotation_angle.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/fold_function/_lambda_fold_rotation_angle.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/loopsolver/__init__.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/loopsolver/admm_constant_norm.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/loopsolver/admm_method.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation/loopsolver/admm_solver.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation.egg-info/dependency_links.txt +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/src/loop_interpolation.egg-info/top_level.txt +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_admm_matrix_free.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_constraint_diagnostics_report.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_constraints.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_discrete_fold_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_discrete_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_fd_fold_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_fdi_matrix_free_regularisation.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_geological_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_import.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_input_validation.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_interpolator_builder.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_normal_magnitude_interpolators.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_p0_nan_constraints_skipped.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_p0_surfe_nans.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_p2_fold_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_p2_fold_registration.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_p2_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_quadrature.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_rectilinear_interpolator.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_regularisation_api.py +0 -0
- {loop_interpolation-0.1.0 → loop_interpolation-0.2.0}/tests/test_surfe_rbf_interpolator.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: loop-interpolation
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.2.0
|
|
4
4
|
Summary: Interpolation utilities for LoopStructural
|
|
5
5
|
Author-email: Lachlan Grose <lachlan.grose@monash.edu>
|
|
6
6
|
License: MIT
|
|
@@ -24,6 +24,8 @@ Requires-Dist: scipy
|
|
|
24
24
|
Requires-Dist: pydantic
|
|
25
25
|
Provides-Extra: tests
|
|
26
26
|
Requires-Dist: pytest; extra == "tests"
|
|
27
|
+
Provides-Extra: native
|
|
28
|
+
Requires-Dist: loop-interpolation-core; extra == "native"
|
|
27
29
|
Dynamic: license-file
|
|
28
30
|
|
|
29
31
|
# loop-interpolation
|
|
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "loop-interpolation"
|
|
7
7
|
description = "Interpolation utilities for LoopStructural"
|
|
8
|
-
version = "0.
|
|
8
|
+
version = "0.2.0"
|
|
9
9
|
requires-python = ">=3.9"
|
|
10
10
|
authors = [{ name = "Lachlan Grose", email = "lachlan.grose@monash.edu" }]
|
|
11
11
|
readme = "README.md"
|
|
@@ -27,6 +27,7 @@ dependencies = ["loop-common", "numpy", "scipy", "pydantic"]
|
|
|
27
27
|
|
|
28
28
|
[project.optional-dependencies]
|
|
29
29
|
tests = ["pytest"]
|
|
30
|
+
native = ["loop-interpolation-core"]
|
|
30
31
|
|
|
31
32
|
[tool.setuptools.packages.find]
|
|
32
33
|
where = ["src"]
|
|
@@ -327,6 +327,9 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
327
327
|
|
|
328
328
|
"""
|
|
329
329
|
self.constraints = {}
|
|
330
|
+
# setup_interpolator sets these two values again when it ends.
|
|
331
|
+
self._native_setup = False
|
|
332
|
+
self._setup_constraint_names = None
|
|
330
333
|
self.c_ = 0
|
|
331
334
|
self.regularisation_scale = np.ones(self.dof)
|
|
332
335
|
logger.info("Resetting interpolation constraints")
|
|
@@ -1037,12 +1040,18 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1037
1040
|
A: sparse.spmatrix,
|
|
1038
1041
|
b: np.ndarray,
|
|
1039
1042
|
timing: dict,
|
|
1043
|
+
add_ridge_regularisation: bool | None = None,
|
|
1044
|
+
ridge_factor: float | None = None,
|
|
1040
1045
|
) -> tuple[sparse.spmatrix, np.ndarray, sparse.spmatrix | None]:
|
|
1046
|
+
if add_ridge_regularisation is None:
|
|
1047
|
+
add_ridge_regularisation = self.add_ridge_regulatisation
|
|
1048
|
+
if ridge_factor is None:
|
|
1049
|
+
ridge_factor = self.ridge_factor
|
|
1041
1050
|
return _solver_pipeline.preprocess_main_system(
|
|
1042
1051
|
A=A,
|
|
1043
1052
|
b=b,
|
|
1044
|
-
add_ridge_regularisation=
|
|
1045
|
-
ridge_factor=
|
|
1053
|
+
add_ridge_regularisation=add_ridge_regularisation,
|
|
1054
|
+
ridge_factor=ridge_factor,
|
|
1046
1055
|
apply_scaling_matrix=self.apply_scaling_matrix,
|
|
1047
1056
|
compute_column_scaling_matrix_fn=self.compute_column_scaling_matrix,
|
|
1048
1057
|
logger=logger,
|
|
@@ -1069,8 +1078,11 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1069
1078
|
tol: float | None,
|
|
1070
1079
|
solver_kwargs: dict,
|
|
1071
1080
|
timing: dict,
|
|
1081
|
+
x0: np.ndarray | None = None,
|
|
1072
1082
|
) -> bool:
|
|
1073
|
-
self.c, ok = _solver_strategy.solve_with_cg(
|
|
1083
|
+
self.c, ok = _solver_strategy.solve_with_cg(
|
|
1084
|
+
A, b, tol, solver_kwargs, timing, logger, x0=x0
|
|
1085
|
+
)
|
|
1074
1086
|
return ok
|
|
1075
1087
|
|
|
1076
1088
|
def _use_fused_cg_regularisation(self, solver_choice) -> bool:
|
|
@@ -1101,6 +1113,9 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1101
1113
|
tol: float | None,
|
|
1102
1114
|
solver_kwargs: dict,
|
|
1103
1115
|
timing: dict,
|
|
1116
|
+
add_ridge_regularisation: bool | None = None,
|
|
1117
|
+
ridge_factor: float | None = None,
|
|
1118
|
+
x0: np.ndarray | None = None,
|
|
1104
1119
|
) -> bool:
|
|
1105
1120
|
"""CG fast path for ``regularisation_matrix_free=True``: assemble the
|
|
1106
1121
|
normal-equations system ``(A_data^T A_data + R_reg^T R_reg) x =
|
|
@@ -1139,6 +1154,10 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1139
1154
|
separate sparse matvecs (``A_data @ x`` then ``A_data.T @ (...)``)
|
|
1140
1155
|
every iteration.
|
|
1141
1156
|
"""
|
|
1157
|
+
if add_ridge_regularisation is None:
|
|
1158
|
+
add_ridge_regularisation = self.add_ridge_regulatisation
|
|
1159
|
+
if ridge_factor is None:
|
|
1160
|
+
ridge_factor = self.ridge_factor
|
|
1142
1161
|
assembly_started = perf_counter()
|
|
1143
1162
|
A_data, b_data = self._assemble_explicit_constraint_matrix()
|
|
1144
1163
|
A_data = A_data.tocsr()
|
|
@@ -1146,8 +1165,8 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1146
1165
|
|
|
1147
1166
|
AtA_data = (A_data.T @ A_data).tocsr()
|
|
1148
1167
|
rhs = np.asarray(A_data.T @ b_data).reshape(-1)
|
|
1149
|
-
if
|
|
1150
|
-
AtA_data = AtA_data + sparse.eye(dof, format="csr") * (
|
|
1168
|
+
if add_ridge_regularisation:
|
|
1169
|
+
AtA_data = AtA_data + sparse.eye(dof, format="csr") * (ridge_factor**2)
|
|
1151
1170
|
|
|
1152
1171
|
reg_operator = self._build_fused_cg_regularisation_operator()
|
|
1153
1172
|
timing["assembly_seconds"] = perf_counter() - assembly_started
|
|
@@ -1170,7 +1189,7 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1170
1189
|
timing["preprocess_seconds"] = perf_counter() - preprocess_started
|
|
1171
1190
|
|
|
1172
1191
|
self.c, ok = _solver_strategy.solve_with_cg_normal_equations(
|
|
1173
|
-
normal_operator, rhs, tol, solver_kwargs, timing, logger
|
|
1192
|
+
normal_operator, rhs, tol, solver_kwargs, timing, logger, x0=x0
|
|
1174
1193
|
)
|
|
1175
1194
|
return ok
|
|
1176
1195
|
|
|
@@ -1181,8 +1200,11 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1181
1200
|
tol: float | None,
|
|
1182
1201
|
solver_kwargs: dict,
|
|
1183
1202
|
timing: dict,
|
|
1203
|
+
x0: np.ndarray | None = None,
|
|
1184
1204
|
) -> bool:
|
|
1185
|
-
self.c, ok = _solver_strategy.solve_with_lsmr(
|
|
1205
|
+
self.c, ok = _solver_strategy.solve_with_lsmr(
|
|
1206
|
+
A, b, tol, solver_kwargs, timing, logger, x0=x0
|
|
1207
|
+
)
|
|
1186
1208
|
return ok
|
|
1187
1209
|
|
|
1188
1210
|
def _extract_admm_kwargs(self, solver_kwargs: dict, admm_solve) -> tuple[str, dict]:
|
|
@@ -1199,10 +1221,13 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1199
1221
|
constant_norm_iterations: int,
|
|
1200
1222
|
constant_norm_weight: float,
|
|
1201
1223
|
constant_norm_target: float | None,
|
|
1224
|
+
x0: np.ndarray | None = None,
|
|
1225
|
+
ridge_kwargs: dict | None = None,
|
|
1202
1226
|
) -> bool:
|
|
1203
1227
|
logger.info("Solving using admm")
|
|
1204
1228
|
|
|
1205
|
-
|
|
1229
|
+
# the polish re-solves must use the same ridge options as this solve
|
|
1230
|
+
constant_norm_solver_kwargs = {**solver_kwargs, **(ridge_kwargs or {})}
|
|
1206
1231
|
if Q is None:
|
|
1207
1232
|
logger.warning("No inequality constraints, using lsmr")
|
|
1208
1233
|
return self.solve_system("lsmr", solver_kwargs=solver_kwargs)
|
|
@@ -1217,6 +1242,7 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1217
1242
|
timing,
|
|
1218
1243
|
self.support,
|
|
1219
1244
|
logger,
|
|
1245
|
+
x0=x0,
|
|
1220
1246
|
)
|
|
1221
1247
|
if not ok:
|
|
1222
1248
|
return False
|
|
@@ -1254,7 +1280,19 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1254
1280
|
solver : string/callable
|
|
1255
1281
|
solver 'cg' conjugate gradient, 'lsmr' or callable function
|
|
1256
1282
|
solver_kwargs
|
|
1257
|
-
kwargs for solver check scipy documentation for more information
|
|
1283
|
+
kwargs for solver check scipy documentation for more information.
|
|
1284
|
+
These keys are used by the interpolator and not sent to the solver:
|
|
1285
|
+
|
|
1286
|
+
- ``ridge_factor`` (float): ridge factor for this solve. 0
|
|
1287
|
+
disables the ridge term. Default ``self.ridge_factor``.
|
|
1288
|
+
- ``add_ridge_regularisation`` (bool): enable or disable the
|
|
1289
|
+
ridge term for this solve. Default
|
|
1290
|
+
``self.add_ridge_regulatisation``.
|
|
1291
|
+
- ``warm_start`` (bool): start the solver from the previous
|
|
1292
|
+
solution. Default False.
|
|
1293
|
+
- ``x0`` (array or callable): initial guess, or a callable that
|
|
1294
|
+
takes the support and returns one. Has priority over
|
|
1295
|
+
``warm_start``. A custom callable solver ignores it.
|
|
1258
1296
|
|
|
1259
1297
|
Returns
|
|
1260
1298
|
-------
|
|
@@ -1262,12 +1300,63 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1262
1300
|
True if the interpolation is run
|
|
1263
1301
|
|
|
1264
1302
|
"""
|
|
1303
|
+
solver_choice = self._normalise_solver_choice(solver)
|
|
1304
|
+
# A native setup builds no sparse rows. A matrix solver needs them.
|
|
1305
|
+
# Check this before _pre_solve, so that the old field stays.
|
|
1306
|
+
if getattr(self, "_native_setup", False) and solver_choice != "native":
|
|
1307
|
+
raise ValueError(
|
|
1308
|
+
"The interpolator was set up with solver='native', so it has no "
|
|
1309
|
+
"sparse rows. Run setup again with the new solver, or use "
|
|
1310
|
+
"solver='native'."
|
|
1311
|
+
)
|
|
1312
|
+
# _pre_solve makes a new c array filled with NaN. A native solve that
|
|
1313
|
+
# does not converge must keep the old field, so keep the old array.
|
|
1314
|
+
# This is safe only because _pre_solve does not fill c in place.
|
|
1315
|
+
previous_c = self.c if solver_choice == "native" else None
|
|
1316
|
+
solver_kwargs = dict(solver_kwargs or {})
|
|
1317
|
+
# read the initial guess before _pre_solve clears the previous solution
|
|
1318
|
+
x0 = _solver_pipeline.extract_initial_guess(
|
|
1319
|
+
solver_kwargs, self.c, self.support, self.dof, logger
|
|
1320
|
+
)
|
|
1321
|
+
add_ridge, ridge_factor = _solver_pipeline.extract_ridge_options(
|
|
1322
|
+
solver_kwargs, self.add_ridge_regulatisation, self.ridge_factor, logger
|
|
1323
|
+
)
|
|
1324
|
+
ridge_kwargs = {"add_ridge_regularisation": add_ridge, "ridge_factor": ridge_factor}
|
|
1265
1325
|
if not self._pre_solve():
|
|
1266
1326
|
raise ValueError("Pre solve failed")
|
|
1267
1327
|
|
|
1268
1328
|
solve_started = perf_counter()
|
|
1269
|
-
solver_choice
|
|
1270
|
-
|
|
1329
|
+
if solver_choice == "native":
|
|
1330
|
+
self.c = previous_c
|
|
1331
|
+
# Clear the history and the timing keys of an earlier matrix solve.
|
|
1332
|
+
self.solver_history = None
|
|
1333
|
+
self.latest_solve_timing = _solver_pipeline.init_timing("native")
|
|
1334
|
+
# Import here. The core is not loaded when the package is imported.
|
|
1335
|
+
from . import _native
|
|
1336
|
+
|
|
1337
|
+
# The ridge and start value keys are already taken out of
|
|
1338
|
+
# solver_kwargs. The core gets them as arguments.
|
|
1339
|
+
_native.check_supported(self, getattr(self, "_setup_kwargs", {}), solver_kwargs)
|
|
1340
|
+
if len(self.constraints) > 0:
|
|
1341
|
+
# The rows come from a matrix setup. The core ignores them.
|
|
1342
|
+
logger.warning(
|
|
1343
|
+
'solver="native" saves memory only when it is set before setup'
|
|
1344
|
+
)
|
|
1345
|
+
converged = _native.solve(
|
|
1346
|
+
self,
|
|
1347
|
+
tol,
|
|
1348
|
+
solver_kwargs,
|
|
1349
|
+
x0=x0,
|
|
1350
|
+
ridge_factor=ridge_factor if add_ridge else 0.0,
|
|
1351
|
+
)
|
|
1352
|
+
self.up_to_date = bool(converged)
|
|
1353
|
+
# _native.solve sets the timing with a "total" key. Keep it.
|
|
1354
|
+
timing_native = dict(getattr(self, "latest_solve_timing", None) or {})
|
|
1355
|
+
timing_native.setdefault("solver", "native")
|
|
1356
|
+
timing_native.setdefault("total", perf_counter() - solve_started)
|
|
1357
|
+
timing_native["up_to_date"] = self.up_to_date
|
|
1358
|
+
self.latest_solve_timing = timing_native
|
|
1359
|
+
return self.up_to_date
|
|
1271
1360
|
constant_norm_iterations, constant_norm_weight, constant_norm_target = (
|
|
1272
1361
|
_solver_pipeline.extract_constant_norm_options(solver_kwargs, logger)
|
|
1273
1362
|
)
|
|
@@ -1299,18 +1388,23 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1299
1388
|
# `_solve_with_cg_fused_regularisation` / `FiniteDifferenceInterpolator.
|
|
1300
1389
|
# _build_fused_cg_regularisation_operator`.
|
|
1301
1390
|
self.up_to_date = self._solve_with_cg_fused_regularisation(
|
|
1302
|
-
tol, solver_kwargs, timing
|
|
1391
|
+
tol, solver_kwargs, timing, x0=x0, **ridge_kwargs
|
|
1303
1392
|
)
|
|
1304
1393
|
else:
|
|
1305
1394
|
A, b = self._assemble_main_system(timing)
|
|
1306
|
-
A, b, scaling_matrix = self._preprocess_main_system(A, b, timing)
|
|
1395
|
+
A, b, scaling_matrix = self._preprocess_main_system(A, b, timing, **ridge_kwargs)
|
|
1396
|
+
if x0 is not None and scaling_matrix is not None:
|
|
1397
|
+
# the solver works on y where c = S @ y
|
|
1398
|
+
x0 = x0 / scaling_matrix.diagonal()
|
|
1307
1399
|
|
|
1308
1400
|
if callable(solver_choice):
|
|
1309
1401
|
self.up_to_date = self._solve_with_callable(solver_choice, A, b, timing)
|
|
1310
1402
|
elif solver_choice == "cg":
|
|
1311
|
-
self.up_to_date = self._solve_with_cg(A, b, tol, solver_kwargs, timing)
|
|
1403
|
+
self.up_to_date = self._solve_with_cg(A, b, tol, solver_kwargs, timing, x0=x0)
|
|
1312
1404
|
elif solver_choice == "lsmr":
|
|
1313
|
-
self.up_to_date = self._solve_with_lsmr(
|
|
1405
|
+
self.up_to_date = self._solve_with_lsmr(
|
|
1406
|
+
A, b, tol, solver_kwargs, timing, x0=x0
|
|
1407
|
+
)
|
|
1314
1408
|
elif solver_choice == "admm":
|
|
1315
1409
|
self.up_to_date = self._solve_with_admm(
|
|
1316
1410
|
A,
|
|
@@ -1322,6 +1416,8 @@ class DiscreteInterpolator(GeologicalInterpolator):
|
|
|
1322
1416
|
constant_norm_iterations,
|
|
1323
1417
|
constant_norm_weight,
|
|
1324
1418
|
constant_norm_target,
|
|
1419
|
+
x0=x0,
|
|
1420
|
+
ridge_kwargs=ridge_kwargs,
|
|
1325
1421
|
)
|
|
1326
1422
|
else:
|
|
1327
1423
|
logger.error(f"Unknown solver {solver_choice}")
|
|
@@ -179,6 +179,28 @@ class FiniteDifferenceInterpolator(DiscreteInterpolator):
|
|
|
179
179
|
self.use_regularisation_weight_scale = kwargs.get("use_regularisation_weight_scale", False)
|
|
180
180
|
self.regularisation_weight_sigma = kwargs.get("regularisation_weight_sigma", None)
|
|
181
181
|
self.matrix_free_regularisation_blocks = {}
|
|
182
|
+
self.interface_pair_mode = kwargs.get("interface_pair_mode", self.interface_pair_mode)
|
|
183
|
+
self.interface_pair_threshold = int(
|
|
184
|
+
kwargs.get("interface_pair_threshold", self.interface_pair_threshold)
|
|
185
|
+
)
|
|
186
|
+
self.interface_pair_fallback = kwargs.get(
|
|
187
|
+
"interface_pair_fallback", self.interface_pair_fallback
|
|
188
|
+
)
|
|
189
|
+
if self.solver == "native":
|
|
190
|
+
# The native solver reads the raw data (get_*_constraints) and the
|
|
191
|
+
# stored weights. It does not use sparse rows, so we do not build
|
|
192
|
+
# them. This saves Python memory (plan D7.2).
|
|
193
|
+
# The weights and kwargs are stored above. This branch is safe to
|
|
194
|
+
# run again from update(): reset() already cleared the rows.
|
|
195
|
+
self.matrix_free_regularisation_blocks = {}
|
|
196
|
+
self.regularisation_matrix_free = False
|
|
197
|
+
# add_inequality_pairs_constraints and add_value_inequality_constraints
|
|
198
|
+
# only build sparse inequality rows. They store no raw data. The
|
|
199
|
+
# core reads the raw inequality data itself, so we skip them here.
|
|
200
|
+
self._native_setup = True
|
|
201
|
+
self._setup_constraint_names = frozenset(self.constraints)
|
|
202
|
+
# The report uses the raw data, not the rows, so it is still valid.
|
|
203
|
+
return self.finalize_setup_diagnostics_report()
|
|
182
204
|
self.regularisation_matrix_free = bool(kwargs.get("regularisation_matrix_free", False))
|
|
183
205
|
if self.regularisation_matrix_free and self.apply_scaling_matrix:
|
|
184
206
|
logger.warning(
|
|
@@ -201,13 +223,6 @@ class FiniteDifferenceInterpolator(DiscreteInterpolator):
|
|
|
201
223
|
"consume a LinearOperator and will fall back to explicit regularisation assembly "
|
|
202
224
|
"(with a warning) for that solve."
|
|
203
225
|
)
|
|
204
|
-
self.interface_pair_mode = kwargs.get("interface_pair_mode", self.interface_pair_mode)
|
|
205
|
-
self.interface_pair_threshold = int(
|
|
206
|
-
kwargs.get("interface_pair_threshold", self.interface_pair_threshold)
|
|
207
|
-
)
|
|
208
|
-
self.interface_pair_fallback = kwargs.get(
|
|
209
|
-
"interface_pair_fallback", self.interface_pair_fallback
|
|
210
|
-
)
|
|
211
226
|
self.add_norm_constraints(self.interpolation_weights["npw"])
|
|
212
227
|
self.add_gradient_constraints(self.interpolation_weights["gpw"])
|
|
213
228
|
self.add_value_constraints(self.interpolation_weights["cpw"])
|
|
@@ -223,6 +238,8 @@ class FiniteDifferenceInterpolator(DiscreteInterpolator):
|
|
|
223
238
|
self.assemble_inner(o[0], o[1], name=k)
|
|
224
239
|
self.add_directional_regularisation(regularisation_config.directional)
|
|
225
240
|
self.assemble_borders()
|
|
241
|
+
# The rows up to here come from setup. Any other row is an extra row.
|
|
242
|
+
self._setup_constraint_names = frozenset(self.constraints)
|
|
226
243
|
return self.finalize_setup_diagnostics_report()
|
|
227
244
|
|
|
228
245
|
def copy(self):
|
|
@@ -79,6 +79,8 @@ class InterpolatorBuilder:
|
|
|
79
79
|
self,
|
|
80
80
|
solver: str | None = None,
|
|
81
81
|
tol: float | None = None,
|
|
82
|
+
ridge_factor: float | None = None,
|
|
83
|
+
warm_start: bool | None = None,
|
|
82
84
|
**solver_kwargs,
|
|
83
85
|
) -> InterpolatorBuilder:
|
|
84
86
|
"""Solve the configured interpolator system.
|
|
@@ -89,6 +91,12 @@ class InterpolatorBuilder:
|
|
|
89
91
|
Override solver name for this call.
|
|
90
92
|
tol : Optional[float], optional
|
|
91
93
|
Optional solver tolerance.
|
|
94
|
+
ridge_factor : Optional[float], optional
|
|
95
|
+
Ridge regularisation factor for this call. 0 disables the ridge
|
|
96
|
+
term. If None, the interpolator default is used.
|
|
97
|
+
warm_start : Optional[bool], optional
|
|
98
|
+
If True, start the solver from the previous solution. Use
|
|
99
|
+
``x0`` in ``solver_kwargs`` to give an initial guess directly.
|
|
92
100
|
**solver_kwargs
|
|
93
101
|
Additional arguments passed to ``solve_system``.
|
|
94
102
|
|
|
@@ -101,6 +109,10 @@ class InterpolatorBuilder:
|
|
|
101
109
|
selected_solver = solver if solver is not None else self.solver
|
|
102
110
|
merged_solver_kwargs = dict(self.solver_kwargs)
|
|
103
111
|
merged_solver_kwargs.update(solver_kwargs)
|
|
112
|
+
if ridge_factor is not None:
|
|
113
|
+
merged_solver_kwargs["ridge_factor"] = ridge_factor
|
|
114
|
+
if warm_start is not None:
|
|
115
|
+
merged_solver_kwargs["warm_start"] = warm_start
|
|
104
116
|
self.interpolator.solve_system(
|
|
105
117
|
solver=selected_solver,
|
|
106
118
|
tol=tol,
|