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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
//! Gulali is an easy-to-use fundamental library for scientific computing with //! Rust, highly inspired by [NumPy]. //! //! [NumPy]: http://www.numpy.org/ //! //! //! ## Usage //! Add this to your `Cargo.toml`: //! //! ```toml //! [dependencies] //! gulali = "2019.3.4" //! ``` //! //! and this to your crate root: //! //! ```rust //! extern crate gulali; //! //! // Import all required traits //! use gulali::prelude::*; //! ``` //! //! To get started using Gulali, read the quickstart tutorial below. //! //! ## Quickstart Tutorial //! //! ### Prerequisites //! Before reading this quick tutorial you should know a bit of Rust. //! If you would like to refresh your memory, take a look at the //! [Rust book]. //! //! [Rust book]: https://doc.rust-lang.org/book/ //! //! ### The Basics //! Gulali's main data type is the homogeneous multidimensional [vector]. //! It is a table of elements (usually numbers), all of the same type, //! indexed by a tuple of positive integers. //! //! [vector]: https://doc.rust-lang.org/std/vec/struct.Vec.html //! //! For example, the coordinates of a point in 3D space `[1, 2, 1]` has //! one dimension. That dimension has 3 elements in it, so we say //! it has a length of 3. In the example pictured below, //! the vector has 2 dimensions. The first dimension has a length of 2, //! the second dimension has a length of 3. //! //! ```ignore //! [ //! [ 1., 0., 0.], //! [ 0., 1., 2.] //! ] //! ``` //! //! Gulali uses Rust's [vector] standard data type extensively. We don't reinvent //! yet-another data type to keep things simple and easy to use. //! Gulali added useful attributes for Rust's vector like //! the following: //! //! - [dim]: the number of dimensions of the vector. //! - [shape]: This is a list of integers indicating the //! size of the vector in each dimension. //! For a matrix with `n` rows and `m` columns, shape will be `[n,m]`. //! The length of the shape is therefore the number of //! dimensions, `dim()`. //! - [size]: the total number of elements of the vector. //! This is equal to the product of the elements of shape. //! //! [slice]: https://doc.rust-lang.org/rust-by-example/primitives/array.html //! [dim]: trait.Dimension.html //! [shape]: trait.Shape.html //! [size]: trait.Size.html //! //! ### An Example //! ```rust //! # use gulali::prelude::*; //! // Create two-dimensional vector with shape [3, 3] //! // filled with zeros //! let matrix: Vec<Vec<i32>> = Vec::two_dim(3, 3).zeros(); //! //! assert_eq!(matrix.dim(), 2); //! assert_eq!(matrix.shape(), [3, 3]); //! assert_eq!(matrix.size(), 9); //! ``` //! //! ### Vector Creation //! There are several ways to create vectors. //! //! For example, you can create a vector using [`vec!`][vec!] macro //! like the following: //! //! ```rust //! # use gulali::prelude::*; //! let a = vec![1, 2, 3]; //! assert_eq!(a.dim(), 1); //! assert_eq!(a.shape(), [3]); //! assert_eq!(a.size(), 3); //! //! let b = vec![ //! vec![1, 2, 3], //! vec![4, 5, 6], //! vec![8, 9, 10], //! ]; //! assert_eq!(b.dim(), 2); //! assert_eq!(b.shape(), [3, 3]); //! assert_eq!(b.size(), 9); //! ``` //! //! [vec!]: https://doc.rust-lang.org/std/macro.vec.html //! //! The type of the resulting vector is deduced from the type //! of the elements in the macro. //! //! Often, the elements of a vector are originally unknown, but //! its shape is known. Hence, Gulali offers several functions to //! create vectors with initial placeholder content. These minimize //! the necessity of growing vectors, an expensive operation. //! //! The function [`zeros`][zeros] creates a vector full of zeros, //! and the function [`ones`][ones] creates a vector full of ones. //! //! [zeros]: trait.Zero.html //! [ones]: trait.One.html //! // TODO: ADD `rand()`, keyg //! //! ```rust //! # use gulali::prelude::*; //! // Create two-dimensional vector with shape [3, 3] //! // filled with zeros //! let a: Vec<Vec<i32>> = Vec::two_dim(3, 3).zeros(); //! assert_eq!(a, [[0, 0, 0], [0, 0, 0], [0, 0, 0]]); //! //! // Create three-dimensional vector with shape [1, 1, 3] //! // filled with ones //! let b: Vec<Vec<Vec<f64>>> = Vec::three_dim(1, 1, 3).ones(); //! assert_eq!(b, [[[1.0, 1.0, 1.0]]]); //! ``` //! //! ## Getting help //! Feel free to start discussion at [GitHub issues]. //! //! [Github issues]: https://github.com/pyk/gulali/issues/new/choose //! //! ## License //! Gulali is licensed under the BSD 3-Clause license. //! // Vector builders pub mod builders; // Vector properties pub mod properties; pub mod prelude; // pub use prelude;