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 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
// Copyright © 2016–2017 University of Malta // This program is free software: you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public License // as published by the Free Software Foundation, either version 3 of // the License, or (at your option) any later version. // // This program is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License and a copy of the GNU General Public License along with // this program. If not, see <http://www.gnu.org/licenses/>. //! # Arbitrary-precision numbers //! //! The `rug` crate provides integers and floating-point numbers with //! arbitrary precision and correct rounding. Its main features are: //! //! * big [integers][rug int] with arbitrary precision, //! * big [rational numbers][rug rat] with arbitrary precision, //! * multi-precision [floating-point numbers][rug flo] with correct //! rounding, and //! * multi-precision [complex numbers][rug com] with correct //! rounding. //! //! This crate is free software: you can redistribute it and/or modify //! it under the terms of the GNU Lesser General Public License as //! published by the Free Software Foundation, either version 3 of the //! License, or (at your option) any later version. See the full text //! of the [GNU LGPL][lgpl] and [GNU GPL][gpl] for details. //! //! ## Basic use //! //! This crate depends on the low-level bindings in the //! [`gmp-mpfr-sys`][sys] crate, which provides Rust FFI bindings for: //! //! * the [GNU Multiple Precision Arithmetic Library][gmp] (GMP), //! * the [GNU MPFR Library][mpfr], a library for multiple-precision //! floating-point computations, and //! * [GNU MPC][mpc], a library for the arithmetic of complex numbers //! with arbitrarily high precision. //! //! It can be helpful to refer to the documentation of the //! [GMP][gmp doc], [MPFR][mpfr doc] and [MPC][mpc doc] libraries. //! //! ## Examples //! //! ```rust //! extern crate rug; //! # #[cfg(feature = "integer")] //! use rug::{Assign, Integer}; //! //! fn main() { //! # #[cfg(feature = "integer")] { //! // Create an integer initialized as zero. //! let mut int = Integer::new(); //! assert_eq!(int, 0); //! int.assign(14); //! assert_eq!(int, 14); //! let hex_160 = "ffff0000ffff0000ffff0000ffff0000ffff0000"; //! int.assign_str_radix(hex_160, 16).unwrap(); //! assert_eq!(int.significant_bits(), 160); //! int = (int >> 128) - 1; //! assert_eq!(int, 0xfffe_ffff_u32); //! # } //! } //! ``` //! //! ## Usage //! //! To use `rug` in your crate, add `extern crate rug;` to the crate //! root and add `rug` as a dependency in `Cargo.toml`: //! //! ```toml //! [dependencies] //! rug = "0.7.0" //! ``` //! //! The `rug` crate depends on the low-level bindings in the //! [`gmp-mpfr-sys`][sys] crate. This should be transparent on //! GNU/Linux and macOS, but may need some work on Windows. See the //! [`gmp-mpfr-sys`][sys] documentation for some details. //! //! ### Optional features //! //! The `rug` crate has five optional features: `integer`, `rational`, //! `float`, `complex` and `rand`. The traits in the [`ops`][rug ops] //! module are always included. The optional features are enabled by //! default; to disable them add this to `Cargo.toml`: //! //! ```toml //! [dependencies.rug] //! version = "0.7.0" //! default-features = false //! ``` //! //! If no optional features are selected, the [`gmp-mpfr-sys`][sys] //! crate is not required and thus not enabled. //! //! To use features selectively, you can add this to `Cargo.toml`: //! //! ```toml //! [dependencies.rug] //! version = "0.7.0" //! default-features = false //! # Pick which features to use //! features = ["integer", "float", "rand"] //! ``` //! //! Note that both the `rational` feature and the `rand` feature //! depend on, and will enable, the `integer` feature. Similarly the //! `complex` feature depends on, and will enable, the `float` //! feature. //! //! [gmp doc]: https://tspiteri.gitlab.io/gmp-mpfr-sys/gmp/index.html //! [gmp]: https://gmplib.org/ //! [gpl]: https://www.gnu.org/licenses/gpl-3.0.html //! [lgpl]: https://www.gnu.org/licenses/lgpl-3.0.en.html //! [mpc doc]: https://tspiteri.gitlab.io/gmp-mpfr-sys/mpc/index.html //! [mpc]: http://www.multiprecision.org/ //! [mpfr doc]: https://tspiteri.gitlab.io/gmp-mpfr-sys/mpfr/index.html //! [mpfr]: http://www.mpfr.org/ //! [rug com]: struct.Complex.html //! [rug flo]: struct.Float.html //! [rug int]: struct.Integer.html //! [rug ops]: ops/index.html //! [rug rat]: struct.Rational.html //! [sys]: https://docs.rs/gmp-mpfr-sys/~1.0.6/ #![warn(missing_docs)] #![doc(html_root_url = "https://docs.rs/rug/0.7.0/")] #![doc(test(attr(deny(warnings))))] #[cfg(any(feature = "integer", feature = "float"))] extern crate gmp_mpfr_sys; #[macro_use] mod macros; mod ext; mod inner; /// Assigns to a number from another value. /// /// # Examples /// /// ```rust /// use rug::Assign; /// struct I(i32); /// impl Assign<i16> for I { /// fn assign(&mut self, rhs: i16) { /// self.0 = rhs as i32; /// } /// } /// let mut i = I(0); /// i.assign(42_i16); /// assert_eq!(i.0, 42); /// ``` pub trait Assign<Rhs = Self> { /// Peforms the assignement. /// /// # Examples /// /// ```rust /// # #[cfg(feature = "integer")] { /// use rug::{Assign, Integer}; /// let mut i = Integer::from(15); /// assert_eq!(i, 15); /// i.assign(23); /// assert_eq!(i, 23); /// # } /// ``` fn assign(&mut self, rhs: Rhs); } /// Assignment with a specified rounding method. /// /// # Examples /// /// ```rust /// # #[cfg(feature = "float")] { /// use rug::AssignRound; /// use rug::float::Round; /// use std::cmp::Ordering; /// struct F(f64); /// impl AssignRound<f64> for F { /// type Round = Round; /// type Ordering = Ordering; /// fn assign_round(&mut self, rhs: f64, _round: Round) -> Ordering { /// self.0 = rhs; /// Ordering::Equal /// } /// } /// let mut f = F(3.0); /// let dir = f.assign_round(5.0, Round::Nearest); /// assert_eq!(f.0, 5.0); /// assert_eq!(dir, Ordering::Equal); /// # } pub trait AssignRound<Rhs = Self> { /// The rounding method. type Round; /// The direction from rounding. type Ordering; /// Peforms the assignment. /// /// # Examples /// /// ```rust /// # #[cfg(feature = "float")] { /// use rug::{AssignRound, Float}; /// use rug::float::Round; /// use std::cmp::Ordering; /// // only four significant bits /// let mut f = Float::new(4); /// let dir = f.assign_round(3.3, Round::Nearest); /// // 3.3 rounded down to 3.25 /// assert_eq!(f, 3.25); /// assert_eq!(dir, Ordering::Less); /// let dir = f.assign_round(3.3, Round::Up); /// // 3.3 rounded up to 3.5 /// assert_eq!(f, 3.5); /// assert_eq!(dir, Ordering::Greater); /// # } /// ``` fn assign_round(&mut self, rhs: Rhs, round: Self::Round) -> Self::Ordering; } pub mod ops; #[cfg(feature = "integer")] mod big_integer; #[cfg(feature = "integer")] pub use big_integer::Integer; #[cfg(feature = "integer")] pub mod integer; #[cfg(feature = "rational")] mod big_rational; #[cfg(feature = "rational")] pub use big_rational::Rational; #[cfg(feature = "rational")] pub mod rational; #[cfg(feature = "float")] mod big_float; #[cfg(feature = "float")] pub use big_float::Float; #[cfg(feature = "float")] pub mod float; #[cfg(feature = "complex")] mod big_complex; #[cfg(feature = "complex")] pub use big_complex::Complex; #[cfg(feature = "complex")] pub mod complex; #[cfg(feature = "rand")] pub mod rand;