| 3 |
3 |
| 4 This package contains some general utility routines and tools for implementing |
4 This package contains some general utility routines and tools for implementing |
| 5 iterative algorithms and (abstract) numerical computing in Rust. Former versions |
5 iterative algorithms and (abstract) numerical computing in Rust. Former versions |
| 6 of the package were for Julia. They are no longer mintained. Included are: |
6 of the package were for Julia. They are no longer mintained. Included are: |
| 7 |
7 |
| 8 * [Linear operator][], [mapping][], [Euclidean space][], and [norm][] |
8 * [Linear operator], [mapping], [Euclidean space], and [norm] abstractions. |
| 9 abstractions. Matrices and vectors are supported via [nalgebra]. |
9 Matrices and vectors are supported via [nalgebra]. |
| 10 There is also abstraction for [`AXPY`][AXPY] and [`GEMV`][GEMV] operations. |
10 There is also abstraction for [`AXPY`][AXPY] and [`GEMV`][GEMV] operations. |
| 11 * Small (on stack) [vectors][] and [cubes][] that implement the relevant |
11 * Small (on stack) [vectors] and [cubes] that implement the relevant |
| 12 abstractions and vector space operations. |
12 abstractions and vector space operations. |
| 13 * Multi-dimensional [linear grids][], including the familiar-from-Matlab |
13 * Multi-dimensional [linear grids], including the familiar-from-Matlab |
| 14 one-dimensional [`linspace`][linspace]. |
14 one-dimensional [`linspace`][linspace]. |
| 15 * [Algorithm iterator abstraction][] for generically implementing |
15 * [Algorithm iterator abstraction] for generically implementing |
| 16 intermittent verbosity and stopping rules in iterative algorithms. |
16 intermittent verbosity and stopping rules in iterative algorithms. |
| 17 * The algorithm iterators can employ a [logger][] to store intermittent results |
17 * The algorithm iterators can employ a [logger] to store intermittent results |
| 18 (e.g. function values) in memory to later [write][] into a csv-file. |
18 (e.g. function values) in memory to later [write] into a csv-file. |
| 19 * Additional [iterators and iteration tools][], especially variants of `map` |
19 * Additional [iterators and iteration tools][], especially variants of `map` |
| 20 with predictable type signatures. |
20 with predictable type signatures. |
| 21 * The `Float` and [associated traits][] build upon [num_traits][] to |
21 * The `Float` and [associated traits] build upon [num_traits] to |
| 22 conveniently write code that works with any floating point number type. |
22 conveniently write code that works with any floating point number type. |
| 23 * Geometrical [bisection trees][] for efficient representations of sums of |
23 * Geometrical [bisection trees] for efficient representations of sums of |
| 24 functions and branch-and-bound optimisation. |
24 functions and branch-and-bound optimisation. |
| 25 |
25 |
| 26 ## Building the documentation |
26 ## Building the documentation |
| 27 |
27 |
| 28 Integrated source code documentation may be built and opened with |
28 Integrated source code documentation may be built and opened with |