bth_crust 0.1.0

A library for basic mathematical operations.
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

//! # BTH_Crust
//!
//! `bth_crust` is a collection of utilities to make performing certain
//! mathematical operations more convenient.

pub use self::operations::add;
pub use self::operations::sub;

pub mod operations {

    /// Add two numbers together
    ///
    /// ```
    /// let x = 3;
    /// let y = 5;
    ///
    /// let result = bth_crust::add(x, y);
    ///
    /// assert_eq!(result, 8);
    /// ```
    pub fn add(x: i32, y: i32) -> i32 {
        x + y
    }

    /// Subtract two numbers together
    ///
    /// ```
    /// let x = 5;
    /// let y = 3;
    ///
    /// let result = bth_crust::sub(x, y);
    ///
    /// assert_eq!(result, 2);
    /// ```
    pub fn sub(x: i32, y: i32) -> i32 {
        x - y
    }
}