rzmk/ladderz
1
0
Fork 0
mirror of https://github.com/rzmk/ladderz.git synced 2025-12-19 06:59:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: include subject description under Subjects in crate home page

Browse source
This commit is contained in:
rzmk 2023-09-21 17:06:31 -04:00
parent 515b174dd3
commit 857f1b03b9
No known key found for this signature in database
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
ladderz/src/lib.rs
View file

@ -2,11 +2,11 @@
//! //!
//! Implementations of mathematical and technical concepts in Rust. //! Implementations of mathematical and technical concepts in Rust.
//! //!
//! ## Subjects //! # Subjects
//! //!
//! The modules for currently supported subjects are: //! The modules for currently supported subjects are:
//! //!
//! - [`pre_algebra`] //! - [pre_algebra] - Various pre-algebra implementations including factor pairs, factors, multiples, and more.
//! //!
//! # Example //! # Example
//! //!
@ -93,20 +93,20 @@
//! Great! We've successfully used the `ladderz` crate to get the factors and factor pairs of a positive integer in sorted order. //! Great! We've successfully used the `ladderz` crate to get the factors and factor pairs of a positive integer in sorted order.
/// Various pre-algebra implementations including factor pairs, factors, multiples, and more. /// Various pre-algebra implementations including factor pairs, factors, multiples, and more.
/// ///
/// # Example /// # Example
/// ///
/// ```rust /// ```rust
/// use ladderz::pre_algebra::get_factors; /// use ladderz::pre_algebra::get_factors;
/// ///
/// fn main() { /// fn main() {
/// let x: u32 = 10; /// let x: u32 = 10;
/// println!("The factors of {x} are {:?}.", get_factors(x)); /// println!("The factors of {x} are {:?}.", get_factors(x));
/// } /// }
/// ``` /// ```
/// ///
/// ```console /// ```console
/// The factors of 10 are {1, 5, 2, 10}. /// The factors of 10 are {1, 5, 2, 10}.
/// ``` /// ```
/// ///
pub mod pre_algebra; pub mod pre_algebra;

4
ladderz/src/pre_algebra/unit1.rs
View file

@ -4,7 +4,7 @@ use std::collections::HashSet;
/// ///
/// A factor pair is a pair of positive integers /// A factor pair is a pair of positive integers
/// `(a, b)` where `a` and `b` are both factors of `n` (i.e., `a * b == n`). /// `(a, b)` where `a` and `b` are both factors of `n` (i.e., `a * b == n`).
/// ///
/// This function calculates and returns a `HashSet<(u32, u32)>` containing all unique factor pairs /// This function calculates and returns a `HashSet<(u32, u32)>` containing all unique factor pairs
/// of the input positive integer `n`. /// of the input positive integer `n`.
/// ///
@ -44,7 +44,7 @@ pub fn get_factor_pairs(n: u32) -> HashSet<(u32, u32)> {
} }
/// Finds all factors of a positive integer `n`. /// Finds all factors of a positive integer `n`.
/// ///
/// A factor of `n` is a positive integer `a` where /// A factor of `n` is a positive integer `a` where
/// `n` is evenly divisible by `a` (i.e., `n % a == 0`). /// `n` is evenly divisible by `a` (i.e., `n % a == 0`).
/// ///