Struct libsecp256k1::curve::Field

source ·

pub struct Field { /* private fields */ }

Expand description

Field element for secp256k1.

Implementations§

source §

impl Field

source

pub const fn new_raw(
    d9: u32,
    d8: u32,
    d7: u32,
    d6: u32,
    d5: u32,
    d4: u32,
    d3: u32,
    d2: u32,
    d1: u32,
    d0: u32
) -> Field

source

pub const fn new(
    d7: u32,
    d6: u32,
    d5: u32,
    d4: u32,
    d3: u32,
    d2: u32,
    d1: u32,
    d0: u32
) -> Field

source

pub fn from_int(a: u32) -> Field

source

pub fn normalize(&mut self)

Normalize a field element.

source

pub fn normalize_weak(&mut self)

Weakly normalize a field element: reduce it magnitude to 1, but don’t fully normalize.

source

pub fn normalize_var(&mut self)

Normalize a field element, without constant-time guarantee.

source

pub fn normalizes_to_zero(&self) -> bool

Verify whether a field element represents zero i.e. would normalize to a zero value. The field implementation may optionally normalize the input, but this should not be relied upon.

source

pub fn normalizes_to_zero_var(&self) -> bool

Verify whether a field element represents zero i.e. would normalize to a zero value. The field implementation may optionally normalize the input, but this should not be relied upon.

source

pub fn set_int(&mut self, a: u32)

Set a field element equal to a small integer. Resulting field element is normalized.

source

pub fn is_zero(&self) -> bool

Verify whether a field element is zero. Requires the input to be normalized.

source

pub fn is_odd(&self) -> bool

Check the “oddness” of a field element. Requires the input to be normalized.

source

pub fn clear(&mut self)

Sets a field element equal to zero, initializing all fields.

source

pub fn set_b32(&mut self, a: &[u8; 32]) -> bool

Set a field element equal to 32-byte big endian value. If successful, the resulting field element is normalized.

source

pub fn fill_b32(&self, r: &mut [u8; 32])

source

pub fn b32(&self) -> [u8; 32]

Convert a field element to a 32-byte big endian value. Requires the input to be normalized.

source

pub fn neg_in_place(&mut self, other: &Field, m: u32)

Set a field element equal to the additive inverse of another. Takes a maximum magnitude of the input as an argument. The magnitude of the output is one higher.

source

pub fn neg(&self, m: u32) -> Field

Compute the additive inverse of this element. Takes the maximum expected magnitude of this element as an argument.

source

pub fn mul_int(&mut self, a: u32)

Multiplies the passed field element with a small integer constant. Multiplies the magnitude by that small integer.

source

pub fn cmp_var(&self, other: &Field) -> Ordering

Compare two field elements. Requires both inputs to be normalized.

source

pub fn eq_var(&self, other: &Field) -> bool

source

pub fn mul_in_place(&mut self, a: &Field, b: &Field)

Sets a field element to be the product of two others. Requires the inputs’ magnitudes to be at most 8. The output magnitude is 1 (but not guaranteed to be normalized).

source

pub fn sqr_in_place(&mut self, a: &Field)

Sets a field element to be the square of another. Requires the input’s magnitude to be at most 8. The output magnitude is 1 (but not guaranteed to be normalized).

source

pub fn sqr(&self) -> Field

source

pub fn sqrt(&self) -> (Field, bool)

If a has a square root, it is computed in r and 1 is returned. If a does not have a square root, the root of its negation is computed and 0 is returned. The input’s magnitude can be at most 8. The output magnitude is 1 (but not guaranteed to be normalized). The result in r will always be a square itself.

source

pub fn inv(&self) -> Field

Sets a field element to be the (modular) inverse of another. Requires the input’s magnitude to be at most 8. The output magnitude is 1 (but not guaranteed to be normalized).

source