Skip to content

Commit 4009096

Browse files
committed
Document the purpose of a helper module
1 parent e1d8a49 commit 4009096

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

libm/src/math/support/modular.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
/* SPDX-License-Identifier: MIT OR Apache-2.0 */
22

3+
//! This module provides accelerated modular multiplication by large powers
4+
//! of two, which is needed for computing floating point remainders in `fmod`
5+
//! and similar functions.
6+
//!
37
//! To keep the equations somewhat concise, the following conventions are used:
48
//! - all integer operations are in the mathematical sense, without overflow
59
//! - concatenation means multiplication: `2xq = 2 * x * q`

0 commit comments

Comments
 (0)