ndtensor 0.1.1

An n-dimensional tensor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

/*
    Appellation: ndtensor <library>
    Contrib: @FL03
*/
//! # ndtensor
//!
//! Welcome to the `ndtensor` crate, a powerful N-dimensional tensor library for Rust.
//!
//! ### Features
//!
//! The crate supports various extensions or integrations that enhance its functionality. These
//! features can be enabled in your `Cargo.toml` file by specifying them under the `features`
//! section. Here are some of the available features:
//!
//! - `anyhow`: Enables the use of the `anyhow` crate for error handling.
//! - `approx`: Enables approximate equality checks for floating-point numbers.
//! - `complex`: Enables complex number support.
//! - `json`: Enables JSON serialization and deserialization capabilities.
//! - `rand`: Enables random number generation capabilities.
//! - `serde`: Enables serialization and deserialization capabilities.
//! - `tracing`: Enables tracing capabilities for debugging and logging.
//!
#![allow(
    clippy::missing_safety_doc,
    clippy::module_inception,
    clippy::needless_doctest_main,
    clippy::upper_case_acronyms
)]
#![cfg_attr(not(feature = "std"), no_std)]
#![crate_type = "lib"]

#[cfg(not(all(feature = "std", feature = "alloc")))]
compiler_error! {
    "\
        Either the `std` or `alloc` feature must be enabled. 
        Please enable one of them in your Cargo.toml file.
    "
}

#[macro_use]
pub(crate) mod macros {
    #[macro_use]
    pub mod seal;
}

#[cfg(feature = "alloc")]
extern crate alloc;

#[doc(inline)]
pub use self::{error::*, tensor::*, traits::*, types::*};

/// this module defines the [`TensorError`] enum for handling tensor-related errors
pub mod error;
/// this module defines various iterators for the [`TensorBase`]
pub mod iter;

mod tensor;

mod impls {
    mod impl_tensor;
    mod impl_tensor_iter;
    mod impl_tensor_ops;
    mod impl_tensor_repr;

    #[allow(deprecated)]
    mod impl_tensor_deprecated;
    #[cfg(feature = "rand")]
    mod impl_tensor_rand;
    #[cfg(feature = "serde")]
    mod impl_tensor_serde;
}

mod traits {
    //! this module provides additional traits for the `tensor` module
    #[doc(inline)]
    pub use self::prelude::*;

    mod ops;
    mod raw_tensor;
    mod scalar;

    mod prelude {
        #[doc(inline)]
        pub use super::ops::*;
        #[doc(inline)]
        pub use super::raw_tensor::*;
        #[doc(inline)]
        pub use super::scalar::*;
    }
}

mod types {
    //! this module defines various type aliases and primitives used by the `tensor` module
    #[doc(inline)]
    pub use self::prelude::*;

    mod aliases;

    mod prelude {
        #[doc(inline)]
        pub use super::aliases::*;
    }
}

#[doc(hidden)]
pub mod prelude {
    #[doc(inline)]
    pub use super::tensor::*;
    #[doc(inline)]
    pub use super::traits::*;
    #[doc(inline)]
    pub use super::types::*;
}