Skip to content

Commit dabfea7

Browse files
committed
field: extend docstring of secp256k1_fe_normalize
1 parent dc7d8fd commit dabfea7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/field.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,12 @@
3232

3333
#include "util.h"
3434

35-
/** Normalize a field element. */
35+
/** Normalize a field element. This brings the field element to a canonical representation, reduces
36+
* its magnitude to 1, and reduces it modulo field size `p`.
37+
*/
3638
static void secp256k1_fe_normalize(secp256k1_fe *r);
3739

38-
/** Weakly normalize a field element: reduce it magnitude to 1, but don't fully normalize. */
40+
/** Weakly normalize a field element: reduce its magnitude to 1, but don't fully normalize. */
3941
static void secp256k1_fe_normalize_weak(secp256k1_fe *r);
4042

4143
/** Normalize a field element, without constant-time guarantee. */

0 commit comments

Comments
 (0)