Fix up documentation
This commit is contained in:
parent
479a9cab28
commit
144d81b2c1
|
@ -101,7 +101,7 @@ void fr_from_scalar(fr_t *out, const scalar_t *a) {
|
||||||
/**
|
/**
|
||||||
* Create a field element from an array of four 64-bit unsigned integers.
|
* Create a field element from an array of four 64-bit unsigned integers.
|
||||||
*
|
*
|
||||||
* @param out The field element equivalent of @p n
|
* @param out The field element equivalent of @p vals
|
||||||
* @param vals The array of 64-bit integers to be converted, little-endian ordering of the 64-bit words
|
* @param vals The array of 64-bit integers to be converted, little-endian ordering of the 64-bit words
|
||||||
*/
|
*/
|
||||||
void fr_from_uint64s(fr_t *out, const uint64_t vals[4]) {
|
void fr_from_uint64s(fr_t *out, const uint64_t vals[4]) {
|
||||||
|
@ -125,7 +125,7 @@ void fr_from_uint64(fr_t *out, uint64_t n) {
|
||||||
* Convert a field element to an array of four 64-bit unsigned integers.
|
* Convert a field element to an array of four 64-bit unsigned integers.
|
||||||
*
|
*
|
||||||
* @param out Array for returned values, little-endian ordering of the 64-bit words
|
* @param out Array for returned values, little-endian ordering of the 64-bit words
|
||||||
* @param vals The field element equivalent of @p n
|
* @param fr The field element to be converted
|
||||||
*/
|
*/
|
||||||
void fr_to_uint64s(uint64_t out[4], const fr_t *fr) {
|
void fr_to_uint64s(uint64_t out[4], const fr_t *fr) {
|
||||||
blst_uint64_from_fr(out, fr);
|
blst_uint64_from_fr(out, fr);
|
||||||
|
|
|
@ -102,9 +102,9 @@ bool fr_is_zero(const fr_t *p);
|
||||||
bool fr_is_one(const fr_t *p);
|
bool fr_is_one(const fr_t *p);
|
||||||
bool fr_is_null(const fr_t *p);
|
bool fr_is_null(const fr_t *p);
|
||||||
void fr_from_scalar(fr_t *out, const scalar_t *a);
|
void fr_from_scalar(fr_t *out, const scalar_t *a);
|
||||||
void fr_from_uint64s(fr_t *out, const uint64_t *vals);
|
void fr_from_uint64s(fr_t *out, const uint64_t vals[4]);
|
||||||
void fr_from_uint64(fr_t *out, uint64_t n);
|
void fr_from_uint64(fr_t *out, uint64_t n);
|
||||||
void fr_to_uint64s(uint64_t out[4], const fr_t* fr);
|
void fr_to_uint64s(uint64_t out[4], const fr_t *fr);
|
||||||
bool fr_equal(const fr_t *aa, const fr_t *bb);
|
bool fr_equal(const fr_t *aa, const fr_t *bb);
|
||||||
void fr_negate(fr_t *out, const fr_t *in);
|
void fr_negate(fr_t *out, const fr_t *in);
|
||||||
void fr_add(fr_t *out, const fr_t *a, const fr_t *b);
|
void fr_add(fr_t *out, const fr_t *a, const fr_t *b);
|
||||||
|
|
Loading…
Reference in New Issue