Bitcoin ABC  0.29.2
P2P Digital Currency
field.h
Go to the documentation of this file.
1 /***********************************************************************
2  * Copyright (c) 2013, 2014 Pieter Wuille *
3  * Distributed under the MIT software license, see the accompanying *
4  * file COPYING or https://www.opensource.org/licenses/mit-license.php.*
5  ***********************************************************************/
6 
7 #ifndef SECP256K1_FIELD_H
8 #define SECP256K1_FIELD_H
9 
21 #if defined HAVE_CONFIG_H
22 #include "libsecp256k1-config.h"
23 #endif
24 
25 #include "util.h"
26 
27 #if defined(SECP256K1_WIDEMUL_INT128)
28 #include "field_5x52.h"
29 #elif defined(SECP256K1_WIDEMUL_INT64)
30 #include "field_10x26.h"
31 #else
32 #error "Please select wide multiplication implementation"
33 #endif
34 
38 static void secp256k1_fe_normalize(secp256k1_fe *r);
39 
41 static void secp256k1_fe_normalize_weak(secp256k1_fe *r);
42 
44 static void secp256k1_fe_normalize_var(secp256k1_fe *r);
45 
48 static int secp256k1_fe_normalizes_to_zero(secp256k1_fe *r);
49 
52 static int secp256k1_fe_normalizes_to_zero_var(secp256k1_fe *r);
53 
55 static void secp256k1_fe_set_int(secp256k1_fe *r, int a);
56 
58 static void secp256k1_fe_clear(secp256k1_fe *a);
59 
61 static int secp256k1_fe_is_zero(const secp256k1_fe *a);
62 
64 static int secp256k1_fe_is_odd(const secp256k1_fe *a);
65 
67 static int secp256k1_fe_equal(const secp256k1_fe *a, const secp256k1_fe *b);
68 
70 static int secp256k1_fe_equal_var(const secp256k1_fe *a, const secp256k1_fe *b);
71 
73 static int secp256k1_fe_cmp_var(const secp256k1_fe *a, const secp256k1_fe *b);
74 
76 static int secp256k1_fe_set_b32(secp256k1_fe *r, const unsigned char *a);
77 
79 static void secp256k1_fe_get_b32(unsigned char *r, const secp256k1_fe *a);
80 
83 static void secp256k1_fe_negate(secp256k1_fe *r, const secp256k1_fe *a, int m);
84 
87 static void secp256k1_fe_mul_int(secp256k1_fe *r, int a);
88 
90 static void secp256k1_fe_add(secp256k1_fe *r, const secp256k1_fe *a);
91 
94 static void secp256k1_fe_mul(secp256k1_fe *r, const secp256k1_fe *a, const secp256k1_fe * SECP256K1_RESTRICT b);
95 
98 static void secp256k1_fe_sqr(secp256k1_fe *r, const secp256k1_fe *a);
99 
105 static int secp256k1_fe_sqrt(secp256k1_fe *r, const secp256k1_fe *a);
106 
108 static int secp256k1_fe_is_quad_var(const secp256k1_fe *a);
109 
112 static void secp256k1_fe_inv(secp256k1_fe *r, const secp256k1_fe *a);
113 
115 static void secp256k1_fe_inv_var(secp256k1_fe *r, const secp256k1_fe *a);
116 
118 static void secp256k1_fe_to_storage(secp256k1_fe_storage *r, const secp256k1_fe *a);
119 
121 static void secp256k1_fe_from_storage(secp256k1_fe *r, const secp256k1_fe_storage *a);
122 
124 static void secp256k1_fe_storage_cmov(secp256k1_fe_storage *r, const secp256k1_fe_storage *a, int flag);
125 
127 static void secp256k1_fe_cmov(secp256k1_fe *r, const secp256k1_fe *a, int flag);
128 
129 #endif /* SECP256K1_FIELD_H */
secp256k1_fe_inv_var
static void secp256k1_fe_inv_var(secp256k1_fe *r, const secp256k1_fe *a)
Potentially faster version of secp256k1_fe_inv, without constant-time guarantee.
secp256k1_fe_normalize_weak
static void secp256k1_fe_normalize_weak(secp256k1_fe *r)
Weakly normalize a field element: reduce its magnitude to 1, but don't fully normalize.
secp256k1_fe_is_quad_var
static int secp256k1_fe_is_quad_var(const secp256k1_fe *a)
Checks whether a field element is a quadratic residue.
secp256k1_fe_equal_var
static int secp256k1_fe_equal_var(const secp256k1_fe *a, const secp256k1_fe *b)
Same as secp256k1_fe_equal, but may be variable time.
secp256k1_fe_sqrt
static int secp256k1_fe_sqrt(secp256k1_fe *r, const secp256k1_fe *a)
If a has a square root, it is computed in r and 1 is returned.
secp256k1_fe_normalize_var
static void secp256k1_fe_normalize_var(secp256k1_fe *r)
Normalize a field element, without constant-time guarantee.
secp256k1_fe_clear
static void secp256k1_fe_clear(secp256k1_fe *a)
Sets a field element equal to zero, initializing all fields.
secp256k1_fe_inv
static void secp256k1_fe_inv(secp256k1_fe *r, const secp256k1_fe *a)
Sets a field element to be the (modular) inverse of another.
secp256k1_fe_cmov
static void secp256k1_fe_cmov(secp256k1_fe *r, const secp256k1_fe *a, int flag)
If flag is true, set *r equal to *a; otherwise leave it.
secp256k1_fe_mul_int
static void secp256k1_fe_mul_int(secp256k1_fe *r, int a)
Multiplies the passed field element with a small integer constant.
secp256k1_fe_negate
static void secp256k1_fe_negate(secp256k1_fe *r, const secp256k1_fe *a, int m)
Set a field element equal to the additive inverse of another.
secp256k1_fe_is_odd
static int secp256k1_fe_is_odd(const secp256k1_fe *a)
Check the "oddness" of a field element.
secp256k1_fe_set_int
static void secp256k1_fe_set_int(secp256k1_fe *r, int a)
Set a field element equal to a small integer.
secp256k1_fe_mul
static void secp256k1_fe_mul(secp256k1_fe *r, const secp256k1_fe *a, const secp256k1_fe *SECP256K1_RESTRICT b)
Sets a field element to be the product of two others.
secp256k1_fe_set_b32
static int secp256k1_fe_set_b32(secp256k1_fe *r, const unsigned char *a)
Set a field element equal to 32-byte big endian value.
secp256k1_fe_is_zero
static int secp256k1_fe_is_zero(const secp256k1_fe *a)
Verify whether a field element is zero.
secp256k1_fe_from_storage
static void secp256k1_fe_from_storage(secp256k1_fe *r, const secp256k1_fe_storage *a)
Convert a field element back from the storage type.
secp256k1_fe_normalizes_to_zero_var
static int secp256k1_fe_normalizes_to_zero_var(secp256k1_fe *r)
Verify whether a field element represents zero i.e.
secp256k1_fe_sqr
static void secp256k1_fe_sqr(secp256k1_fe *r, const secp256k1_fe *a)
Sets a field element to be the square of another.
secp256k1_fe_add
static void secp256k1_fe_add(secp256k1_fe *r, const secp256k1_fe *a)
Adds a field element to another.
secp256k1_fe_normalize
static void secp256k1_fe_normalize(secp256k1_fe *r)
Field element module.
secp256k1_fe_to_storage
static void secp256k1_fe_to_storage(secp256k1_fe_storage *r, const secp256k1_fe *a)
Convert a field element to the storage type.
secp256k1_fe_get_b32
static void secp256k1_fe_get_b32(unsigned char *r, const secp256k1_fe *a)
Convert a field element to a 32-byte big endian value.
secp256k1_fe_normalizes_to_zero
static int secp256k1_fe_normalizes_to_zero(secp256k1_fe *r)
Verify whether a field element represents zero i.e.
secp256k1_fe_equal
static int secp256k1_fe_equal(const secp256k1_fe *a, const secp256k1_fe *b)
Compare two field elements.
secp256k1_fe_storage_cmov
static void secp256k1_fe_storage_cmov(secp256k1_fe_storage *r, const secp256k1_fe_storage *a, int flag)
If flag is true, set *r equal to *a; otherwise leave it.
secp256k1_fe_cmp_var
static int secp256k1_fe_cmp_var(const secp256k1_fe *a, const secp256k1_fe *b)
Compare two field elements.
field_10x26.h
field_5x52.h
SECP256K1_RESTRICT
#define SECP256K1_RESTRICT
Definition: util.h:158
secp256k1_fe_storage
Definition: field_10x26.h:43
secp256k1_fe
Definition: field_10x26.h:12
Generated on Thu Apr 18 2024 13:50:12 for Bitcoin ABC by doxygen 1.9.1