[−][src]Struct jubjub::Fq
Represents an element of the scalar field $\mathbb{F}_q$ of the BLS12-381 elliptic curve construction.
Implementations
impl Scalar
[src]
pub const fn zero() -> Scalar
[src]
Returns zero, the additive identity.
pub const fn one() -> Scalar
[src]
Returns one, the multiplicative identity.
pub const fn double(&self) -> Scalar
[src]
Doubles this field element.
pub fn from_bytes(bytes: &[u8; 32]) -> CtOption<Scalar>
[src]
Attempts to convert a little-endian byte representation of
a scalar into a Scalar
, failing if the input is not canonical.
pub fn to_bytes(&self) -> [u8; 32]
[src]
Converts an element of Scalar
into a byte representation in
little-endian byte order.
pub fn from_bytes_wide(bytes: &[u8; 64]) -> Scalar
[src]
Converts a 512-bit little endian integer into
a Scalar
by reducing by the modulus.
pub const fn from_raw(val: [u64; 4]) -> Scalar
[src]
Converts from an integer represented in little endian
into its (congruent) Scalar
representation.
pub const fn square(&self) -> Scalar
[src]
Squares this element.
pub fn sqrt(&self) -> CtOption<Scalar>
[src]
Computes the square root of this element, if it exists.
pub fn pow(&self, by: &[u64; 4]) -> Scalar
[src]
Exponentiates self
by by
, where by
is a
little-endian order integer exponent.
pub fn pow_vartime(&self, by: &[u64; 4]) -> Scalar
[src]
Exponentiates self
by by
, where by
is a
little-endian order integer exponent.
This operation is variable time with respect to the exponent. If the exponent is fixed, this operation is effectively constant time.
pub fn invert(&self) -> CtOption<Scalar>
[src]
Computes the multiplicative inverse of this element, failing if the element is zero.
pub const fn mul(&self, rhs: &Scalar) -> Scalar
[src]
Multiplies rhs
by self
, returning the result.
pub const fn sub(&self, rhs: &Scalar) -> Scalar
[src]
Subtracts rhs
from self
, returning the result.
pub const fn add(&self, rhs: &Scalar) -> Scalar
[src]
Adds rhs
to self
, returning the result.
pub const fn neg(&self) -> Scalar
[src]
Negates self
.
Trait Implementations
impl<'a, 'b> Add<&'b Scalar> for &'a Scalar
[src]
type Output = Scalar
The resulting type after applying the +
operator.
fn add(self, rhs: &'b Scalar) -> Scalar
[src]
impl<'b> Add<&'b Scalar> for Scalar
[src]
type Output = Scalar
The resulting type after applying the +
operator.
fn add(self, rhs: &'b Scalar) -> Scalar
[src]
impl<'a> Add<Scalar> for &'a Scalar
[src]
type Output = Scalar
The resulting type after applying the +
operator.
fn add(self, rhs: Scalar) -> Scalar
[src]
impl Add<Scalar> for Scalar
[src]
type Output = Scalar
The resulting type after applying the +
operator.
fn add(self, rhs: Scalar) -> Scalar
[src]
impl<'b> AddAssign<&'b Scalar> for Scalar
[src]
fn add_assign(&mut self, rhs: &'b Scalar)
[src]
impl AddAssign<Scalar> for Scalar
[src]
fn add_assign(&mut self, rhs: Scalar)
[src]
impl Clone for Scalar
[src]
impl ConditionallySelectable for Scalar
[src]
fn conditional_select(a: &Scalar, b: &Scalar, choice: Choice) -> Scalar
[src]
fn conditional_assign(&mut self, other: &Self, choice: Choice)
[src]
fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)
[src]
impl ConstantTimeEq for Scalar
[src]
impl Copy for Scalar
[src]
impl Debug for Scalar
[src]
impl Default for Scalar
[src]
impl Display for Scalar
[src]
impl Eq for Scalar
[src]
impl Field for Scalar
[src]
fn random<R>(rng: &mut R) -> Scalar where
R: RngCore + ?Sized,
[src]
R: RngCore + ?Sized,
fn zero() -> Scalar
[src]
fn one() -> Scalar
[src]
fn is_zero(&self) -> bool
[src]
#[must_use]fn square(&self) -> Scalar
[src]
#[must_use]fn double(&self) -> Scalar
[src]
fn invert(&self) -> CtOption<Scalar>
[src]
fn sqrt(&self) -> CtOption<Scalar>
[src]
fn pow_vartime<S>(&self, exp: S) -> Self where
S: AsRef<[u64]>,
[src]
S: AsRef<[u64]>,
impl From<u64> for Scalar
[src]
impl<'b> Mul<&'b Scalar> for Scalar
[src]
type Output = Scalar
The resulting type after applying the *
operator.
fn mul(self, rhs: &'b Scalar) -> Scalar
[src]
impl<'a, 'b> Mul<&'b Scalar> for &'a Scalar
[src]
type Output = Scalar
The resulting type after applying the *
operator.
fn mul(self, rhs: &'b Scalar) -> Scalar
[src]
impl<'a> Mul<Scalar> for &'a Scalar
[src]
type Output = Scalar
The resulting type after applying the *
operator.
fn mul(self, rhs: Scalar) -> Scalar
[src]
impl Mul<Scalar> for Scalar
[src]
type Output = Scalar
The resulting type after applying the *
operator.
fn mul(self, rhs: Scalar) -> Scalar
[src]
impl<'b> MulAssign<&'b Scalar> for Scalar
[src]
fn mul_assign(&mut self, rhs: &'b Scalar)
[src]
impl MulAssign<Scalar> for Scalar
[src]
fn mul_assign(&mut self, rhs: Scalar)
[src]
impl Neg for Scalar
[src]
impl<'a> Neg for &'a Scalar
[src]
impl PartialEq<Scalar> for Scalar
[src]
impl PrimeField for Scalar
[src]
type Repr = [u8; 32]
The prime field can be converted back and forth into this binary representation. Read more
type ReprEndianness = LittleEndian
This indicates the endianness of [PrimeField::Repr
].
fn from_repr(r: <Scalar as PrimeField>::Repr) -> Option<Scalar>
[src]
fn to_repr(&self) -> <Scalar as PrimeField>::Repr
[src]
fn is_odd(&self) -> bool
[src]
fn char() -> <Scalar as PrimeField>::Repr
[src]
const NUM_BITS: u32
[src]
const CAPACITY: u32
[src]
fn multiplicative_generator() -> Scalar
[src]
const S: u32
[src]
fn root_of_unity() -> Scalar
[src]
fn from_str(s: &str) -> Option<Self>
[src]
fn is_even(&self) -> bool
[src]
impl<'b> Sub<&'b Scalar> for Scalar
[src]
type Output = Scalar
The resulting type after applying the -
operator.
fn sub(self, rhs: &'b Scalar) -> Scalar
[src]
impl<'a, 'b> Sub<&'b Scalar> for &'a Scalar
[src]
type Output = Scalar
The resulting type after applying the -
operator.
fn sub(self, rhs: &'b Scalar) -> Scalar
[src]
impl<'a> Sub<Scalar> for &'a Scalar
[src]
type Output = Scalar
The resulting type after applying the -
operator.
fn sub(self, rhs: Scalar) -> Scalar
[src]
impl Sub<Scalar> for Scalar
[src]
type Output = Scalar
The resulting type after applying the -
operator.
fn sub(self, rhs: Scalar) -> Scalar
[src]
impl<'b> SubAssign<&'b Scalar> for Scalar
[src]
fn sub_assign(&mut self, rhs: &'b Scalar)
[src]
impl SubAssign<Scalar> for Scalar
[src]
fn sub_assign(&mut self, rhs: Scalar)
[src]
Auto Trait Implementations
impl RefUnwindSafe for Scalar
impl Send for Scalar
impl Sync for Scalar
impl Unpin for Scalar
impl UnwindSafe for Scalar
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> ConditionallyNegatable for T where
T: ConditionallySelectable,
&'a T: for<'a> Neg,
<&'a T as Neg>::Output == T,
[src]
T: ConditionallySelectable,
&'a T: for<'a> Neg,
<&'a T as Neg>::Output == T,
fn conditional_negate(&mut self, choice: Choice)
[src]
impl<T> From<T> for T
[src]
impl<T, Rhs, Output> GroupOps<Rhs, Output> for T where
T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,
[src]
T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,
impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for T where
T: for<'r> GroupOps<&'r Rhs, Output>,
[src]
T: for<'r> GroupOps<&'r Rhs, Output>,
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, Rhs, Output> ScalarMul<Rhs, Output> for T where
T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,
[src]
T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,
impl<T, Rhs, Output> ScalarMulOwned<Rhs, Output> for T where
T: for<'r> ScalarMul<&'r Rhs, Output>,
[src]
T: for<'r> ScalarMul<&'r Rhs, Output>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,