xeos
/
num-traits
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixed some typos and added some examples

This commit is contained in:
Gulshan Singh 2015-01-20 18:52:18 -05:00
parent f186a5b71f
commit f1bfd76bbb
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/bigint.rs
View File

@ -860,7 +860,7 @@ impl FromStrRadix for BigUint {
impl BigUint { impl BigUint {
/// Creates and initializes a `BigUint`. /// Creates and initializes a `BigUint`.
/// ///
/// The digits are be in base 2^32. /// The digits are in little-endian base 2^32.
#[inline] #[inline]
pub fn new(mut digits: Vec<BigDigit>) -> BigUint { pub fn new(mut digits: Vec<BigDigit>) -> BigUint {
// omit trailing zeros // omit trailing zeros
@ -871,13 +871,23 @@ impl BigUint {
/// Creates and initializes a `BigUint`. /// Creates and initializes a `BigUint`.
/// ///
/// The digits are be in base 2^32. /// The digits are in little-endian base 2^32.
#[inline] #[inline]
pub fn from_slice(slice: &[BigDigit]) -> BigUint { pub fn from_slice(slice: &[BigDigit]) -> BigUint {
BigUint::new(slice.to_vec()) BigUint::new(slice.to_vec())
} }
/// Creates and initializes a `BigUint`. /// Creates and initializes a `BigUint`.
///
/// # Examples
///
/// ```
/// use num::bigint::{BigUint, ToBigUint};
///
/// assert_eq!(BigUint::parse_bytes("1234".as_bytes(), 10), ToBigUint::to_biguint(&1234));
/// assert_eq!(BigUint::parse_bytes("ABCD".as_bytes(), 16), ToBigUint::to_biguint(&0xABCD));
/// assert_eq!(BigUint::parse_bytes("G".as_bytes(), 16), None);
/// ```
#[inline] #[inline]
pub fn parse_bytes(buf: &[u8], radix: usize) -> Option<BigUint> { pub fn parse_bytes(buf: &[u8], radix: usize) -> Option<BigUint> {
str::from_utf8(buf).ok().and_then(|s| FromStrRadix::from_str_radix(s, radix)) str::from_utf8(buf).ok().and_then(|s| FromStrRadix::from_str_radix(s, radix))
@ -1553,7 +1563,7 @@ impl<R: Rng> RandBigInt for R {
impl BigInt { impl BigInt {
/// Creates and initializes a BigInt. /// Creates and initializes a BigInt.
/// ///
/// The digits are be in base 2^32. /// The digits are in little-endian base 2^32.
#[inline] #[inline]
pub fn new(sign: Sign, digits: Vec<BigDigit>) -> BigInt { pub fn new(sign: Sign, digits: Vec<BigDigit>) -> BigInt {
BigInt::from_biguint(sign, BigUint::new(digits)) BigInt::from_biguint(sign, BigUint::new(digits))
@ -1561,7 +1571,7 @@ impl BigInt {
/// Creates and initializes a `BigInt`. /// Creates and initializes a `BigInt`.
/// ///
/// The digits are be in base 2^32. /// The digits are in little-endian base 2^32.
#[inline] #[inline]
pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt { pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt {
if sign == NoSign || data.is_zero() { if sign == NoSign || data.is_zero() {
@ -1577,6 +1587,16 @@ impl BigInt {
} }
/// Creates and initializes a `BigInt`. /// Creates and initializes a `BigInt`.
///
/// # Examples
///
/// ```
/// use num::bigint::{BigInt, ToBigInt};
///
/// assert_eq!(BigInt::parse_bytes("1234".as_bytes(), 10), ToBigInt::to_bigint(&1234));
/// assert_eq!(BigInt::parse_bytes("ABCD".as_bytes(), 16), ToBigInt::to_bigint(&0xABCD));
/// assert_eq!(BigInt::parse_bytes("G".as_bytes(), 16), None);
/// ```
#[inline] #[inline]
pub fn parse_bytes(buf: &[u8], radix: usize) -> Option<BigInt> { pub fn parse_bytes(buf: &[u8], radix: usize) -> Option<BigInt> {
str::from_utf8(buf).ok().and_then(|s| FromStrRadix::from_str_radix(s, radix)) str::from_utf8(buf).ok().and_then(|s| FromStrRadix::from_str_radix(s, radix))