# lib.rs - source
Source of the Rust file `src/lib.rs`.

    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

    //! # ladderz
    //!
    //! Implementations of mathematical and technical concepts in Rust.
    //!
    //! # Installing the crate
    //!
    //! To add the crate to your project, add the following dependency under your `[dependencies]` section in your `Cargo.toml`:
    //!
    //! ```toml
    //! ladderz = { git = "https://github.com/rzmk/ladderz", branch = "main" }
    //! ```
    //!
    //! # Example
    //!
    //! ```rust
    //!use ladderz::pre_algebra::get_factors;
    //!
    //!let x: u32 = 10;
    //!println!("The factors of {x} are {:?}.", get_factors(x));
    //! ```
    //!
    //! ```console
    //! The factors of 10 are {1, 5, 2, 10}.
    //! ```
    //!
    //! For a more detailed example of how to use the `ladderz` crate, please see the [example on GitHub](https://github.com/rzmk/ladderz#example).
    //!
    //! Choose a module to view its available functions.

    /// Various pre-algebra implementations including factor pairs, factors, multiples, and more.
    ///
    /// # Example
    ///
    /// ```rust
    /// use ladderz::pre_algebra::get_factors;
    ///
    /// let x: u32 = 10;
    /// println!("The factors of {x} are {:?}.", get_factors(x));
    /// ```
    ///
    /// ```console
    /// The factors of 10 are {1, 5, 2, 10}.
    /// ```
    ///
    pub mod pre_algebra;