magnus167/rustframe
1
0
Fork 0
mirror of https://github.com/Magnus167/rustframe.git synced 2025-11-21 07:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhance documentation with usage examples for boolean and series operations

Browse Source
This commit is contained in:
Palash Tyagi
2025-08-03 16:45:30 +01:00
parent f7325a9558
commit 676f78bb1e
3 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/matrix/mod.rs
View File

@@ -1,3 +1,18 @@
//! Core matrix types and operations.
//!
//! The [`Matrix`](crate::matrix::Matrix) struct provides a simple column‑major 2D array with a
//! suite of numeric helpers. Additional traits like [`SeriesOps`](crate::matrix::SeriesOps) and
//! [`BoolOps`](crate::matrix::BoolOps) extend functionality for common statistics and logical reductions.
//!
//! # Examples
//!
//! ```
//! use rustframe::matrix::Matrix;
//!
//! let m = Matrix::from_cols(vec![vec![1, 2], vec![3, 4]]);
//! assert_eq!(m.shape(), (2, 2));
//! assert_eq!(m[(0,1)], 3);
//! ```
pub mod boolops;
pub mod mat;
pub mod seriesops;