src/libnum/lib.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Simple numerics.
  12 //!
  13 //! This crate contains arbitrary-sized integer, rational, and complex types.
  14 //!
  15 //! ## Example
  16 //!
  17 //! This example uses the BigRational type and [Newton's method][newt] to
  18 //! approximate a square root to arbitrary precision:
  19 //!
  20 //! ```
  21 //! extern crate num;
  22 //!
  23 //! use num::bigint::BigInt;
  24 //! use num::rational::{Ratio, BigRational};
  25 //!
  26 //! fn approx_sqrt(number: u64, iterations: uint) -> BigRational {
  27 //!     let start: Ratio<BigInt> = Ratio::from_integer(FromPrimitive::from_u64(number).unwrap());
  28 //!     let mut approx = start.clone();
  29 //!
  30 //!     for _ in range(0, iterations) {
  31 //!         approx = (approx + (start / approx)) /
  32 //!             Ratio::from_integer(FromPrimitive::from_u64(2).unwrap());
  33 //!     }
  34 //!
  35 //!     approx
  36 //! }
  37 //!
  38 //! fn main() {
  39 //!     println!("{}", approx_sqrt(10, 4)); // prints 4057691201/1283082416
  40 //! }
  41 //! ```
  42 //!
  43 //! [newt]: https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method
  44
  45 #![feature(macro_rules)]
  46
  47 #![crate_id = "num#0.11.0"] // NOTE: remove after stage0
  48 #![crate_name = "num"]
  49 #![experimental]
  50 #![crate_type = "rlib"]
  51 #![crate_type = "dylib"]
  52 #![license = "MIT/ASL2"]
  53 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  54        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
  55        html_root_url = "http://doc.rust-lang.org/0.11.0/",
  56        html_playground_url = "http://play.rust-lang.org/")]
  57 #![allow(unused_attribute)] // NOTE: remove after stage0
  58 #![allow(deprecated)] // from_str_radix
  59
  60 extern crate rand;
  61
  62 pub use bigint::{BigInt, BigUint};
  63 pub use rational::{Rational, BigRational};
  64 pub use complex::Complex;
  65 pub use integer::Integer;
  66
  67 pub mod bigint;
  68 pub mod complex;
  69 pub mod integer;
  70 pub mod rational;