Struct dusk_jubjub::JubJubAffine

pub struct JubJubAffine { /* fields omitted */ }

This represents a Jubjub point in the affine (x, y) coordinates.

Implementations

impl JubJubAffine

pub const fn identity() -> Self

Constructs the neutral element (0, 1).

pub fn mul_by_cofactor(&self) -> JubJubExtended

Multiplies this point by the cofactor, producing an JubJubExtended

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 get_x(&self) -> BlsScalar

Returns the x-coordinate of this point.

pub fn get_y(&self) -> BlsScalar

Returns the y-coordinate of this point.

pub const fn to_niels(&self) -> AffineNielsPoint

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

pub const fn from_raw_unchecked(x: BlsScalar, y: BlsScalar) -> JubJubAffine

Constructs an JubJubAffine given x and y without checking that the point is on the curve.

Trait Implementations

impl<'a, 'b> Add<&'b JubJubAffine> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, other: &'b JubJubAffine) -> JubJubExtended

Performs the + operation.

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.

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.

impl Add<JubJubAffine> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the + operator.

fn add(self, rhs: JubJubAffine) -> JubJubExtended

Performs the + operation.

impl<'b> AddAssign<&'b JubJubAffine> for JubJubExtended

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

Performs the += operation.

impl AddAssign<JubJubAffine> for JubJubExtended

fn add_assign(&mut self, rhs: JubJubAffine)

Performs the += operation.

impl Clone for JubJubAffine

fn clone(&self) -> JubJubAffine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for JubJubAffine

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

Select a or b according to choice.

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

Conditionally assign other to self, according to choice.

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

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

impl ConstantTimeEq for JubJubAffine

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

Determine if two items are equal.

impl Debug for JubJubAffine

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

Formats the value using the given formatter.

impl Default for JubJubAffine

fn default() -> JubJubAffine

Returns the identity.

impl<'a> From<&'a JubJubExtended> for JubJubAffine

fn from(extended: &'a JubJubExtended) -> JubJubAffine

Constructs an affine point from an extended point using the map (X, Y, Z, T1, T2) => (XZ, Y/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 (x, y) => (x, y, 1, x, y).

impl From<JubJubExtended> for JubJubAffine

fn from(extended: JubJubExtended) -> JubJubAffine

Performs the conversion.

impl Neg for JubJubAffine

fn neg(self) -> JubJubAffine

This computes the negation of a point P = (x, y) as -P = (-x, y).

type Output = JubJubAffine

The resulting type after applying the - operator.

impl PartialEq<JubJubAffine> for JubJubAffine

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serializable<32_usize> for JubJubAffine

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

Converts this element into its byte representation.

fn from_bytes(b: &[u8; 32]) -> Result<Self, Self::Error>

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

NOTE: ZIP 216 is enabled by default and the only way to interact with serialization. See: https://zips.z.cash/zip-0216 for more details.

type Error = BytesError

The type returned in the event of a conversion error.

const SIZE: usize

The size of

impl<'a, 'b> Sub<&'b JubJubAffine> for &'a JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, other: &'b JubJubAffine) -> JubJubExtended

Performs the - operation.

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.

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.

impl Sub<JubJubAffine> for JubJubExtended

type Output = JubJubExtended

The resulting type after applying the - operator.

fn sub(self, rhs: JubJubAffine) -> JubJubExtended

Performs the - operation.

impl<'b> SubAssign<&'b JubJubAffine> for JubJubExtended

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

Performs the -= operation.

impl SubAssign<JubJubAffine> for JubJubExtended

fn sub_assign(&mut self, rhs: JubJubAffine)

Performs the -= operation.

impl Copy for JubJubAffine