Skip to main content

DuchonBasisSpec

Struct DuchonBasisSpec 

Source
pub struct DuchonBasisSpec {
    pub center_strategy: CenterStrategy,
    pub periodic: Option<Vec<Option<f64>>>,
    pub length_scale: Option<f64>,
    pub power: f64,
    pub nullspace_order: DuchonNullspaceOrder,
    pub identifiability: SpatialIdentifiability,
    pub aniso_log_scales: Option<Vec<f64>>,
    pub operator_penalties: DuchonOperatorPenaltySpec,
    pub boundary: OneDimensionalBoundary,
    pub radial_reparam: Option<Array2<f64>>,
}
Expand description

Duchon-like basis configuration with explicit low-frequency null-space control and explicit spectral power.

Fields§

§center_strategy: CenterStrategy§periodic: Option<Vec<Option<f64>>>§length_scale: Option<f64>

Optional hybrid Matérn width. None means pure scale-free Duchon with spectrum ||w||^(2p + 2s). Some(length_scale) enables the hybrid spectrum ||w||^(2p) * (kappa^2 + ||w||^2)^s, kappa = 1/length_scale.

§power: f64

Literal Duchon spectral power s (f64, fractional values fully threaded end-to-end). The pure-Duchon kernel exponent is 2(p + s) − d, so this is the knob that sets φ(r): s = 0 is the integer-order Duchon kernel r^{2p−d} (its r²·log r log case in even d, ≡ the thin-plate kernel); s = (d − 1)/2 gives the cubic in every dimension.

This field is taken LITERALLY by the basis builder — power = 0 means s = 0, NOT “use a default”. The magic cubic default (applied when the user gives no explicit power) is a request-layer choice resolved by the formula / CLI / pyffi front-ends via duchon_cubic_default; by the time a spec reaches the builder this value is the final intended s. The hybrid Duchon–Matérn path (length_scale = Some) still requires an integer s (read via spec.power_as_usize()).

§nullspace_order: DuchonNullspaceOrder§identifiability: SpatialIdentifiability§aniso_log_scales: Option<Vec<f64>>

Per-axis anisotropy log-scales η_a.

For hybrid Duchon (length_scale=Some), these are centered contrasts in the decomposition Λ = κA with det(A)=1. For pure Duchon (length_scale=None), they parameterize shape-only axis warping on the public path and are centered before basis evaluation/writeback so no global length scale is introduced.

When Some, the distance is r = √(Σ_a exp(2η_a) · (x_a - c_a)²). When None, isotropic distance r = ‖x - c‖ is used.

§operator_penalties: DuchonOperatorPenaltySpec§boundary: OneDimensionalBoundary§radial_reparam: Option<Array2<f64>>

Data-metric radial reparameterization V (#1355), mirroring the thin-plate Wood-TPRS reparam. When Some, the constrained kernel transform is folded to Z·V so the realized design columns rotate into the G_c-orthonormal generalized eigenbasis of Ω_c v = μ G_c v and the native penalty becomes the diagonal curvature-per-unit-data-variance spectrum (mgcv’s cliff), preventing the REML over-smoothing collapse to EDF = 1. Frozen at the cold dense build and replayed verbatim by the predict / κ-trial / ψ-derivative paths so they stay bit-consistent with the fit-time design. None on the lazy/streaming path (huge n), which retains the original constrained basis.

Implementations§

Source§

impl DuchonBasisSpec

Source

pub fn power_as_usize(&self) -> usize

Integer view of power for the existing integer-only downstream chain. Non-finite or non-integer values fall back to 0 (the integer-only validators downstream already reject this case with a clear message).

Trait Implementations§

Source§

impl Clone for DuchonBasisSpec

Source§

fn clone(&self) -> DuchonBasisSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DuchonBasisSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DuchonBasisSpec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for DuchonBasisSpec

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V