Mercurial > repos > pointsource_algs / changeset

--- a/README.md	Tue Dec 06 15:02:49 2022 +0200
+++ b/README.md	Wed Dec 07 06:54:56 2022 +0200
@@ -1,9 +1,9 @@
 
 # Proximal methods for point source localisation: the implementation
 
-This package contains [Rust][] codes for the manuscript “_Proximal methods for
-point source localisation_” by Tuomo Valkonen ⟨tuomov@iki.fi⟩. It concerns
-solution of problems of the type
+This package contains [Rust] codes for the manuscript “_Proximal methods for
+point source localisation_” ([arXiv:2212.02991]) by Tuomo Valkonen
+⟨tuomov@iki.fi⟩. It concerns solution of problems of the type
 $$
     \min_{μ ∈ ℳ(Ω)}~ F(μ) + λ \|μ\|_{ℳ(Ω)} + δ_{≥ 0}(μ),
 $$
@@ -19,18 +19,18 @@
 
 ### Installing dependencies
 
-Most dependencies are managed by the Cargo build system of [Rust][]. You will
+Most dependencies are managed by the Cargo build system of [Rust]. You will
 only need to install the “nightly” Rust compiler and the
-[GNU Scientific Library][gsl] manually. At the time of writing this README,
-[alg_tools][] also needs to be downloaded separately.
+[GNU Scientific Library] manually. At the time of writing this README,
+[alg_tools] also needs to be downloaded separately.
 
-1.  Install the [Rust][] infrastructure (including Cargo) with [rustup][].
+1.  Install the [Rust] infrastructure (including Cargo) with [rustup].
 2.  Install a “nightly” release of the Rust compiler. With rustup, installed in
     the previous step, this can be done with
     ```console
     rustup toolchain install nightly
     ```
-3.  Install [GNU Scientific Library][gsl]. On a Mac with [Homebrew] installed,
+3.  Install [GNU Scientific Library]. On a Mac with [Homebrew] installed,
     this can be done with
     ```console
     brew install gsl
@@ -40,15 +40,16 @@
     On Windows, you will likely need to pass extra `RUSTFLAGS` options to
     Cargo in the following steps to locate the library.
 
-4. Download [alg_tools][] and unpack it under the same directory as this
+4. Download [alg_tools] and unpack it under the same directory as this
    package.
 
   [rustup]: https://rustup.rs
   [alg_tools]: https://tuomov.iki.fi/software/alg_tools/
   [Rust]: https://www.rust-lang.org/
-  [rust-GSL]: https://docs.rs/GSL/6.0.0/rgsl/
+  [GNU Scientific Library]: https://docs.rs/GSL/6.0.0/rgsl/
   [gsl]: https://www.gnu.org/software/gsl/
   [Homebrew]: https://brew.sh
+  [arXiv:2212.02991]: https://arxiv.org/abs/2212.02991
 
 ### Building and running the experiments
 
@@ -91,9 +92,7 @@
 misc/cargo-d --open    # build and open KaTeX-aware docs for this crate
 ```
 The `cargo-d` script ensures that KaTeX mathematics is rendered in the
-generated documentation. Unfortunately, `rustdoc`, akin to Rust largely itself,
-is stuck in 80's 7-bit gringo ASCII world, and does not support modern markdown
-features, such as mathematics. Instead, to render mathematics, an ugly
-workaround is needed together with lots of painful raw HTML escapes in the
-documentation.
+generated documentation through an ugly workaround. Unfortunately,
+`rustdoc`, akin to Rust largely itself, is stuck in 80's 7-bit gringo ASCII
+world, and does not support modern markdown features, such as mathematics.
 

--- a/src/fb.rs	Tue Dec 06 15:02:49 2022 +0200
+++ b/src/fb.rs	Wed Dec 07 06:54:56 2022 +0200
@@ -3,7 +3,8 @@
 
 This corresponds to the manuscript
 
- * Valkonen T. - _Proximal methods for point source localisation_. ARXIV TO INSERT.
+ * Valkonen T. - _Proximal methods for point source localisation_,
+   [arXiv:2212.02991](https://arxiv.org/abs/2212.02991).
 
 The main routine is [`pointsource_fb`]. It is based on [`generic_pointsource_fb`], which is also
 used by our [primal-dual proximal splitting][crate::pdps] implementation.

--- a/src/pdps.rs	Tue Dec 06 15:02:49 2022 +0200
+++ b/src/pdps.rs	Wed Dec 07 06:54:56 2022 +0200
@@ -3,7 +3,8 @@
 
 This corresponds to the manuscript
 
- * Valkonen T. - _Proximal methods for point source localisation_. ARXIV TO INSERT.
+ * Valkonen T. - _Proximal methods for point source localisation_,
+   [arXiv:2212.02991](https://arxiv.org/abs/2212.02991).
 
 The main routine is [`pointsource_pdps`]. It is based on specilisatinn of
 [`generic_pointsource_fb`] through relevant [`FBSpecialisation`] implementations.