pls_diagnostic_dmodx — DModX (distance to the model in X)

Group: Diagnostic · Registry tolerance: 5.0

Description

PLS Distance-to-Model X (§9)

Registry note — mdatools has no native DModX; the R script computes it from $xdecomp$Q and the same dof formula pls4all uses.

Parameters

Name

Type

Default

Notes

n_components

int

4

registry benchmark cell value

Explanations

Bibliographic source

Eriksson, L., Byrne, T., Johansson, E., Trygg, J. & Vikström, C. (2013). Multi- and Megavariate Data Analysis. Basic Principles and Applications, 3rd ed., Umetrics Academy, §4.7.

Mathematical principle

DModX is a normalised version of Q that accounts for the model’s residual degrees of freedom: \(\mathrm{DModX}_i = \sqrt{Q_i \,/\, (p - k - 1) \,\cdot\, (n - k - 1) / \bar{Q}_{\mathrm{cal}}}\) where \(\bar{Q}_{\mathrm{cal}}\) is the average Q on the calibration set.

DModX is the diagnostic of choice in the SIMCA software (Umetrics) and is commonly used because the normalisation produces a unit-less quantity directly comparable across models with different \(p\), \(n\), \(k\). Critical thresholds follow the F-distribution: DModX > 2 is the heuristic outlier cutoff in practice.

Conceptually equivalent to Q for monitoring purposes, but the normalisation is what makes it portable.

Implementation

n4m_pls_diagnostics_compute with stat=’dmodx’.

MATLAB header (bindings/matlab/+pls4all/pls_diagnostics.m):

pls4all.pls_diagnostics  Hotelling T2, Q residuals, DModX from a SIMPLS fit.

   res = pls4all.pls_diagnostics(X, Y, n_components)
   res = pls4all.pls_diagnostics(X, Y, n_components, X_reference)

 Fits an internal SIMPLS model (store_scores=1) and evaluates row-wise

Usage

Every pls4all binding tab dispatches into the same C kernel; the external libraries listed at the bottom of the page are the parity references registered in benchmarks.parity_timing.registry. Switch tabs to read the same fit in your language. The R package now ships drop-in-compatible facades for the CRAN pls package (plsr, pcr, mvr) and for the mdatools::pls(x, y, ...) matrix idiom — those tabs appear only on the methods that have a meaningful equivalence.

pls4all bindings

/* C ABI — libn4m */
n4m_context_t* ctx = n4m_context_create();
n4m_config_t*  cfg = n4m_config_create();
n4m_method_result_t* res = NULL;
n4m_pls_diagnostics_compute(ctx, cfg, &x_view, &y_view, /* hyperparams */, &res);
/* … read coefficients / mask / scores via */
/* n4m_method_result_get_double_matrix / vector / scalar … */
n4m_method_result_destroy(res);
n4m_config_destroy(cfg);
n4m_context_destroy(ctx);

import pls4all
from pls4all._methods import pls_diagnostics_compute
with pls4all.Context() as ctx, pls4all.Config() as cfg:
    res = pls_diagnostics_compute(ctx, cfg, X, y, n_components=4)
# then: res.matrix("predictions"), res.matrix("coefficients"),
# res.vector("mask"), res.scalar("intercept"), …

from pls4all.sklearn import dmodx_score
result = dmodx_score(X, y, n_components=4)

library(pls4all)
# Unified low-level dispatcher (May 2026 R cleanup):
res <- pls4all_method("pls_diagnostic_dmodx", X, y,
                      n_components = 4L)
# res is a named list with MethodResult arrays/scalars.
# selected_indices / top_k_intervals are 1-based.

res = pls4all.pls_diagnostics(X, y, 4);
% see header of bindings/matlab/+pls4all/pls_diagnostics.m for full
% parameter surface:
%   res = pls_diagnostics(X, Y, n_components, X_reference)
yhat = predict(res, Xtest);

No idiomatic classdef wrapper — invoke pls4all.fit("pls_diagnostic_dmodx", X, y, …) directly from the unified MEX factory.

Registry parity references 📐

  • 📐 ref.r_mdatools (R · r) — mdatools 0.15.0 · qualitative (rmse_rel ≤ 5e+00) — R mdatools::pls with predict()$xdecomp$T2 / $Q. DModX is derived locally from $Q + DOF. mdatools uses different SIMPLS deflation / normalization conventions than pls4all, so cross-implementation parity is qualitative.

Benchmarks

Adaptive wall-clock per cell measured against full_matrix.csv. Only backends that implement this method are listed; libraries without the method are omitted.

Verdict  ·  ✓ ref / ≈ ref / ~ shape mark a reference-gate pass at strict / relaxed / qualitative tolerance  ·  ✓ bind = pls4all binding agrees with the C++ baseline  ·  ⇄ cross-check = documented by-design selector/RNG/model, noncanonical API/facade convention, or secondary oracle  ·  ✗ divergent  ·  ⚠ error  ·  — not run. The fastest backend per column is marked 🏆.

Reference gate: strict — numeric equivalence (rmse_rel_tol ≤ 1e-08).

Rows tagged with 📐 are the canonical parity references for this method (declared in parity_timing.registry). C++ and external rows show reference parity; pls4all language bindings show binding parity against the C++ backend. Hover the icon for role and tolerance band.

BackendParity200×30 (ms)
C++ native · libn4m
pls4all.cpp.blas+omp✓ ref 2e-151.25 ms
Python · pls4all
pls4all.python✓ bind1.25 ms🏆
pls4all.sklearn✓ bind1.41 ms
R · pls4all
pls4all.R✓ 7e-164.16 ms
pls4all.R.formula✓ 7e-164.79 ms
pls4all.R.mdatools✓ 7e-165.71 ms
pls4all.R.pls✓ 7e-164.47 ms
R · external
📐ref.r_mdatoolssource19.8 ms
BackendParity200×30 (ms)
C++ native · libn4m
pls4all.cpp.blas+omp✓ ref 2e-151.28 ms
Python · pls4all
pls4all.python✓ bind1.25 ms🏆
pls4all.sklearn✓ bind1.41 ms
R · pls4all
pls4all.R✓ 7e-166.86 ms
pls4all.R.formula✓ 7e-1620.8 ms
pls4all.R.mdatools✓ 7e-1614.5 ms
pls4all.R.pls✓ 7e-1618.2 ms
R · external
📐ref.r_mdatoolssource43.6 ms
BackendParity200×30 (ms)
C++ native · libn4m
pls4all.cpp.blas+omp✓ ref 2e-156.12 ms
Python · pls4all
pls4all.python✓ bind2.29 ms
pls4all.sklearn✓ bind1.45 ms🏆
R · pls4all
pls4all.R✓ 7e-163.74 ms
pls4all.R.formula✓ 7e-164.94 ms
pls4all.R.mdatools✓ 7e-165.32 ms
pls4all.R.pls✓ 7e-164.64 ms
R · external
📐ref.r_mdatoolssource21.1 ms

See also: benchmark overview · methods index · interactive dashboard