Dash Core Source Documentation (0.16.0.1)

Find detailed information regarding the Dash Core source code.

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 http://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 #if defined(USE_FIELD_10X26)
26 #include "field_10x26.h"
27 #elif defined(USE_FIELD_5X52)
28 #include "field_5x52.h"
29 #else
30 #error "Please select field implementation"
31 #endif
32 
33 #include "util.h"
34 
36 static void secp256k1_fe_normalize(secp256k1_fe *r);
37 
40 
43 
47 
51 
53 static void secp256k1_fe_set_int(secp256k1_fe *r, int a);
54 
56 static void secp256k1_fe_clear(secp256k1_fe *a);
57 
59 static int secp256k1_fe_is_zero(const secp256k1_fe *a);
60 
62 static int secp256k1_fe_is_odd(const secp256k1_fe *a);
63 
65 static int secp256k1_fe_equal(const secp256k1_fe *a, const secp256k1_fe *b);
66 
68 static int secp256k1_fe_equal_var(const secp256k1_fe *a, const secp256k1_fe *b);
69 
71 static int secp256k1_fe_cmp_var(const secp256k1_fe *a, const secp256k1_fe *b);
72 
74 static int secp256k1_fe_set_b32(secp256k1_fe *r, const unsigned char *a);
75 
77 static void secp256k1_fe_get_b32(unsigned char *r, const secp256k1_fe *a);
78 
81 static void secp256k1_fe_negate(secp256k1_fe *r, const secp256k1_fe *a, int m);
82 
85 static void secp256k1_fe_mul_int(secp256k1_fe *r, int a);
86 
88 static void secp256k1_fe_add(secp256k1_fe *r, const secp256k1_fe *a);
89 
92 static void secp256k1_fe_mul(secp256k1_fe *r, const secp256k1_fe *a, const secp256k1_fe * SECP256K1_RESTRICT b);
93 
96 static void secp256k1_fe_sqr(secp256k1_fe *r, const secp256k1_fe *a);
97 
103 static int secp256k1_fe_sqrt(secp256k1_fe *r, const secp256k1_fe *a);
104 
106 static int secp256k1_fe_is_quad_var(const secp256k1_fe *a);
107 
110 static void secp256k1_fe_inv(secp256k1_fe *r, const secp256k1_fe *a);
111 
113 static void secp256k1_fe_inv_var(secp256k1_fe *r, const secp256k1_fe *a);
114 
118 static void secp256k1_fe_inv_all_var(secp256k1_fe *r, const secp256k1_fe *a, size_t len);
119 
122 
125 
127 static void secp256k1_fe_storage_cmov(secp256k1_fe_storage *r, const secp256k1_fe_storage *a, int flag);
128 
130 static void secp256k1_fe_cmov(secp256k1_fe *r, const secp256k1_fe *a, int flag);
131 
132 #endif /* SECP256K1_FIELD_H */
static int secp256k1_fe_is_zero(const secp256k1_fe *a)
Verify whether a field element is zero.
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.
static void secp256k1_fe_normalize_var(secp256k1_fe *r)
Normalize a field element, without constant-time guarantee.
static int secp256k1_fe_equal(const secp256k1_fe *a, const secp256k1_fe *b)
Compare two field elements.
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.
static void secp256k1_fe_from_storage(secp256k1_fe *r, const secp256k1_fe_storage *a)
Convert a field element back from the storage type.
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.
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.
static void secp256k1_fe_set_int(secp256k1_fe *r, int a)
Set a field element equal to a small integer.
static void secp256k1_fe_to_storage(secp256k1_fe_storage *r, const secp256k1_fe *a)
Convert a field element to the storage type.
static void secp256k1_fe_clear(secp256k1_fe *a)
Sets a field element equal to zero, initializing all fields.
static void secp256k1_fe_add(secp256k1_fe *r, const secp256k1_fe *a)
Adds a field element to another.
static void secp256k1_fe_mul_int(secp256k1_fe *r, int a)
Multiplies the passed field element with a small integer constant.
static int secp256k1_fe_is_odd(const secp256k1_fe *a)
Check the "oddness" of a field element.
#define SECP256K1_RESTRICT
Definition: util.h:97
static int secp256k1_fe_is_quad_var(const secp256k1_fe *a)
Checks whether a field element is a quadratic residue.
static void secp256k1_fe_normalize_weak(secp256k1_fe *r)
Weakly normalize a field element: reduce it magnitude to 1, but don't fully normalize.
static int secp256k1_fe_normalizes_to_zero(secp256k1_fe *r)
Verify whether a field element represents zero i.e.
static void secp256k1_fe_inv_all_var(secp256k1_fe *r, const secp256k1_fe *a, size_t len)
Calculate the (modular) inverses of a batch of field elements.
static void secp256k1_fe_sqr(secp256k1_fe *r, const secp256k1_fe *a)
Sets a field element to be the square of another.
static int secp256k1_fe_set_b32(secp256k1_fe *r, const unsigned char *a)
Set a field element equal to 32-byte big endian value.
static int secp256k1_fe_cmp_var(const secp256k1_fe *a, const secp256k1_fe *b)
Compare two field elements.
static int secp256k1_fe_equal_var(const secp256k1_fe *a, const secp256k1_fe *b)
Same as secp256k1_fe_equal, but may be variable time.
static void secp256k1_fe_normalize(secp256k1_fe *r)
Field element module.
static void secp256k1_fe_get_b32(unsigned char *r, const secp256k1_fe *a)
Convert a field element to a 32-byte big endian value.
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.
static void secp256k1_fe_inv_var(secp256k1_fe *r, const secp256k1_fe *a)
Potentially faster version of secp256k1_fe_inv, without constant-time guarantee.
static void secp256k1_fe_inv(secp256k1_fe *r, const secp256k1_fe *a)
Sets a field element to be the (modular) inverse of another.
static int secp256k1_fe_normalizes_to_zero_var(secp256k1_fe *r)
Verify whether a field element represents zero i.e.
Released under the MIT license