Skip to content

Commit df6434b

Browse files
committed
Add summary & status text to docs
1 parent fa868d7 commit df6434b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
//! The **ndarray** crate provides the [**Array**](./struct.Array.html) type, an
55
//! n-dimensional container similar to numpy's ndarray.
66
//!
7+
//! ## Crate Summary and Status
8+
//!
9+
//! - Implements the numpy striding scheme for n-dimensional arrays
10+
//! - `Array` is clone on write, so it can be both a view or an owner of the
11+
//! data.
12+
//! - Striding and broadcasting is fully implemented
13+
//! - Due to iterators, arithmetic operations, matrix multiplication etc
14+
//! are not very well optimized, this is not a serious crate for numerics
15+
//! or linear algebra. `Array` is a good container.
16+
//! - There is no integration with linear algebra packages (at least not yet).
17+
//!
718
819
#[cfg(feature = "serde")]
920
extern crate serde;

0 commit comments

Comments
 (0)