Struct CirclePoint 

pub struct CirclePoint<F> {
    pub x: F,
    pub y: F,
}

A point on the complex circle. Treated as an additive group.

Fields

x: F

y: F

Implementations

impl<F: Zero + Add<Output = F> + FieldExpOps + Sub<Output = F> + Neg<Output = F>> CirclePoint<F>

pub fn zero() -> Self

pub fn double(&self) -> Self

pub fn double_x(x: F) -> F

Applies the circle’s x-coordinate doubling map.

Examples

use stwo::core::circle::{CirclePoint, M31_CIRCLE_GEN};
use stwo::core::fields::m31::M31;
let p = M31_CIRCLE_GEN.mul(17);
assert_eq!(CirclePoint::double_x(p.x), (p + p).x);

pub fn log_order(&self) -> u32

where F: PartialEq + Eq,

Returns the log order of a point.

All points have an order of the form 2^k.

Examples

use stwo::core::circle::{CirclePoint, M31_CIRCLE_GEN, M31_CIRCLE_LOG_ORDER};
use stwo::core::fields::m31::M31;
assert_eq!(M31_CIRCLE_GEN.log_order(), M31_CIRCLE_LOG_ORDER);

pub fn mul(&self, scalar: u128) -> CirclePoint<F>

pub fn repeated_double(&self, n: u32) -> Self

pub fn conjugate(&self) -> CirclePoint<F>

pub fn antipode(&self) -> CirclePoint<F>

pub fn into_ef<EF: From<F>>(self) -> CirclePoint<EF>

pub fn mul_signed(&self, off: isize) -> CirclePoint<F>

impl CirclePoint<SecureField>

pub fn get_point(index: u128) -> Self

pub fn get_random_point<C: Channel>(channel: &mut C) -> Self

Trait Implementations

impl<F: Zero + Add<Output = F> + FieldExpOps + Sub<Output = F> + Neg<Output = F>> Add for CirclePoint<F>

type Output = CirclePoint<F>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<F: Clone> Clone for CirclePoint<F>

fn clone(&self) -> CirclePoint<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Field> ComplexConjugate for CirclePoint<F>

fn complex_conjugate(&self) -> Self

Example

impl<F: Copy> Copy for CirclePoint<F>

impl<F: Debug> Debug for CirclePoint<F>

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

Formats the value using the given formatter.

impl<F: Default> Default for CirclePoint<F>

fn default() -> CirclePoint<F>

Returns the “default value” for a type.

impl<F: Eq> Eq for CirclePoint<F>

impl<F: Hash> Hash for CirclePoint<F>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<F: Zero + Add<Output = F> + FieldExpOps + Sub<Output = F> + Neg<Output = F>> Neg for CirclePoint<F>

type Output = CirclePoint<F>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<F: PartialEq> PartialEq for CirclePoint<F>

fn eq(&self, other: &CirclePoint<F>) -> bool

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

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<F: PartialEq> StructuralPartialEq for CirclePoint<F>

impl<F: Zero + Add<Output = F> + FieldExpOps + Sub<Output = F> + Neg<Output = F>> Sub for CirclePoint<F>

type Output = CirclePoint<F>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.