Skip to content

Commit 14cf910

Browse files
Add a section on the ecosystem
1 parent fc0d887 commit 14cf910

File tree

1 file changed

+12
-3
lines changed
  • src/doc/ndarray_for_numpy_users

1 file changed

+12
-3
lines changed

src/doc/ndarray_for_numpy_users/mod.rs

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
//!
1010
//! * [Similarities](#similarities)
1111
//! * [Some key differences](#some-key-differences)
12+
//! * [The ndarray ecosystem](#the-ndarray-ecosystem)
1213
//! * [Other Rust array/matrix crates](#other-rust-arraymatrix-crates)
1314
//! * [Rough `ndarray`–NumPy equivalents](#rough-ndarraynumpy-equivalents)
1415
//!
@@ -116,6 +117,17 @@
116117
//! </tr>
117118
//! </table>
118119
//!
120+
//! # The ndarray ecosystem
121+
//!
122+
//! `ndarray` does not provide advanced linear algebra routines out of the box (e.g. SVD decomposition).
123+
//! Most of the routines that you can find in `SciPy.linalg`/`NumPy.linalg` are provided by another crate,
124+
//! [`ndarray-linalg`](https://crates.io/crates/ndarray-linalg).
125+
//!
126+
//! The same holds for statistics: `ndarray` provides some basic functionalities (e.g. `mean`)
127+
//! but more advanced routines can be found in [`ndarray-stats`](https://crates.io/crates/ndarray-stats).
128+
//!
129+
//! If you are looking to generate random arrays instead, check out [`ndarray-rand`](https://crates.io/crates/ndarray-rand).
130+
//!
119131
//! # Other Rust array/matrix crates
120132
//!
121133
//! Of the array/matrix types in Rust crates, the `ndarray` array type is probably
@@ -147,9 +159,6 @@
147159
//! elementwise multiplication instead of matrix multiplication. (You have to
148160
//! specifically call `.dot()` if you want matrix multiplication.)
149161
//!
150-
//! Linear algebra with `ndarray` is provided by another crates,
151-
//! [`ndarray-linalg`](https://crates.io/crates/ndarray-linalg).
152-
//!
153162
//! # Rough `ndarray`–NumPy equivalents
154163
//!
155164
//! These tables provide some rough equivalents of NumPy operations in `ndarray`.

0 commit comments

Comments
 (0)