cryptix-field 0.1.0

pub mod montgomery;
pub mod primefield;

use core::ops::Mul;

use crate::ring::Ring;

/// This is a trait for field, a field is constructed from
/// 
/// 1. A Abelian Group over add
/// 2. A ring over multiplication and addition
/// 3. Multiplication should be communicative
/// 4. There must exists multiplicative inverse
/// 5. There must exists multiplicative identity (**and different from additive identity**)
/// 
/// TODO: find a way to constraint a field has different multiplicative identity
/// and addition identity via type system.
pub trait Field: Ring + CommunicativeMul + MulIdentity + MulInverse { 
    /// calculate self / 2 in field
    /// 
    /// ```text
    /// if self.is_even 
    ///     return self >> 1
    /// else 
    ///     return (self + P) >> 1
    /// ```
    fn hlv(self) -> Self;

    /// check if self is zero
    fn is_zero(&self) -> bool;
}

/// # Safety
/// 
/// This trait is safe to implement only when the underlying type is guaranteed to
/// give the same result for any a * b and b * a
pub trait CommunicativeMul: Sized + Mul<Output = Self> { }

/// # Safety
/// 
/// This trait is safe only when for any a, a * MUL_IDENTITY = MUL_IDENTITY * a = a
pub trait MulIdentity: Sized + Mul<Output = Self> {
    const MUL_IDENTITY: Self;
    const ONE: Self = Self::MUL_IDENTITY;
}

pub trait MulInverse: MulIdentity {
    fn mul_inv(self) -> Self;
}