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 › crypto › ff › Modulus › montgomeryLoop Private Function montgomeryLoop Doc Source Private Function std.crypto.ff.Modulus.montgomeryLoop
fn montgomeryLoop (self : Self , d : *Fe , x : Fe , y : Fe ) u1 Params File crypto/ff.zig: 622
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666 fn montgomeryLoop (self : Self , d : *Fe , x : Fe , y : Fe ) u1 {
assert (d .limbs_count () == x .limbs_count ());
assert (d .limbs_count () == y .limbs_count ());
assert (d .limbs_count () == self .limbs_count ());
const a_limbs = x .v .limbsConst ();
const b_limbs = y .v .limbsConst ();
const d_limbs = d .v .limbs ();
const m_limbs = self .v .limbsConst ();
var overflow : u1 = 0 ;
for (0 ..self .limbs_count ()) |i | {
var carry : Limb = 0 ;
var wide = ct .mulWide (a_limbs [i ], b_limbs [0 ]);
var z_lo = @addWithOverflow (d_limbs [0 ], wide .lo );
const f = @as (TLimb , @truncate (z_lo [0 ] *% self .m0inv ));
var z_hi = wide .hi +% z_lo [1 ];
wide = ct .mulWide (f , m_limbs [0 ]);
z_lo = @addWithOverflow (z_lo [0 ], wide .lo );
z_hi +%= z_lo [1 ];
z_hi +%= wide .hi ;
carry = (z_hi << 1 ) | (z_lo [0 ] >> t_bits );
for (1 ..self .limbs_count ()) |j | {
wide = ct .mulWide (a_limbs [i ], b_limbs [j ]);
z_lo = @addWithOverflow (d_limbs [j ], wide .lo );
z_hi = wide .hi +% z_lo [1 ];
wide = ct .mulWide (f , m_limbs [j ]);
z_lo = @addWithOverflow (z_lo [0 ], wide .lo );
z_hi +%= z_lo [1 ];
z_hi +%= wide .hi ;
z_lo = @addWithOverflow (z_lo [0 ], carry );
z_hi +%= z_lo [1 ];
if (j > 0 ) {
d_limbs [j - 1 ] = @as (TLimb , @truncate (z_lo [0 ]));
}
carry = (z_hi << 1 ) | (z_lo [0 ] >> t_bits );
}
const z = overflow + carry ;
d_limbs [self .limbs_count () - 1 ] = @as (TLimb , @truncate (z ));
overflow = @as (u1 , @truncate (z >> t_bits ));
}
return overflow ;
}