ndarray/
prelude.rs

1// Copyright 2016 bluss and ndarray developers.
2//
3// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
4// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
5// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
6// option. This file may not be copied, modified, or distributed
7// except according to those terms.
8
9//! ndarray prelude.
10//!
11//! This module contains the most used types, type aliases, traits, functions,
12//! and macros that you can import easily as a group.
13//!
14//! ```
15//! use ndarray::prelude::*;
16//!
17//! # let _ = arr0(1); // use the import
18//! ```
19
20#[doc(no_inline)]
21pub use crate::{
22    ArcArray,
23    Array,
24    ArrayBase,
25    ArrayRef,
26    ArrayView,
27    ArrayViewMut,
28    CowArray,
29    LayoutRef,
30    RawArrayView,
31    RawArrayViewMut,
32    RawRef,
33};
34
35#[doc(no_inline)]
36pub use crate::{Axis, Dim, Dimension};
37
38#[doc(no_inline)]
39pub use crate::{ArrayRef0, ArrayRef1, ArrayRef2, ArrayRef3, ArrayRef4, ArrayRef5, ArrayRef6, ArrayRefD};
40
41#[doc(no_inline)]
42pub use crate::{Array0, Array1, Array2, Array3, Array4, Array5, Array6, ArrayD};
43
44#[doc(no_inline)]
45pub use crate::{ArrayView0, ArrayView1, ArrayView2, ArrayView3, ArrayView4, ArrayView5, ArrayView6, ArrayViewD};
46
47#[doc(no_inline)]
48pub use crate::{
49    ArrayViewMut0,
50    ArrayViewMut1,
51    ArrayViewMut2,
52    ArrayViewMut3,
53    ArrayViewMut4,
54    ArrayViewMut5,
55    ArrayViewMut6,
56    ArrayViewMutD,
57};
58
59#[doc(no_inline)]
60pub use crate::{Ix0, Ix1, Ix2, Ix3, Ix4, Ix5, Ix6, IxDyn};
61
62#[doc(no_inline)]
63pub use crate::{arr0, arr1, arr2, aview0, aview1, aview2, aview_mut1};
64
65pub use crate::{array, azip, s};
66
67#[doc(no_inline)]
68pub use crate::ShapeBuilder;
69
70#[doc(no_inline)]
71pub use crate::NewAxis;
72
73#[doc(no_inline)]
74pub use crate::AsArray;
75
76#[doc(no_inline)]
77#[cfg(feature = "std")]
78pub use crate::NdFloat;
ndarray/prelude.rs

ndarray/
prelude.rs
