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.
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.
13 //! This crate contains arbitrary-sized integer, rational, and complex types.
17 //! This example uses the BigRational type and [Newton's method][newt] to
18 //! approximate a square root to arbitrary precision:
23 //! use num::bigint::BigInt;
24 //! use num::rational::{Ratio, BigRational};
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();
30 //! for _ in range(0, iterations) {
31 //! approx = (approx + (start / approx)) /
32 //! Ratio::from_integer(FromPrimitive::from_u64(2).unwrap());
39 //! println!("{}", approx_sqrt(10, 4)); // prints 4057691201/1283082416
43 //! [newt]: https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method
45 #![feature(macro_rules)]
47 #![crate_name = "num"]
49 #![crate_type = "rlib"]
50 #![crate_type = "dylib"]
51 #![license = "MIT/ASL2"]
52 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
53 html_favicon_url = "http://www.rust-lang.org/favicon.ico",
54 html_root_url = "http://doc.rust-lang.org/0.11.0/",
55 html_playground_url = "http://play.rust-lang.org/")]
56 #![allow(deprecated)] // from_str_radix
60 pub use bigint::{BigInt, BigUint};
61 pub use rational::{Rational, BigRational};
62 pub use complex::Complex;
63 pub use integer::Integer;