Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › math › big › int › Mutable › sqrt Public Function sqrt Doc Source Public Function std.math.big.int.Mutable.sqrt
pub fn sqrt (
r : *Mutable ,
a : Const ,
limbs_buffer : []Limb ,
) void Params File math/big/int.zig: 1592
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639 pub fn sqrt (
r : *Mutable ,
a : Const ,
limbs_buffer : []Limb ,
) void {
// Brent and Zimmermann, Modern Computer Arithmetic, Algorithm 1.13 SqrtInt
// https://members.loria.fr/PZimmermann/mca/pub226.html
var buf_index : usize = 0 ;
var t = b : {
const start = buf_index ;
buf_index += a .limbs .len ;
break :b Mutable .init (limbs_buffer [start ..buf_index ], 0 );
};
var u = b : {
const start = buf_index ;
const shift = (a .bitCountAbs () + 1 ) / 2 ;
buf_index += 1 + ((shift / limb_bits ) + 1 );
var m = Mutable .init (limbs_buffer [start ..buf_index ], 1 );
m .shiftLeft (m .toConst (), shift ); // u must be >= ⌊√a⌋, and should be as small as possible for efficiency
break :b m ;
};
var s = b : {
const start = buf_index ;
buf_index += u .limbs .len ;
break :b u .toConst ().toMutable (limbs_buffer [start ..buf_index ]);
};
var rem = b : {
const start = buf_index ;
buf_index += s .limbs .len ;
break :b Mutable .init (limbs_buffer [start ..buf_index ], 0 );
};
while (true ) {
t .divFloor (&rem , a , s .toConst (), limbs_buffer [buf_index ..]);
t .add (t .toConst (), s .toConst ());
u .shiftRight (t .toConst (), 1 );
if (u .toConst ().order (s .toConst ()).compare (.gte )) {
r .copy (s .toConst ());
return ;
}
// Avoid copying u to s by swapping u and s
const tmp_s = s ;
s = u ;
u = tmp_s ;
}
}
r = ⌊√a⌋
r may alias a.
Asserts that
rhas enough limbs to store the result. Upper bound is(a.limbs.len - 1) / 2 + 1.limbs_bufferis used for temporary storage. The amount required is given bycalcSqrtLimbsBufferLen.