# HG changeset patch # User Tuomo Valkonen # Date 1745846764 18000 # Node ID 9e5b9fc81c52c9641d8226c6a1ca4ff1b335f12d # Parent 2e4517b55442207ff49474d456df3e61b8fc0633 Quadratic Mappings; Lipschitz trait (moved from pointsource_algs). diff -r 2e4517b55442 -r 9e5b9fc81c52 src/linops.rs --- a/src/linops.rs Sun Apr 27 20:41:36 2025 -0500 +++ b/src/linops.rs Mon Apr 28 08:26:04 2025 -0500 @@ -2,38 +2,46 @@ Abstract linear operators. */ -use numeric_literals::replace_float_literals; -use std::marker::PhantomData; -use serde::Serialize; -use crate::types::*; -pub use crate::mapping::{Mapping, Space, Composition}; use crate::direct_product::Pair; use crate::instance::Instance; -use crate::norms::{NormExponent, PairNorm, L1, L2, Linfinity, Norm}; +pub use crate::mapping::{Composition, DifferentiableImpl, Mapping, Space}; +use crate::norms::{Linfinity, Norm, NormExponent, PairNorm, L1, L2}; +use crate::types::*; +use numeric_literals::replace_float_literals; +use serde::Serialize; +use std::marker::PhantomData; /// Trait for linear operators on `X`. -pub trait Linear : Mapping -{ } +pub trait Linear: Mapping {} + +// impl> DifferentiableImpl for A { +// type Derivative = >::Codomain; + +// /// Compute the differential of `self` at `x`, consuming the input. +// fn differential_impl>(&self, x: I) -> Self::Derivative { +// self.apply(x) +// } +// } /// Efficient in-place summation. #[replace_float_literals(F::cast_from(literal))] -pub trait AXPY : Space + std::ops::MulAssign +pub trait AXPY: Space + std::ops::MulAssign where - F : Num, - X : Space, + F: Num, + X: Space, { - type Owned : AXPY; + type Owned: AXPY; /// Computes `y = βy + αx`, where `y` is `Self`. - fn axpy>(&mut self, α : F, x : I, β : F); + fn axpy>(&mut self, α: F, x: I, β: F); /// Copies `x` to `self`. - fn copy_from>(&mut self, x : I) { + fn copy_from>(&mut self, x: I) { self.axpy(1.0, x, 0.0) } /// Computes `y = αx`, where `y` is `Self`. - fn scale_from>(&mut self, α : F, x : I) { + fn scale_from>(&mut self, α: F, x: I) { self.axpy(α, x, 0.0) } @@ -46,37 +54,36 @@ /// Efficient in-place application for [`Linear`] operators. #[replace_float_literals(F::cast_from(literal))] -pub trait GEMV>::Codomain> : Linear { +pub trait GEMV>::Codomain>: Linear { /// Computes `y = αAx + βy`, where `A` is `Self`. - fn gemv>(&self, y : &mut Y, α : F, x : I, β : F); + fn gemv>(&self, y: &mut Y, α: F, x: I, β: F); #[inline] /// Computes `y = Ax`, where `A` is `Self` - fn apply_mut>(&self, y : &mut Y, x : I){ + fn apply_mut>(&self, y: &mut Y, x: I) { self.gemv(y, 1.0, x, 0.0) } #[inline] /// Computes `y += Ax`, where `A` is `Self` - fn apply_add>(&self, y : &mut Y, x : I){ + fn apply_add>(&self, y: &mut Y, x: I) { self.gemv(y, 1.0, x, 1.0) } } - /// Bounded linear operators -pub trait BoundedLinear : Linear +pub trait BoundedLinear: Linear where - F : Num, - X : Space + Norm, - XExp : NormExponent, - CodExp : NormExponent + F: Num, + X: Space + Norm, + XExp: NormExponent, + CodExp: NormExponent, { /// A bound on the operator norm $\|A\|$ for the linear operator $A$=`self`. /// This is not expected to be the norm, just any bound on it that can be /// reasonably implemented. The [`NormExponent`] `xexp` indicates the norm /// in `X`, and `codexp` in the codomain. - fn opnorm_bound(&self, xexp : XExp, codexp : CodExp) -> F; + fn opnorm_bound(&self, xexp: XExp, codexp: CodExp) -> F; } // Linear operator application into mutable target. The [`AsRef`] bound @@ -90,13 +97,15 @@ }*/ /// Trait for forming the adjoint operator of `Self`. -pub trait Adjointable : Linear +pub trait Adjointable: Linear where - X : Space, - Yʹ : Space, + X: Space, + Yʹ: Space, { - type AdjointCodomain : Space; - type Adjoint<'a> : Linear where Self : 'a; + type AdjointCodomain: Space; + type Adjoint<'a>: Linear + where + Self: 'a; /// Form the adjoint operator of `self`. fn adjoint(&self) -> Self::Adjoint<'_>; @@ -112,144 +121,168 @@ /// We do not make additional restrictions on `Self::Preadjoint` (in particular, it /// does not have to be adjointable) to allow `X` to be a subspace yet the preadjoint /// have the full space as the codomain, etc. -pub trait Preadjointable : Linear { - type PreadjointCodomain : Space; - type Preadjoint<'a> : Linear< - Ypre, Codomain=Self::PreadjointCodomain - > where Self : 'a; +pub trait Preadjointable>::Codomain>: + Linear +{ + type PreadjointCodomain: Space; + type Preadjoint<'a>: Linear + where + Self: 'a; /// Form the adjoint operator of `self`. fn preadjoint(&self) -> Self::Preadjoint<'_>; } /// Adjointable operators $A: X → Y$ between reflexive spaces $X$ and $Y$. -pub trait SimplyAdjointable : Adjointable>::Codomain> {} -impl<'a,X : Space, T> SimplyAdjointable for T -where T : Adjointable>::Codomain> {} +pub trait SimplyAdjointable: Adjointable>::Codomain> {} +impl<'a, X: Space, T> SimplyAdjointable for T where + T: Adjointable>::Codomain> +{ +} /// The identity operator -#[derive(Clone,Copy,Debug,Serialize,Eq,PartialEq)] -pub struct IdOp (PhantomData); +#[derive(Clone, Copy, Debug, Serialize, Eq, PartialEq)] +pub struct IdOp(PhantomData); impl IdOp { - pub fn new() -> IdOp { IdOp(PhantomData) } + pub fn new() -> IdOp { + IdOp(PhantomData) + } } -impl Mapping for IdOp { +impl Mapping for IdOp { type Codomain = X; - fn apply>(&self, x : I) -> X { + fn apply>(&self, x: I) -> X { x.own() } } -impl Linear for IdOp -{ } +impl Linear for IdOp {} #[replace_float_literals(F::cast_from(literal))] -impl GEMV for IdOp +impl GEMV for IdOp where - Y : AXPY, - X : Clone + Space + Y: AXPY, + X: Clone + Space, { // Computes `y = αAx + βy`, where `A` is `Self`. - fn gemv>(&self, y : &mut Y, α : F, x : I, β : F) { + fn gemv>(&self, y: &mut Y, α: F, x: I, β: F) { y.axpy(α, x, β) } - fn apply_mut>(&self, y : &mut Y, x : I){ + fn apply_mut>(&self, y: &mut Y, x: I) { y.copy_from(x); } } impl BoundedLinear for IdOp where - X : Space + Clone + Norm, - F : Num, - E : NormExponent + X: Space + Clone + Norm, + F: Num, + E: NormExponent, { - fn opnorm_bound(&self, _xexp : E, _codexp : E) -> F { F::ONE } -} - -impl Adjointable for IdOp { - type AdjointCodomain=X; - type Adjoint<'a> = IdOp where X : 'a; - - fn adjoint(&self) -> Self::Adjoint<'_> { IdOp::new() } + fn opnorm_bound(&self, _xexp: E, _codexp: E) -> F { + F::ONE + } } -impl Preadjointable for IdOp { - type PreadjointCodomain=X; - type Preadjoint<'a> = IdOp where X : 'a; +impl Adjointable for IdOp { + type AdjointCodomain = X; + type Adjoint<'a> + = IdOp + where + X: 'a; - fn preadjoint(&self) -> Self::Preadjoint<'_> { IdOp::new() } + fn adjoint(&self) -> Self::Adjoint<'_> { + IdOp::new() + } } +impl Preadjointable for IdOp { + type PreadjointCodomain = X; + type Preadjoint<'a> + = IdOp + where + X: 'a; + + fn preadjoint(&self) -> Self::Preadjoint<'_> { + IdOp::new() + } +} /// The zero operator -#[derive(Clone,Copy,Debug,Serialize,Eq,PartialEq)] +#[derive(Clone, Copy, Debug, Serialize, Eq, PartialEq)] pub struct ZeroOp<'a, X, XD, Y, F> { - zero : &'a Y, // TODO: don't pass this in `new`; maybe not even store. - dual_or_predual_zero : XD, - _phantoms : PhantomData<(X, Y, F)>, + zero: &'a Y, // TODO: don't pass this in `new`; maybe not even store. + dual_or_predual_zero: XD, + _phantoms: PhantomData<(X, Y, F)>, } // TODO: Need to make Zero in Instance. -impl<'a, F : Num, X : Space, XD, Y : Space + Clone> ZeroOp<'a, X, XD, Y, F> { - pub fn new(zero : &'a Y, dual_or_predual_zero : XD) -> Self { - ZeroOp{ zero, dual_or_predual_zero, _phantoms : PhantomData } +impl<'a, F: Num, X: Space, XD, Y: Space + Clone> ZeroOp<'a, X, XD, Y, F> { + pub fn new(zero: &'a Y, dual_or_predual_zero: XD) -> Self { + ZeroOp { + zero, + dual_or_predual_zero, + _phantoms: PhantomData, + } } } -impl<'a, F : Num, X : Space, XD, Y : AXPY + Clone> Mapping for ZeroOp<'a, X, XD, Y, F> { +impl<'a, F: Num, X: Space, XD, Y: AXPY + Clone> Mapping for ZeroOp<'a, X, XD, Y, F> { type Codomain = Y; - fn apply>(&self, _x : I) -> Y { + fn apply>(&self, _x: I) -> Y { self.zero.clone() } } -impl<'a, F : Num, X : Space, XD, Y : AXPY + Clone> Linear for ZeroOp<'a, X, XD, Y, F> -{ } +impl<'a, F: Num, X: Space, XD, Y: AXPY + Clone> Linear for ZeroOp<'a, X, XD, Y, F> {} #[replace_float_literals(F::cast_from(literal))] impl<'a, F, X, XD, Y> GEMV for ZeroOp<'a, X, XD, Y, F> where - F : Num, - Y : AXPY + Clone, - X : Space + F: Num, + Y: AXPY + Clone, + X: Space, { // Computes `y = αAx + βy`, where `A` is `Self`. - fn gemv>(&self, y : &mut Y, _α : F, _x : I, β : F) { + fn gemv>(&self, y: &mut Y, _α: F, _x: I, β: F) { *y *= β; } - fn apply_mut>(&self, y : &mut Y, _x : I){ + fn apply_mut>(&self, y: &mut Y, _x: I) { y.set_zero(); } } impl<'a, F, X, XD, Y, E1, E2> BoundedLinear for ZeroOp<'a, X, XD, Y, F> where - X : Space + Norm, - Y : AXPY + Clone + Norm, - F : Num, - E1 : NormExponent, - E2 : NormExponent, + X: Space + Norm, + Y: AXPY + Clone + Norm, + F: Num, + E1: NormExponent, + E2: NormExponent, { - fn opnorm_bound(&self, _xexp : E1, _codexp : E2) -> F { F::ZERO } + fn opnorm_bound(&self, _xexp: E1, _codexp: E2) -> F { + F::ZERO + } } -impl<'a, F : Num, X, XD, Y, Yprime : Space> Adjointable for ZeroOp<'a, X, XD, Y, F> +impl<'a, F: Num, X, XD, Y, Yprime: Space> Adjointable for ZeroOp<'a, X, XD, Y, F> where - X : Space, - Y : AXPY + Clone + 'static, - XD : AXPY + Clone + 'static, + X: Space, + Y: AXPY + Clone + 'static, + XD: AXPY + Clone + 'static, { type AdjointCodomain = XD; - type Adjoint<'b> = ZeroOp<'b, Yprime, (), XD, F> where Self : 'b; - // () means not (pre)adjointable. + type Adjoint<'b> + = ZeroOp<'b, Yprime, (), XD, F> + where + Self: 'b; + // () means not (pre)adjointable. fn adjoint(&self) -> Self::Adjoint<'_> { ZeroOp::new(&self.dual_or_predual_zero, ()) @@ -258,15 +291,18 @@ impl<'a, F, X, XD, Y, Ypre> Preadjointable for ZeroOp<'a, X, XD, Y, F> where - F : Num, - X : Space, - Y : AXPY + Clone, - Ypre : Space, - XD : AXPY + Clone + 'static, + F: Num, + X: Space, + Y: AXPY + Clone, + Ypre: Space, + XD: AXPY + Clone + 'static, { type PreadjointCodomain = XD; - type Preadjoint<'b> = ZeroOp<'b, Ypre, (), XD, F> where Self : 'b; - // () means not (pre)adjointable. + type Preadjoint<'b> + = ZeroOp<'b, Ypre, (), XD, F> + where + Self: 'b; + // () means not (pre)adjointable. fn preadjoint(&self) -> Self::Preadjoint<'_> { ZeroOp::new(&self.dual_or_predual_zero, ()) @@ -275,45 +311,46 @@ impl Linear for Composition where - X : Space, - T : Linear, - S : Linear -{ } + X: Space, + T: Linear, + S: Linear, +{ +} impl GEMV for Composition where - F : Num, - X : Space, - T : Linear, - S : GEMV, + F: Num, + X: Space, + T: Linear, + S: GEMV, { - fn gemv>(&self, y : &mut Y, α : F, x : I, β : F) { + fn gemv>(&self, y: &mut Y, α: F, x: I, β: F) { self.outer.gemv(y, α, self.inner.apply(x), β) } /// Computes `y = Ax`, where `A` is `Self` - fn apply_mut>(&self, y : &mut Y, x : I){ + fn apply_mut>(&self, y: &mut Y, x: I) { self.outer.apply_mut(y, self.inner.apply(x)) } /// Computes `y += Ax`, where `A` is `Self` - fn apply_add>(&self, y : &mut Y, x : I){ + fn apply_add>(&self, y: &mut Y, x: I) { self.outer.apply_add(y, self.inner.apply(x)) } } impl BoundedLinear for Composition where - F : Num, - X : Space + Norm, - Z : Space + Norm, - Xexp : NormExponent, - Yexp : NormExponent, - Zexp : NormExponent, - T : BoundedLinear, - S : BoundedLinear, + F: Num, + X: Space + Norm, + Z: Space + Norm, + Xexp: NormExponent, + Yexp: NormExponent, + Zexp: NormExponent, + T: BoundedLinear, + S: BoundedLinear, { - fn opnorm_bound(&self, xexp : Xexp, yexp : Yexp) -> F { + fn opnorm_bound(&self, xexp: Xexp, yexp: Yexp) -> F { let zexp = self.intermediate_norm_exponent; self.outer.opnorm_bound(zexp, yexp) * self.inner.opnorm_bound(xexp, zexp) } @@ -326,17 +363,16 @@ impl Mapping> for RowOp where - A : Space, - B : Space, - S : Mapping, - T : Mapping, - S::Codomain : Add, - >::Output : Space, - + A: Space, + B: Space, + S: Mapping, + T: Mapping, + S::Codomain: Add, + >::Output: Space, { type Codomain = >::Output; - fn apply>>(&self, x : I) -> Self::Codomain { + fn apply>>(&self, x: I) -> Self::Codomain { let Pair(a, b) = x.decompose(); self.0.apply(a) + self.1.apply(b) } @@ -344,38 +380,38 @@ impl Linear> for RowOp where - A : Space, - B : Space, - S : Linear, - T : Linear, - S::Codomain : Add, - >::Output : Space, -{ } - + A: Space, + B: Space, + S: Linear, + T: Linear, + S::Codomain: Add, + >::Output: Space, +{ +} impl<'b, F, S, T, Y, U, V> GEMV, Y> for RowOp where - U : Space, - V : Space, - S : GEMV, - T : GEMV, - F : Num, - Self : Linear, Codomain=Y> + U: Space, + V: Space, + S: GEMV, + T: GEMV, + F: Num, + Self: Linear, Codomain = Y>, { - fn gemv>>(&self, y : &mut Y, α : F, x : I, β : F) { + fn gemv>>(&self, y: &mut Y, α: F, x: I, β: F) { let Pair(u, v) = x.decompose(); self.0.gemv(y, α, u, β); self.1.gemv(y, α, v, F::ONE); } - fn apply_mut>>(&self, y : &mut Y, x : I) { + fn apply_mut>>(&self, y: &mut Y, x: I) { let Pair(u, v) = x.decompose(); self.0.apply_mut(y, u); self.1.apply_add(y, v); } /// Computes `y += Ax`, where `A` is `Self` - fn apply_add>>(&self, y : &mut Y, x : I) { + fn apply_add>>(&self, y: &mut Y, x: I) { let Pair(u, v) = x.decompose(); self.0.apply_add(y, u); self.1.apply_add(y, v); @@ -387,129 +423,137 @@ impl Mapping for ColOp where - A : Space, - S : Mapping, - T : Mapping, + A: Space, + S: Mapping, + T: Mapping, { type Codomain = Pair; - fn apply>(&self, a : I) -> Self::Codomain { + fn apply>(&self, a: I) -> Self::Codomain { Pair(self.0.apply(a.ref_instance()), self.1.apply(a)) } } impl Linear for ColOp where - A : Space, - S : Mapping, - T : Mapping, -{ } + A: Space, + S: Mapping, + T: Mapping, +{ +} impl GEMV> for ColOp where - X : Space, - S : GEMV, - T : GEMV, - F : Num, - Self : Linear> + X: Space, + S: GEMV, + T: GEMV, + F: Num, + Self: Linear>, { - fn gemv>(&self, y : &mut Pair, α : F, x : I, β : F) { + fn gemv>(&self, y: &mut Pair, α: F, x: I, β: F) { self.0.gemv(&mut y.0, α, x.ref_instance(), β); self.1.gemv(&mut y.1, α, x, β); } - fn apply_mut>(&self, y : &mut Pair, x : I){ + fn apply_mut>(&self, y: &mut Pair, x: I) { self.0.apply_mut(&mut y.0, x.ref_instance()); self.1.apply_mut(&mut y.1, x); } /// Computes `y += Ax`, where `A` is `Self` - fn apply_add>(&self, y : &mut Pair, x : I){ + fn apply_add>(&self, y: &mut Pair, x: I) { self.0.apply_add(&mut y.0, x.ref_instance()); self.1.apply_add(&mut y.1, x); } } - -impl Adjointable, Yʹ> for RowOp +impl Adjointable, Yʹ> for RowOp where - A : Space, - B : Space, - Yʹ : Space, - S : Adjointable, - T : Adjointable, - Self : Linear>, + A: Space, + B: Space, + Yʹ: Space, + S: Adjointable, + T: Adjointable, + Self: Linear>, // for<'a> ColOp, T::Adjoint<'a>> : Linear< // Yʹ, // Codomain=Pair // >, { type AdjointCodomain = Pair; - type Adjoint<'a> = ColOp, T::Adjoint<'a>> where Self : 'a; + type Adjoint<'a> + = ColOp, T::Adjoint<'a>> + where + Self: 'a; fn adjoint(&self) -> Self::Adjoint<'_> { ColOp(self.0.adjoint(), self.1.adjoint()) } } -impl Preadjointable, Yʹ> for RowOp +impl Preadjointable, Yʹ> for RowOp where - A : Space, - B : Space, - Yʹ : Space, - S : Preadjointable, - T : Preadjointable, - Self : Linear>, - for<'a> ColOp, T::Preadjoint<'a>> : Linear< - Yʹ, Codomain=Pair, - >, + A: Space, + B: Space, + Yʹ: Space, + S: Preadjointable, + T: Preadjointable, + Self: Linear>, + for<'a> ColOp, T::Preadjoint<'a>>: + Linear>, { type PreadjointCodomain = Pair; - type Preadjoint<'a> = ColOp, T::Preadjoint<'a>> where Self : 'a; + type Preadjoint<'a> + = ColOp, T::Preadjoint<'a>> + where + Self: 'a; fn preadjoint(&self) -> Self::Preadjoint<'_> { ColOp(self.0.preadjoint(), self.1.preadjoint()) } } - -impl Adjointable> for ColOp +impl Adjointable> for ColOp where - A : Space, - Xʹ : Space, - Yʹ : Space, - R : Space + ClosedAdd, - S : Adjointable, - T : Adjointable, - Self : Linear, + A: Space, + Xʹ: Space, + Yʹ: Space, + R: Space + ClosedAdd, + S: Adjointable, + T: Adjointable, + Self: Linear, // for<'a> RowOp, T::Adjoint<'a>> : Linear< // Pair, // Codomain=R, // >, { type AdjointCodomain = R; - type Adjoint<'a> = RowOp, T::Adjoint<'a>> where Self : 'a; + type Adjoint<'a> + = RowOp, T::Adjoint<'a>> + where + Self: 'a; fn adjoint(&self) -> Self::Adjoint<'_> { RowOp(self.0.adjoint(), self.1.adjoint()) } } -impl Preadjointable> for ColOp +impl Preadjointable> for ColOp where - A : Space, - Xʹ : Space, - Yʹ : Space, - R : Space + ClosedAdd, - S : Preadjointable, - T : Preadjointable, - Self : Linear, - for<'a> RowOp, T::Preadjoint<'a>> : Linear< - Pair, Codomain = R, - >, + A: Space, + Xʹ: Space, + Yʹ: Space, + R: Space + ClosedAdd, + S: Preadjointable, + T: Preadjointable, + Self: Linear, + for<'a> RowOp, T::Preadjoint<'a>>: Linear, Codomain = R>, { type PreadjointCodomain = R; - type Preadjoint<'a> = RowOp, T::Preadjoint<'a>> where Self : 'a; + type Preadjoint<'a> + = RowOp, T::Preadjoint<'a>> + where + Self: 'a; fn preadjoint(&self) -> Self::Preadjoint<'_> { RowOp(self.0.preadjoint(), self.1.preadjoint()) @@ -521,14 +565,14 @@ impl Mapping> for DiagOp where - A : Space, - B : Space, - S : Mapping, - T : Mapping, + A: Space, + B: Space, + S: Mapping, + T: Mapping, { type Codomain = Pair; - fn apply>>(&self, x : I) -> Self::Codomain { + fn apply>>(&self, x: I) -> Self::Codomain { let Pair(a, b) = x.decompose(); Pair(self.0.apply(a), self.1.apply(b)) } @@ -536,81 +580,84 @@ impl Linear> for DiagOp where - A : Space, - B : Space, - S : Linear, - T : Linear, -{ } + A: Space, + B: Space, + S: Linear, + T: Linear, +{ +} impl GEMV, Pair> for DiagOp where - A : Space, - B : Space, - U : Space, - V : Space, - S : GEMV, - T : GEMV, - F : Num, - Self : Linear, Codomain=Pair>, + A: Space, + B: Space, + U: Space, + V: Space, + S: GEMV, + T: GEMV, + F: Num, + Self: Linear, Codomain = Pair>, { - fn gemv>>(&self, y : &mut Pair, α : F, x : I, β : F) { + fn gemv>>(&self, y: &mut Pair, α: F, x: I, β: F) { let Pair(u, v) = x.decompose(); self.0.gemv(&mut y.0, α, u, β); self.1.gemv(&mut y.1, α, v, β); } - fn apply_mut>>(&self, y : &mut Pair, x : I){ + fn apply_mut>>(&self, y: &mut Pair, x: I) { let Pair(u, v) = x.decompose(); self.0.apply_mut(&mut y.0, u); self.1.apply_mut(&mut y.1, v); } /// Computes `y += Ax`, where `A` is `Self` - fn apply_add>>(&self, y : &mut Pair, x : I){ + fn apply_add>>(&self, y: &mut Pair, x: I) { let Pair(u, v) = x.decompose(); self.0.apply_add(&mut y.0, u); self.1.apply_add(&mut y.1, v); } } -impl Adjointable, Pair> for DiagOp +impl Adjointable, Pair> for DiagOp where - A : Space, - B : Space, + A: Space, + B: Space, Xʹ: Space, - Yʹ : Space, - R : Space, - S : Adjointable, - T : Adjointable, - Self : Linear>, - for<'a> DiagOp, T::Adjoint<'a>> : Linear< - Pair, Codomain=R, - >, + Yʹ: Space, + R: Space, + S: Adjointable, + T: Adjointable, + Self: Linear>, + for<'a> DiagOp, T::Adjoint<'a>>: Linear, Codomain = R>, { type AdjointCodomain = R; - type Adjoint<'a> = DiagOp, T::Adjoint<'a>> where Self : 'a; + type Adjoint<'a> + = DiagOp, T::Adjoint<'a>> + where + Self: 'a; fn adjoint(&self) -> Self::Adjoint<'_> { DiagOp(self.0.adjoint(), self.1.adjoint()) } } -impl Preadjointable, Pair> for DiagOp +impl Preadjointable, Pair> for DiagOp where - A : Space, - B : Space, + A: Space, + B: Space, Xʹ: Space, - Yʹ : Space, - R : Space, - S : Preadjointable, - T : Preadjointable, - Self : Linear>, - for<'a> DiagOp, T::Preadjoint<'a>> : Linear< - Pair, Codomain=R, - >, + Yʹ: Space, + R: Space, + S: Preadjointable, + T: Preadjointable, + Self: Linear>, + for<'a> DiagOp, T::Preadjoint<'a>>: Linear, Codomain = R>, { type PreadjointCodomain = R; - type Preadjoint<'a> = DiagOp, T::Preadjoint<'a>> where Self : 'a; + type Preadjoint<'a> + = DiagOp, T::Preadjoint<'a>> + where + Self: 'a; fn preadjoint(&self) -> Self::Preadjoint<'_> { DiagOp(self.0.preadjoint(), self.1.preadjoint()) @@ -620,28 +667,26 @@ /// Block operator pub type BlockOp = ColOp, RowOp>; - macro_rules! pairnorm { ($expj:ty) => { impl - BoundedLinear, PairNorm, ExpR, F> - for RowOp + BoundedLinear, PairNorm, ExpR, F> for RowOp where - F : Float, - A : Space + Norm, - B : Space + Norm, - S : BoundedLinear, - T : BoundedLinear, - S::Codomain : Add, - >::Output : Space, - ExpA : NormExponent, - ExpB : NormExponent, - ExpR : NormExponent, + F: Float, + A: Space + Norm, + B: Space + Norm, + S: BoundedLinear, + T: BoundedLinear, + S::Codomain: Add, + >::Output: Space, + ExpA: NormExponent, + ExpB: NormExponent, + ExpR: NormExponent, { fn opnorm_bound( &self, - PairNorm(expa, expb, _) : PairNorm, - expr : ExpR + PairNorm(expa, expb, _): PairNorm, + expr: ExpR, ) -> F { // An application of the triangle inequality bounds the norm by the maximum // of the individual norms. A simple observation shows this to be exact. @@ -650,23 +695,22 @@ na.max(nb) } } - - impl - BoundedLinear, F> - for ColOp + + impl BoundedLinear, F> + for ColOp where - F : Float, - A : Space + Norm, - S : BoundedLinear, - T : BoundedLinear, - ExpA : NormExponent, - ExpS : NormExponent, - ExpT : NormExponent, + F: Float, + A: Space + Norm, + S: BoundedLinear, + T: BoundedLinear, + ExpA: NormExponent, + ExpS: NormExponent, + ExpT: NormExponent, { fn opnorm_bound( &self, - expa : ExpA, - PairNorm(exps, expt, _) : PairNorm + expa: ExpA, + PairNorm(exps, expt, _): PairNorm, ) -> F { // This is based on the rule for RowOp and ‖A^*‖ = ‖A‖, hence, // for A=[S; T], ‖A‖=‖[S^*, T^*]‖ ≤ max{‖S^*‖, ‖T^*‖} = max{‖S‖, ‖T‖} @@ -675,10 +719,9 @@ ns.max(nt) } } - } + }; } pairnorm!(L1); pairnorm!(L2); pairnorm!(Linfinity); - diff -r 2e4517b55442 -r 9e5b9fc81c52 src/mapping.rs --- a/src/mapping.rs Sun Apr 27 20:41:36 2025 -0500 +++ b/src/mapping.rs Mon Apr 28 08:26:04 2025 -0500 @@ -2,84 +2,95 @@ Traits for mathematical functions. */ -use std::marker::PhantomData; -use std::borrow::Cow; -use crate::types::{Num, Float, ClosedMul}; +pub use crate::instance::{BasicDecomposition, Decomposition, Instance, Space}; use crate::loc::Loc; -pub use crate::instance::{Instance, Decomposition, BasicDecomposition, Space}; use crate::norms::{Norm, NormExponent}; -use crate::operator_arithmetic::{Weighted, Constant}; +use crate::operator_arithmetic::{Constant, Weighted}; +use crate::types::{ClosedMul, Float, Num}; +use std::borrow::Cow; +use std::marker::PhantomData; /// A mapping from `Domain` to `Self::Codomain`. -pub trait Mapping { - type Codomain : Space; +pub trait Mapping { + type Codomain: Space; /// Compute the value of `self` at `x`. - fn apply>(&self, x : I) -> Self::Codomain; + fn apply>(&self, x: I) -> Self::Codomain; #[inline] /// Form the composition `self ∘ other` - fn compose>(self, other : T) - -> Composition + fn compose>(self, other: T) -> Composition where - Self : Sized + Self: Sized, { - Composition{ outer : self, inner : other, intermediate_norm_exponent : () } + Composition { + outer: self, + inner: other, + intermediate_norm_exponent: (), + } } - #[inline] /// Form the composition `self ∘ other`, assigning a norm to the inermediate space - fn compose_with_norm( - self, other : T, norm : E - ) -> Composition + fn compose_with_norm(self, other: T, norm: E) -> Composition where - Self : Sized, - X : Space, - T : Mapping, - E : NormExponent, - Domain : Norm, - F : Num + Self: Sized, + X: Space, + T: Mapping, + E: NormExponent, + Domain: Norm, + F: Num, { - Composition{ outer : self, inner : other, intermediate_norm_exponent : norm } + Composition { + outer: self, + inner: other, + intermediate_norm_exponent: norm, + } } /// Multiply `self` by the scalar `a`. #[inline] - fn weigh(self, a : C) -> Weighted + fn weigh(self, a: C) -> Weighted where - Self : Sized, - C : Constant, - Self::Codomain : ClosedMul, + Self: Sized, + C: Constant, + Self::Codomain: ClosedMul, { - Weighted { weight : a, base_fn : self } + Weighted { + weight: a, + base_fn: self, + } } } /// Automatically implemented shorthand for referring to [`Mapping`]s from [`Loc`] to `F`. -pub trait RealMapping -: Mapping, Codomain = F> {} +pub trait RealMapping: Mapping, Codomain = F> {} -impl RealMapping for T -where T : Mapping, Codomain = F> {} +impl RealMapping for T where T: Mapping, Codomain = F> {} /// A helper trait alias for referring to [`Mapping`]s from [`Loc`] to [`Loc`]. -pub trait RealVectorField -: Mapping, Codomain = Loc> {} +pub trait RealVectorField: + Mapping, Codomain = Loc> +{ +} -impl RealVectorField for T -where T : Mapping, Codomain = Loc> {} +impl RealVectorField for T where + T: Mapping, Codomain = Loc> +{ +} /// A differentiable mapping from `Domain` to [`Mapping::Codomain`], with differentials /// `Differential`. /// /// This is automatically implemented when [`DifferentiableImpl`] is. -pub trait DifferentiableMapping : Mapping { - type DerivativeDomain : Space; - type Differential<'b> : Mapping where Self : 'b; +pub trait DifferentiableMapping: Mapping { + type DerivativeDomain: Space; + type Differential<'b>: Mapping + where + Self: 'b; /// Calculate differential at `x` - fn differential>(&self, x : I) -> Self::DerivativeDomain; + fn differential>(&self, x: I) -> Self::DerivativeDomain; /// Form the differential mapping of `self`. fn diff(self) -> Self::Differential<'static>; @@ -90,50 +101,62 @@ /// Automatically implemented shorthand for referring to differentiable [`Mapping`]s from /// [`Loc`] to `F`. -pub trait DifferentiableRealMapping -: DifferentiableMapping, Codomain = F, DerivativeDomain = Loc> {} +pub trait DifferentiableRealMapping: + DifferentiableMapping, Codomain = F, DerivativeDomain = Loc> +{ +} -impl DifferentiableRealMapping for T -where T : DifferentiableMapping, Codomain = F, DerivativeDomain = Loc> {} +impl DifferentiableRealMapping for T where + T: DifferentiableMapping, Codomain = F, DerivativeDomain = Loc> +{ +} /// Helper trait for implementing [`DifferentiableMapping`] -pub trait DifferentiableImpl : Sized { - type Derivative : Space; +pub trait DifferentiableImpl: Sized { + type Derivative: Space; /// Compute the differential of `self` at `x`, consuming the input. - fn differential_impl>(&self, x : I) -> Self::Derivative; + fn differential_impl>(&self, x: I) -> Self::Derivative; } impl DifferentiableMapping for T where - Domain : Space, - T : Clone + Mapping + DifferentiableImpl + Domain: Space, + T: Clone + Mapping + DifferentiableImpl, { type DerivativeDomain = T::Derivative; - type Differential<'b> = Differential<'b, Domain, Self> where Self : 'b; - + type Differential<'b> + = Differential<'b, Domain, Self> + where + Self: 'b; + #[inline] - fn differential>(&self, x : I) -> Self::DerivativeDomain { + fn differential>(&self, x: I) -> Self::DerivativeDomain { self.differential_impl(x) } fn diff(self) -> Differential<'static, Domain, Self> { - Differential{ g : Cow::Owned(self), _space : PhantomData } + Differential { + g: Cow::Owned(self), + _space: PhantomData, + } } fn diff_ref(&self) -> Differential<'_, Domain, Self> { - Differential{ g : Cow::Borrowed(self), _space : PhantomData } + Differential { + g: Cow::Borrowed(self), + _space: PhantomData, + } } } - /// Container for the differential [`Mapping`] of a [`DifferentiableMapping`]. -pub struct Differential<'a, X, G : Clone> { - g : Cow<'a, G>, - _space : PhantomData +pub struct Differential<'a, X, G: Clone> { + g: Cow<'a, G>, + _space: PhantomData, } -impl<'a, X, G : Clone> Differential<'a, X, G> { +impl<'a, X, G: Clone> Differential<'a, X, G> { pub fn base_fn(&self) -> &G { &self.g } @@ -141,65 +164,68 @@ impl<'a, X, G> Mapping for Differential<'a, X, G> where - X : Space, - G : Clone + DifferentiableMapping + X: Space, + G: Clone + DifferentiableMapping, { type Codomain = G::DerivativeDomain; #[inline] - fn apply>(&self, x : I) -> Self::Codomain { + fn apply>(&self, x: I) -> Self::Codomain { (*self.g).differential(x) } } /// Container for flattening [`Loc`]`` codomain of a [`Mapping`] to `F`. pub struct FlattenedCodomain { - g : G, - _phantoms : PhantomData<(X, F)> + g: G, + _phantoms: PhantomData<(X, F)>, } -impl Mapping for FlattenedCodomain +impl Mapping for FlattenedCodomain where - X : Space, - G: Mapping> + X: Space, + G: Mapping>, { type Codomain = F; #[inline] - fn apply>(&self, x : I) -> Self::Codomain { + fn apply>(&self, x: I) -> Self::Codomain { self.g.apply(x).flatten1d() } } /// An auto-trait for constructing a [`FlattenCodomain`] structure for /// flattening the codomain of a [`Mapping`] from [`Loc`]`` to `F`. -pub trait FlattenCodomain : Mapping> + Sized { +pub trait FlattenCodomain: Mapping> + Sized { /// Flatten the codomain from [`Loc`]`` to `F`. fn flatten_codomain(self) -> FlattenedCodomain { - FlattenedCodomain{ g : self, _phantoms : PhantomData } + FlattenedCodomain { + g: self, + _phantoms: PhantomData, + } } } -impl>> FlattenCodomain for G {} +impl>> FlattenCodomain for G {} /// Container for dimensional slicing [`Loc`]`` codomain of a [`Mapping`] to `F`. -pub struct SlicedCodomain<'a, X, F, G : Clone, const N : usize> { - g : Cow<'a, G>, - slice : usize, - _phantoms : PhantomData<(X, F)> +pub struct SlicedCodomain<'a, X, F, G: Clone, const N: usize> { + g: Cow<'a, G>, + slice: usize, + _phantoms: PhantomData<(X, F)>, } -impl<'a, X, F, G, const N : usize> Mapping for SlicedCodomain<'a, X, F, G, N> +impl<'a, X, F, G, const N: usize> Mapping for SlicedCodomain<'a, X, F, G, N> where - X : Space, - F : Copy + Space, - G : Mapping> + Clone, + X: Space, + F: Copy + Space, + G: Mapping> + Clone, { type Codomain = F; #[inline] - fn apply>(&self, x : I) -> Self::Codomain { - let tmp : [F; N] = (*self.g).apply(x).into(); + fn apply>(&self, x: I) -> Self::Codomain { + let tmp: [F; N] = (*self.g).apply(x).into(); // Safety: `slice_codomain` below checks the range. unsafe { *tmp.get_unchecked(self.slice) } } @@ -207,44 +233,64 @@ /// An auto-trait for constructing a [`FlattenCodomain`] structure for /// flattening the codomain of a [`Mapping`] from [`Loc`]`` to `F`. -pub trait SliceCodomain - : Mapping> + Clone + Sized +pub trait SliceCodomain: + Mapping> + Clone + Sized { /// Flatten the codomain from [`Loc`]`` to `F`. - fn slice_codomain(self, slice : usize) -> SlicedCodomain<'static, X, F, Self, N> { + fn slice_codomain(self, slice: usize) -> SlicedCodomain<'static, X, F, Self, N> { assert!(slice < N); - SlicedCodomain{ g : Cow::Owned(self), slice, _phantoms : PhantomData } + SlicedCodomain { + g: Cow::Owned(self), + slice, + _phantoms: PhantomData, + } } /// Flatten the codomain from [`Loc`]`` to `F`. - fn slice_codomain_ref(&self, slice : usize) -> SlicedCodomain<'_, X, F, Self, N> { + fn slice_codomain_ref(&self, slice: usize) -> SlicedCodomain<'_, X, F, Self, N> { assert!(slice < N); - SlicedCodomain{ g : Cow::Borrowed(self), slice, _phantoms : PhantomData } + SlicedCodomain { + g: Cow::Borrowed(self), + slice, + _phantoms: PhantomData, + } } } -impl> + Clone, const N : usize> -SliceCodomain -for G {} - +impl> + Clone, const N: usize> + SliceCodomain for G +{ +} /// The composition S ∘ T. `E` is for storing a `NormExponent` for the intermediate space. pub struct Composition { - pub outer : S, - pub inner : T, - pub intermediate_norm_exponent : E + pub outer: S, + pub inner: T, + pub intermediate_norm_exponent: E, } impl Mapping for Composition where - X : Space, - T : Mapping, - S : Mapping + X: Space, + T: Mapping, + S: Mapping, { type Codomain = S::Codomain; #[inline] - fn apply>(&self, x : I) -> Self::Codomain { + fn apply>(&self, x: I) -> Self::Codomain { self.outer.apply(self.inner.apply(x)) } } + +mod quadratic; +pub use quadratic::Quadratic; + +/// Trait for indicating that `Self` is Lipschitz with respect to the (semi)norm `D`. +pub trait Lipschitz { + /// The type of floats + type FloatType: Float; + + /// Returns the Lipschitz factor of `self` with respect to the (semi)norm `D`. + fn lipschitz_factor(&self, seminorm: M) -> Option; +} diff -r 2e4517b55442 -r 9e5b9fc81c52 src/mapping/quadratic.rs --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/mapping/quadratic.rs Mon Apr 28 08:26:04 2025 -0500 @@ -0,0 +1,98 @@ +/*! +Quadratic functions of the form $\frac{1}{2}\|Ax-b\|_2^2$ for an operator $A$ +to a [`Euclidean`] space. +*/ + +#![allow(non_snake_case)] + +use super::{DifferentiableImpl, Differential, Lipschitz, Mapping}; +use crate::convex::ConvexMapping; +use crate::euclidean::Euclidean; +use crate::instance::{Instance, Space}; +use crate::linops::{BoundedLinear, Linear, Preadjointable}; +use crate::norms::{Norm, NormExponent, L2}; +use crate::types::Float; +use std::marker::PhantomData; + +/// Functions of the form $\frac{1}{2}\|Ax-b\|_2^2$ for an operator $A$ +/// to a [`Euclidean`] space. +#[derive(Clone, Copy)] +pub struct Quadratic<'a, F: Float, Domain: Space, A: Mapping> { + opA: &'a A, + b: &'a >::Codomain, + _phantoms: PhantomData, +} + +#[allow(non_snake_case)] +impl<'a, F: Float, Domain: Space, A: Mapping> Quadratic<'a, F, Domain, A> { + pub fn new(opA: &'a A, b: &'a A::Codomain) -> Self { + Quadratic { + opA, + b, + _phantoms: PhantomData, + } + } + + pub fn operator(&self) -> &'a A { + self.opA + } + + pub fn data(&self) -> &'a >::Codomain { + self.b + } +} + +//+ AdjointProductBoundedBy, P, FloatType = F>, + +impl<'a, F: Float, X: Space, A: Mapping> Mapping for Quadratic<'a, F, X, A> +where + A::Codomain: Euclidean, +{ + type Codomain = F; + + fn apply>(&self, x: I) -> F { + // TODO: possibly (if at all more effcient) use GEMV once generalised + // to not require preallocation. However, Rust should be pretty efficient + // at not doing preallocations or anything here, as the result of self.opA.apply() + // can be consumed, so maybe GEMV is no use. + (self.opA.apply(x) - self.b).norm2_squared() / F::TWO + } +} + +impl<'a, F: Float, X: Space, A: Linear> ConvexMapping for Quadratic<'a, F, X, A> where + A::Codomain: Euclidean +{ +} + +impl<'a, F, X, A> DifferentiableImpl for Quadratic<'a, F, X, A> +where + F: Float, + X: Space, + >::Codomain: Euclidean, + A: Linear + Preadjointable, + <>::Codomain as Euclidean>::Output: Instance<>::Codomain>, +{ + type Derivative = A::PreadjointCodomain; + + fn differential_impl>(&self, x: I) -> Self::Derivative { + // TODO: possibly (if at all more effcient) use GEMV once generalised + // to not require preallocation. However, Rust should be pretty efficient + // at not doing preallocations or anything here, as the result of self.opA.apply() + // can be consumed, so maybe GEMV is no use. + self.opA.preadjoint().apply(self.opA.apply(x) - self.b) + } +} + +impl<'a, 'b, F, X, ExpX, A> Lipschitz for Differential<'b, X, Quadratic<'a, F, X, A>> +where + F: Float, + X: Space + Clone + Norm, + ExpX: NormExponent, + A: Clone + BoundedLinear, +{ + type FloatType = F; + + fn lipschitz_factor(&self, seminorm: ExpX) -> Option { + Some((*self.g).opA.opnorm_bound(seminorm, L2).powi(2)) + } +}