JubjubAffine

mithril_stm::circuits::halo2::types

Struct JubjubAffine

pub struct JubjubAffine { /* private fields */ }

Expand description

This represents a Jubjub point in the affine (u, v) coordinates.

Implementations§

impl JubjubAffine

pub const fn identity() -> JubjubAffine

Constructs the neutral element (0, 1).

pub fn is_identity(&self) -> Choice

Determines if this point is the identity.

pub fn mul_by_cofactor(&self) -> JubjubExtended

Multiplies this point by the cofactor, producing an ExtendedPoint

pub fn is_small_order(&self) -> Choice

Determines if this point is of small order.

pub fn is_torsion_free(&self) -> Choice

Determines if this point is torsion free and so is in the prime order subgroup.

pub fn is_prime_order(&self) -> Choice

Determines if this point is prime order, or in other words that the smallest scalar multiplied by this point that produces the identity is r. This is equivalent to checking that the point is both torsion free and not the identity.

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

Converts this element into its byte representation.

pub fn from_bytes(b: [u8; 32]) -> CtOption<JubjubAffine>

Attempts to interpret a byte representation of an affine point, failing if the element is not on the curve or non-canonical.

pub fn from_bytes_pre_zip216_compatibility( b: [u8; 32], ) -> CtOption<JubjubAffine>

Attempts to interpret a byte representation of an affine point, failing if the element is not on the curve.

Most non-canonical encodings will also cause a failure. However, this API preserves (for use in consensus-critical protocols) a bug in the parsing code that caused two non-canonical encodings to be silently accepted:

(0, 1), which is the identity;
(0, -1), which is a point of order two.

Each of these has a single non-canonical encoding in which the value of the sign bit is 1.

See ZIP 216 for a more detailed description of the bug, as well as its fix.

pub fn batch_from_bytes( items: impl Iterator<Item = [u8; 32]>, ) -> Vec<CtOption<JubjubAffine>>

Attempts to interpret a batch of byte representations of affine points.

Returns None for each element if it is not on the curve, or is non-canonical according to ZIP 216.

pub fn get_u(&self) -> Fq

Returns the u-coordinate of this point.

pub fn get_v(&self) -> Fq

Returns the v-coordinate of this point.

pub const fn to_extended(&self) -> JubjubExtended

Returns an ExtendedPoint for use in arithmetic operations.

pub fn to_niels(&self) -> JubjubAffineNiels

Performs a pre-processing step that produces an AffineNielsPoint for use in multiple additions.

pub fn from_raw_unchecked(u: Fq, v: Fq) -> JubjubAffine

Constructs an AffinePoint given u and v without checking that the point is on the curve.

Trait Implementations§

impl<'b> Add<&'b JubjubAffine> for &JubjubAffine

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, other: &'b JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl<'b> Add<&'b JubjubAffine> for &JubjubExtended

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, other: &'b JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl<'b> Add<&'b JubjubAffine> for JubjubAffine

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, rhs: &'b JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl<'b> Add<&'b JubjubAffine> for JubjubExtended

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, rhs: &'b JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl<'a> Add<JubjubAffine> for &'a JubjubAffine

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl<'a> Add<JubjubAffine> for &'a JubjubExtended

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl Add<JubjubAffine> for JubjubExtended

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl Add for JubjubAffine

type Output = JubjubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubjubAffine) -> JubjubExtended

Performs the + operation. Read more

impl<'b> AddAssign<&'b JubjubAffine> for JubjubExtended

fn add_assign(&mut self, rhs: &'b JubjubAffine)

Performs the += operation. Read more

impl AddAssign<JubjubAffine> for JubjubExtended

fn add_assign(&mut self, rhs: JubjubAffine)

Performs the += operation. Read more

impl Clone for JubjubAffine

fn clone(&self) -> JubjubAffine

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl CofactorCurveAffine for JubjubAffine

type Scalar = Fr

type Curve = JubjubExtended

fn identity() -> JubjubAffine

Returns the additive identity.

fn generator() -> JubjubAffine

Returns a fixed generator of unknown exponent.

fn is_identity(&self) -> Choice

Determines if this point represents the point at infinity; the additive identity.

fn to_curve(&self) -> <JubjubAffine as CofactorCurveAffine>::Curve

Converts this element to its curve representation.

impl ConditionallySelectable for JubjubAffine

fn conditional_select( a: &JubjubAffine, b: &JubjubAffine, choice: Choice, ) -> JubjubAffine

Select a or b according to choice. Read more

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice. Read more

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves. Read more

impl ConstantTimeEq for JubjubAffine

fn ct_eq(&self, other: &JubjubAffine) -> Choice

Determine if two items are equal. Read more

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal. Read more

impl Debug for JubjubAffine

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

impl Default for JubjubAffine

fn default() -> JubjubAffine

Returns the identity.

impl Display for JubjubAffine

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

impl<'a> From<&'a JubjubExtended> for JubjubAffine

fn from(extended: &'a JubjubExtended) -> JubjubAffine

Constructs an affine point from an extended point using the map (U, V, Z, T1, T2) => (U/Z, V/Z) as Z is always nonzero. This requires a field inversion and so it is recommended to perform these in a batch using [batch_normalize] instead.

impl From<JubjubAffine> for JubjubExtended

fn from(affine: JubjubAffine) -> JubjubExtended

Constructs an extended point (with Z = 1) from an affine point using the map (u, v) => (u, v, 1, u, v).

impl From<JubjubExtended> for JubjubAffine

fn from(extended: JubjubExtended) -> JubjubAffine

Converts to this type from the input type.

impl GroupEncoding for JubjubAffine

type Repr = [u8; 32]

The encoding of group elements. Read more

fn from_bytes( bytes: &<JubjubAffine as GroupEncoding>::Repr, ) -> CtOption<JubjubAffine>

Attempts to deserialize a group element from its encoding.

fn from_bytes_unchecked( bytes: &<JubjubAffine as GroupEncoding>::Repr, ) -> CtOption<JubjubAffine>

Attempts to deserialize a group element, not checking if the element is valid. Read more

fn to_bytes(&self) -> <JubjubAffine as GroupEncoding>::Repr

Converts this element into its byte encoding. This may or may not support encoding the identity.

impl<'b> Mul<&'b Fr> for &JubjubAffine

type Output = JubjubExtended

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> JubjubExtended

Performs the * operation. Read more

impl<'b> Mul<&'b Fr> for JubjubAffine

type Output = JubjubExtended

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fr) -> JubjubExtended

Performs the * operation. Read more

impl<'a> Mul<Fr> for &'a JubjubAffine

type Output = JubjubExtended

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> JubjubExtended

Performs the * operation. Read more

impl Mul<Fr> for JubjubAffine

type Output = JubjubExtended

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> JubjubExtended

Performs the * operation. Read more

impl Neg for JubjubAffine

fn neg(self) -> JubjubAffine

This computes the negation of a point P = (u, v) as -P = (-u, v).

type Output = JubjubAffine

The resulting type after applying the - operator.

impl PartialEq for JubjubAffine

fn eq(&self, other: &JubjubAffine) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'b> Sub<&'b JubjubAffine> for &JubjubAffine

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, other: &'b JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl<'b> Sub<&'b JubjubAffine> for &JubjubExtended

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, other: &'b JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl<'b> Sub<&'b JubjubAffine> for JubjubAffine

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: &'b JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl<'b> Sub<&'b JubjubAffine> for JubjubExtended

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: &'b JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl<'a> Sub<JubjubAffine> for &'a JubjubAffine

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl<'a> Sub<JubjubAffine> for &'a JubjubExtended

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl Sub<JubjubAffine> for JubjubExtended

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl Sub for JubjubAffine

type Output = JubjubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubjubAffine) -> JubjubExtended

Performs the - operation. Read more

impl<'b> SubAssign<&'b JubjubAffine> for JubjubExtended

fn sub_assign(&mut self, rhs: &'b JubjubAffine)

Performs the -= operation. Read more

impl SubAssign<JubjubAffine> for JubjubExtended

fn sub_assign(&mut self, rhs: JubjubAffine)

Performs the -= operation. Read more

impl Copy for JubjubAffine

impl Eq for JubjubAffine

Auto Trait Implementations§

impl Freeze for JubjubAffine

impl RefUnwindSafe for JubjubAffine

impl Send for JubjubAffine

impl Sync for JubjubAffine

impl Unpin for JubjubAffine

impl UnwindSafe for JubjubAffine

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

impl<T, U> TryInto<U> for T
where 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>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> SyncDeps for T