Mercurial > repos > alg_tools / changeset

--- a/README.md	Wed Dec 07 07:00:27 2022 +0200
+++ b/README.md	Wed Dec 07 09:19:21 2022 +0200
@@ -1,9 +1,9 @@
 
-# AlgTools
+# alg_tools
 
 This package contains some general utility routines and tools for implementing
-iterative algorithms and (abstract) numerical computing in Rust. Former versions
-of the package were for Julia. They are no longer mintained. Included are:
+iterative algorithms and (abstract) numerical computing in [Rust]. Former versions
+of the package were for Julia. They are no longer maintained. Included are:
 
   * [Linear operator], [mapping], [Euclidean space], and [norm] abstractions.
     Matrices and vectors are supported via [nalgebra].
@@ -16,7 +16,7 @@
     intermittent verbosity and stopping rules in iterative algorithms.
   * The algorithm iterators can employ a [logger] to store intermittent results
     (e.g. function values) in memory to later [write] into a csv-file.
-  * Additional [iterators and iteration tools][], especially variants of `map`
+  * Additional [iterators and iteration tools], especially variants of `map`
     with predictable type signatures.
   * The `Float` and [associated traits] build upon [num_traits] to
     conveniently write code that works with any floating point number type.
@@ -31,15 +31,14 @@
 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.
 
 
-
+  [Rust]: https://www.rust-lang.org
   [nalgebra]: https://www.nalgebra.org
+  [num_traits]: https://docs.rs/num-traits/latest/num_traits/
   [norm]: crate::norms
   [linear grids]: crate::lingrid
   [Euclidean space]: crate::euclidean
@@ -56,6 +55,5 @@
   [mapping]: crate::mapping::Mapping
   [associated traits]: crate::types
   [vectors]: crate::loc::Loc
-  [num_traits]: num_traits
   [cubes]: crate::sets::Cube