polymath 0.3.1

Make math in Rust more powerful! (New math datatypes, traits, functions, etc...)
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
39
40
41
42
43

mod types;
mod traits;

#[derive(Debug, Eq, PartialEq, PartialOrd, Ord, Clone, Hash)]
pub struct PolymathError {
    pub error_kind: PolymathErrorKind,
    pub error: String,
}

impl PolymathError {
    /// Create a new Polymath error
    pub fn new(error_kind: PolymathErrorKind, error: &str) -> Self {
        return Self { error_kind, error: error.to_string() };
    }

    /// Same as PolymathError::new(), with the error kind auto set to: Other
    ///
    /// # Examples:
    /// ```rust
    /// use polymath::{PolymathError, PolymathErrorKind};
    ///
    /// fn main() {
    ///     let error1 = PolymathError::new(PolymathErrorKind::Other, "This is an error!");
    ///     let error2 = PolymathError::other("This is an error!");
    ///
    ///     assert!(error1 == error2);
    /// }
    /// ```
    pub fn other(error: &str) -> Self {
        return Self::new(PolymathErrorKind::Other, error);
    }
}

#[derive(Debug, Eq, PartialEq, PartialOrd, Ord, Clone, Hash)]
pub enum PolymathErrorKind {
    Other,
    OutOfBounds,
}

pub mod prelude {
    pub use super::types::*;
    pub use super::traits::*;
}