src/fb.rs

/*!
Solver for the point source localisation problem using a forward-backward splitting method.

This corresponds to the manuscript

 * Valkonen T. - _Proximal methods for point source localisation_,
   [arXiv:2212.02991](https://arxiv.org/abs/2212.02991).

The main routine is [`pointsource_fb_reg`].

## Problem

<p>
Our objective is to solve
$$
    \min_{μ ∈ ℳ(Ω)}~ F_0(Aμ-b) + α \|μ\|_{ℳ(Ω)} + δ_{≥ 0}(μ),
$$
where $F_0(y)=\frac{1}{2}\|y\|_2^2$ and the forward operator $A \in 𝕃(ℳ(Ω); ℝ^n)$.
</p>

## Approach

<p>
As documented in more detail in the paper, on each step we approximately solve
$$
    \min_{μ ∈ ℳ(Ω)}~ F(x) + α \|μ\|_{ℳ(Ω)} + δ_{≥ 0}(x) + \frac{1}{2}\|μ-μ^k|_𝒟^2,
$$
where $𝒟: 𝕃(ℳ(Ω); C_c(Ω))$ is typically a convolution operator.
</p>

## Finite-dimensional subproblems.

With $C$ a projection from [`DiscreteMeasure`] to the weights, and $x^k$ such that $x^k=Cμ^k$, we
form the discretised linearised inner problem
<p>
$$
    \min_{x ∈ ℝ^n}~ τ\bigl(F(Cx^k) + [C^*∇F(Cx^k)]^⊤(x-x^k) + α {\vec 1}^⊤ x\bigr)
                    + δ_{≥ 0}(x) + \frac{1}{2}\|x-x^k\|_{C^*𝒟C}^2,
$$
equivalently
$$
    \begin{aligned}
    \min_x~ & τF(Cx^k) - τ[C^*∇F(Cx^k)]^⊤x^k + \frac{1}{2} (x^k)^⊤ C^*𝒟C x^k
            \\
            &
            - [C^*𝒟C x^k - τC^*∇F(Cx^k)]^⊤ x
            \\
            &
            + \frac{1}{2} x^⊤ C^*𝒟C x
            + τα {\vec 1}^⊤ x + δ_{≥ 0}(x),
    \end{aligned}
$$
In other words, we obtain the quadratic non-negativity constrained problem
$$
    \min_{x ∈ ℝ^n}~ \frac{1}{2} x^⊤ Ã x - b̃^⊤ x + c + τα {\vec 1}^⊤ x + δ_{≥ 0}(x).
$$
where
$$
   \begin{aligned}
    Ã & = C^*𝒟C,
    \\
    g̃ & = C^*𝒟C x^k - τ C^*∇F(Cx^k)
        = C^* 𝒟 μ^k - τ C^*A^*(Aμ^k - b)
    \\
    c & = τ F(Cx^k) - τ[C^*∇F(Cx^k)]^⊤x^k + \frac{1}{2} (x^k)^⊤ C^*𝒟C x^k
        \\
        &
        = \frac{τ}{2} \|Aμ^k-b\|^2 - τ[Aμ^k-b]^⊤Aμ^k + \frac{1}{2} \|μ_k\|_{𝒟}^2
        \\
        &
        = -\frac{τ}{2} \|Aμ^k-b\|^2 + τ[Aμ^k-b]^⊤ b + \frac{1}{2} \|μ_k\|_{𝒟}^2.
   \end{aligned}
$$
</p>

We solve this with either SSN or FB as determined by
[`crate::subproblem::InnerSettings`] in [`InsertionConfig::inner`].
*/

use crate::domain::{AdmissibleDomain, FullSpace};
use crate::measures::merging::SpikeMerging;
use crate::measures::DiscreteMeasure;
use crate::plot::Plotter;
pub use crate::prox_penalty::{InsertionConfig, ProxPenalty, StepLengthBound};
use crate::regularisation::RegTerm;
use crate::types::*;
use alg_tools::error::DynResult;
use alg_tools::instance::Instance;
use alg_tools::iterate::AlgIteratorFactory;
use alg_tools::linops::Space;
use alg_tools::mapping::DifferentiableMapping;
use alg_tools::nalgebra_support::ToNalgebraRealField;
use colored::Colorize;
use measures::DeltaMeasure;
use numeric_literals::replace_float_literals;
use serde::{Deserialize, Serialize};

/// Settings for [`pointsource_fb_reg`].
#[derive(Clone, Copy, Eq, PartialEq, Serialize, Deserialize, Debug)]
#[serde(default)]
pub struct FBConfig<F: Float> {
    /// Step length scaling
    pub τ0: F,
    // Auxiliary variable step length scaling for [`crate::forward_pdps::pointsource_fb_pair`]
    pub σp0: F,
    /// Generic parameters
    pub insertion: InsertionConfig<F>,
}

#[replace_float_literals(F::cast_from(literal))]
impl<F: Float> Default for FBConfig<F> {
    fn default() -> Self {
        FBConfig { τ0: 0.99, σp0: 0.99, insertion: Default::default() }
    }
}

pub(crate) fn prune_with_stats<U: Space, F: Float>(
    μ: &mut DiscreteMeasure<U, F>,
    until: usize,
) -> usize {
    let n_before_prune = μ.len();
    μ.prune_until(until);
    debug_assert!(μ.len() <= n_before_prune);
    n_before_prune - μ.len()
}

#[replace_float_literals(F::cast_from(literal))]
pub(crate) fn postprocess<F: Float, U, Dat>(
    mut μ: DiscreteMeasure<U, F>,
    config: &InsertionConfig<F>,
    f: Dat,
) -> DynResult<DiscreteMeasure<U, F>>
where
    Dat: Fn(&DiscreteMeasure<U, F>) -> F,
    U: Space + Clone,
    DiscreteMeasure<U, F>: SpikeMerging<F>,
    for<'a> &'a DiscreteMeasure<U, F>: Instance<DiscreteMeasure<U, F>>,
{
    //μ.merge_spikes_fitness(config.final_merging_method(), |μ̃| f.apply(μ̃), |&v| v);
    μ.merge_spikes_fitness(config.final_merging_method(), f, |&v| v);
    μ.prune();
    Ok(μ)
}

/// Iteratively solve the pointsource localisation problem using forward-backward splitting.
///
/// The settings in `config` have their [respective documentation](FBConfig). `opA` is the
/// forward operator $A$, $b$ the observable, and $\lambda$ the regularisation weight.
/// The operator `op𝒟` is used for forming the proximal term. Typically it is a convolution
/// operator. Finally, the `iterator` is an outer loop verbosity and iteration count control
/// as documented in [`alg_tools::iterate`].
///
/// For details on the mathematical formulation, see the [module level](self) documentation.
///
/// Returns the final iterate.
#[replace_float_literals(F::cast_from(literal))]
pub fn pointsource_fb_dom<F, I, Dat, Reg, P, Plot, U>(
    f: &Dat,
    reg: &Reg,
    prox_penalty: &P,
    fbconfig: &FBConfig<F>,
    iterator: I,
    mut plotter: Plot,
    μ0: Option<DiscreteMeasure<U, F>>,
    domain: &mut impl AdmissibleDomain<U>,
) -> DynResult<DiscreteMeasure<U, F>>
where
    U: Space + Clone,
    F: Float + ToNalgebraRealField,
    I: AlgIteratorFactory<IterInfo<F>>,
    DiscreteMeasure<U, F>: SpikeMerging<F>,
    Dat: DifferentiableMapping<DiscreteMeasure<U, F>, Codomain = F>,
    Dat::DerivativeDomain: ClosedMul<F>,
    Reg: RegTerm<U, F>,
    P: ProxPenalty<U, Dat::DerivativeDomain, Reg, F> + StepLengthBound<F, Dat>,
    Plot: Plotter<P::ReturnMapping, Dat::DerivativeDomain, DiscreteMeasure<U, F>>,
{
    // Set up parameters
    let config = &fbconfig.insertion;
    let τ = fbconfig.τ0 / prox_penalty.step_length_bound(&f)?;
    // We multiply tolerance by τ for FB since our subproblems depending on tolerances are scaled
    // by τ compared to the conditional gradient approach.
    let tolerance = config.tolerance * τ * reg.tolerance_scaling();
    let mut ε = tolerance.initial();

    // Initialise iterates
    let mut μ = μ0.unwrap_or_else(|| DiscreteMeasure::new());

    // Statistics
    let full_stats = |μ: &DiscreteMeasure<U, F>, ε, stats| IterInfo {
        value: f.apply(μ) + reg.apply(μ),
        n_spikes: μ.len(),
        ε,
        //postprocessing: config.postprocessing.then(|| μ.clone()),
        ..stats
    };
    let mut stats = IterInfo::new();

    // Run the algorithm
    for state in iterator.iter_init(|| full_stats(&μ, ε, stats.clone())) {
        let maybe_μ_base = config.if_merge_now_check(&state, || μ.clone());
        let μ_base_len = μ.len();

        // Calculate smooth part of surrogate model.
        let mut τv = f.differential(&μ) * τ;

        // Do spike insertiona nd finite-dimensional weight optimisation
        prox_penalty.insert_and_reweigh(&mut μ, &mut τv, τ, ε, config, &reg, &state, &mut stats)?;

        stats.inserted += μ.len() - μ_base_len;

        // Prune and possibly merge spikes
        let did_merge = if let Some(μ_base) = maybe_μ_base {
            // Merge spikes.
            // This crucially expects the merge routine to be stable with respect to spike locations,
            // and not to performing any pruning. That is be to done below simultaneously for γ.
            config.if_merge_now(&state, |ins| {
                stats.merged += prox_penalty.merge_spikes(
                    &mut μ,
                    &mut τv,
                    &μ_base,
                    τ,
                    ε,
                    ins,
                    &reg,
                    Some(|μ̃: &DiscreteMeasure<U, F>| f.apply(μ̃) + reg.apply(μ̃)),
                );

                // Prune. Do not prune new insertions on first round.
                stats.pruned += prune_with_stats(&mut μ, μ_base_len);

                if config.random_insertions {
                    if let Some(x) = domain.random_point() {
                        μ += DeltaMeasure { x, α: 0.0 };
                        stats.inserted += 1;
                    }
                }

                // Do extra weight optimisation step heuristic
                for _ in 1..config.extra_weight_optimisation_steps {
                    τv = f.differential(&μ) * τ;
                    prox_penalty
                        .reweigh(&mut μ, &mut τv, τ, ε, &config, &reg, &state, &mut stats)?;
                }
                Ok(())
            })?
        } else {
            None
        };

        if did_merge.is_none() {
            // Prune. Do not prune new insertions on first round.
            stats.pruned += prune_with_stats(&mut μ, μ_base_len);
        }

        let iter = state.iteration();
        stats.this_iters += 1;

        // Give statistics if needed
        state.if_verbose(|| {
            plotter.plot_spikes(iter, None, Some(&τv), &μ);
            full_stats(&μ, ε, std::mem::replace(&mut stats, IterInfo::new()))
        });

        // Update main tolerance for next iteration
        ε = tolerance.update(ε, iter);
    }

    //postprocess(μ_prev, config, f)
    postprocess(μ, config, |μ̃| f.apply(μ̃) + reg.apply(μ̃))
}

#[deprecated]
pub fn pointsource_fb_reg<F, U, I, Dat, Reg, P, Plot>(
    f: &Dat,
    reg: &Reg,
    prox_penalty: &P,
    fbconfig: &FBConfig<F>,
    iterator: I,
    plotter: Plot,
    μ0: Option<DiscreteMeasure<U, F>>,
) -> DynResult<DiscreteMeasure<U, F>>
where
    U: Space + Clone,
    F: Float + ToNalgebraRealField,
    I: AlgIteratorFactory<IterInfo<F>>,
    DiscreteMeasure<U, F>: SpikeMerging<F>,
    Dat: DifferentiableMapping<DiscreteMeasure<U, F>, Codomain = F>,
    Dat::DerivativeDomain: ClosedMul<F>,
    Reg: RegTerm<U, F>,
    P: ProxPenalty<U, Dat::DerivativeDomain, Reg, F> + StepLengthBound<F, Dat>,
    Plot: Plotter<P::ReturnMapping, Dat::DerivativeDomain, DiscreteMeasure<U, F>>,
{
    pointsource_fb_dom(
        f,
        reg,
        prox_penalty,
        fbconfig,
        iterator,
        plotter,
        μ0,
        &mut FullSpace,
    )
}

/// Iteratively solve the pointsource localisation problem using inertial forward-backward splitting.
///
/// The settings in `config` have their [respective documentation](FBConfig). `opA` is the
/// forward operator $A$, $b$ the observable, and $\lambda$ the regularisation weight.
/// The operator `op𝒟` is used for forming the proximal term. Typically it is a convolution
/// operator. Finally, the `iterator` is an outer loop verbosity and iteration count control
/// as documented in [`alg_tools::iterate`].
///
/// For details on the mathematical formulation, see the [module level](self) documentation.
///
/// Returns the final iterate.
#[replace_float_literals(F::cast_from(literal))]
pub fn pointsource_fista_reg<F, U, I, Dat, Reg, P, Plot>(
    f: &Dat,
    reg: &Reg,
    prox_penalty: &P,
    fbconfig: &FBConfig<F>,
    iterator: I,
    mut plotter: Plot,
    μ0: Option<DiscreteMeasure<U, F>>,
) -> DynResult<DiscreteMeasure<U, F>>
where
    U: Space + Clone,
    F: Float + ToNalgebraRealField,
    I: AlgIteratorFactory<IterInfo<F>>,
    DiscreteMeasure<U, F>: SpikeMerging<F>,
    Dat: DifferentiableMapping<DiscreteMeasure<U, F>, Codomain = F>,
    Dat::DerivativeDomain: ClosedMul<F>,
    Reg: RegTerm<U, F>,
    P: ProxPenalty<U, Dat::DerivativeDomain, Reg, F> + StepLengthBound<F, Dat>,
    Plot: Plotter<P::ReturnMapping, Dat::DerivativeDomain, DiscreteMeasure<U, F>>,
{
    // Set up parameters
    let config = &fbconfig.insertion;
    let τ = fbconfig.τ0 / prox_penalty.step_length_bound(&f)?;
    let mut λ = 1.0;
    // We multiply tolerance by τ for FB since our subproblems depending on tolerances are scaled
    // by τ compared to the conditional gradient approach.
    let tolerance = config.tolerance * τ * reg.tolerance_scaling();
    let mut ε = tolerance.initial();

    // Initialise iterates
    let mut μ = μ0.unwrap_or_else(|| DiscreteMeasure::new());
    let mut μ_prev = μ.clone();
    let mut warned_merging = false;

    // Statistics
    let full_stats = |ν: &DiscreteMeasure<U, F>, ε, stats| IterInfo {
        value: f.apply(ν) + reg.apply(ν),
        n_spikes: ν.len(),
        ε,
        // postprocessing: config.postprocessing.then(|| ν.clone()),
        ..stats
    };
    let mut stats = IterInfo::new();

    // Run the algorithm
    for state in iterator.iter_init(|| full_stats(&μ, ε, stats.clone())) {
        let μ_base_len = μ.len();
        // Calculate smooth part of surrogate model.
        let mut τv = f.differential(&μ) * τ;

        // Do spike insertiona nd finite-dimensional weight optimisation
        prox_penalty.insert_and_reweigh(&mut μ, &mut τv, τ, ε, config, &reg, &state, &mut stats)?;

        stats.inserted += μ.len() - μ_base_len;

        // (Do not) merge spikes.
        if !warned_merging {
            config.if_merge_now_check(&state, || {
                let err = format!("Merging not supported for μFISTA");
                println!("{}", err.red());
                warned_merging = true;
            });
        }

        // Do extra weight optimisation step heuristic
        for _ in 0..config.extra_weight_optimisation_steps {
            τv = f.differential(&μ) * τ;
            prox_penalty.reweigh(&mut μ, &mut τv, τ, ε, config, &reg, &state, &mut stats)?;
        }

        // Update inertial prameters
        let λ_prev = λ;
        λ = 2.0 * λ_prev / (λ_prev + (4.0 + λ_prev * λ_prev).sqrt());
        let θ = λ / λ_prev - λ;

        // Perform inertial update on μ.
        // This computes μ ← (1 + θ) * μ - θ * μ_prev, pruning spikes where both μ
        // and μ_prev have zero weight. Since both have weights from the finite-dimensional
        // subproblem with a proximal projection step, this is likely to happen when the
        // spike is not needed. A copy of the pruned μ without artithmetic performed is
        // stored in μ_prev.
        let n_before_prune = μ.len();
        μ.pruning_sub(1.0 + θ, θ, &mut μ_prev);
        //let μ_new = (&μ * (1.0 + θ)).sub_matching(&(&μ_prev * θ));
        // μ_prev = μ;
        // μ = μ_new;
        debug_assert!(μ.len() <= n_before_prune);
        stats.pruned += n_before_prune - μ.len();

        let iter = state.iteration();
        stats.this_iters += 1;

        // Give statistics if needed
        state.if_verbose(|| {
            plotter.plot_spikes(iter, None, Some(&τv), &μ_prev);
            full_stats(&μ_prev, ε, std::mem::replace(&mut stats, IterInfo::new()))
        });

        // Update main tolerance for next iteration
        ε = tolerance.update(ε, iter);
    }

    //postprocess(μ_prev, config, f)
    postprocess(μ_prev, config, |μ̃| f.apply(μ̃))
}