field: extend docstring of secp256k1_fe_normalize

This commit is contained in:
Marko Bencun 2020-01-16 16:52:09 +01:00
parent dc7d8fd9e2
commit dabfea7e21
No known key found for this signature in database
GPG Key ID: 804538928C37EAE8
1 changed files with 4 additions and 2 deletions

View File

@ -32,10 +32,12 @@
#include "util.h" #include "util.h"
/** Normalize a field element. */ /** Normalize a field element. This brings the field element to a canonical representation, reduces
* its magnitude to 1, and reduces it modulo field size `p`.
*/
static void secp256k1_fe_normalize(secp256k1_fe *r); static void secp256k1_fe_normalize(secp256k1_fe *r);
/** Weakly normalize a field element: reduce it magnitude to 1, but don't fully normalize. */ /** Weakly normalize a field element: reduce its magnitude to 1, but don't fully normalize. */
static void secp256k1_fe_normalize_weak(secp256k1_fe *r); static void secp256k1_fe_normalize_weak(secp256k1_fe *r);
/** Normalize a field element, without constant-time guarantee. */ /** Normalize a field element, without constant-time guarantee. */