Skip to content

Commit 7589127

Browse files
committed
Document BigInt's new and from_slice methods
Fixes #14639
1 parent 7d07a1e commit 7589127

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/libnum/bigint.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,8 @@ impl FromStrRadix for BigUint {
653653

654654
impl BigUint {
655655
/// Creates and initializes a `BigUint`.
656+
///
657+
/// The digits are be in base 2^32.
656658
#[inline]
657659
pub fn new(v: Vec<BigDigit>) -> BigUint {
658660
// omit trailing zeros
@@ -665,6 +667,8 @@ impl BigUint {
665667
}
666668

667669
/// Creates and initializes a `BigUint`.
670+
///
671+
/// The digits are be in base 2^32.
668672
#[inline]
669673
pub fn from_slice(slice: &[BigDigit]) -> BigUint {
670674
return BigUint::new(Vec::from_slice(slice));
@@ -1315,12 +1319,16 @@ impl<R: Rng> RandBigInt for R {
13151319

13161320
impl BigInt {
13171321
/// Creates and initializes a BigInt.
1322+
///
1323+
/// The digits are be in base 2^32.
13181324
#[inline]
13191325
pub fn new(sign: Sign, v: Vec<BigDigit>) -> BigInt {
13201326
BigInt::from_biguint(sign, BigUint::new(v))
13211327
}
13221328

13231329
/// Creates and initializes a `BigInt`.
1330+
///
1331+
/// The digits are be in base 2^32.
13241332
#[inline]
13251333
pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt {
13261334
if sign == Zero || data.is_zero() {

0 commit comments

Comments
 (0)