Struct binius_math::matrix::Matrix

source · 
pub struct Matrix<F: Field> { /* private fields */ }
Expand description

A matrix over a field.

Implementations§

source§

impl<F: Field> Matrix<F>

source

pub fn m(&self) -> usize

source

pub fn n(&self) -> usize

source§

impl<F: Field> Matrix<F>

source

pub fn new(m: usize, n: usize, elements: &[F]) -> Result<Self, Error>

source

pub fn zeros(m: usize, n: usize) -> Self

source

pub fn identity(n: usize) -> Self

source

pub fn elements(&self) -> &[F]

source

pub fn random(m: usize, n: usize, rng: impl RngCore) -> Self

source

pub fn dim(&self) -> (usize, usize)

source

pub fn copy_from(&mut self, other: &Self)

source

pub fn mul_into(a: &Self, b: &Self, c: &mut Self)

source

pub fn mul_vec_into<FE: ExtensionField<F>>(&self, x: &[FE], y: &mut [FE])

source

pub fn inverse_into(&self, out: &mut Self) -> Result<(), Error>

Invert a square matrix

§Throws
§Preconditions
  • out - must have the same dimensions as self

Trait Implementations§

source§

impl<F: Field> Add for &Matrix<F>

§

type Output = Matrix<F>

The resulting type after applying the + operator.
source§

fn add(self, rhs: Self) -> Matrix<F>

Performs the + operation. Read more
source§

impl<F: Field> AddAssign<&Matrix<F>> for Matrix<F>

source§

fn add_assign(&mut self, rhs: &Self)

Performs the += operation. Read more
source§

impl<F: Clone + Field> Clone for Matrix<F>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<F: Debug + Field> Debug for Matrix<F>

source§

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

Formats the value using the given formatter. Read more
source§

impl<F: Field> Index<(usize, usize)> for Matrix<F>

§

type Output = F

The returned type after indexing.
source§

fn index(&self, index: (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl<F: Field> IndexMut<(usize, usize)> for Matrix<F>

source§

fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<F: PartialEq + Field> PartialEq for Matrix<F>

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F: Field> Sub for &Matrix<F>

§

type Output = Matrix<F>

The resulting type after applying the - operator.
source§

fn sub(self, rhs: Self) -> Matrix<F>

Performs the - operation. Read more
source§

impl<F: Field> SubAssign<&Matrix<F>> for Matrix<F>

source§

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation. Read more
source§

impl<F: Eq + Field> Eq for Matrix<F>

source§

impl<F: Field> StructuralPartialEq for Matrix<F>

Auto Trait Implementations§

§

impl<F> Freeze for Matrix<F>
where <F as WithUnderlier>::Underlier: PackScalar<F> + UnderlierType + Sync + Send + Zeroable + NoUninit + Random + Copy + Clone + ConstantTimeEq + Eq + PartialEq + Default + Debug + Sized + 'static, F: WithUnderlier + Zeroable + InvertOrZero + Square + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F, Output = F, Output = F> + for<'a> Sub<&'a F, Output = F, Output = F> + for<'a> Add<&'a F, Output = F, Output = F> + Product + Sum + Mul + Sub + Add + Neg<Output = F> + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + 'static,

§

impl<F> RefUnwindSafe for Matrix<F>
where <F as WithUnderlier>::Underlier: PackScalar<F> + UnderlierType + Sync + Send + Zeroable + NoUninit + Random + Copy + Clone + ConstantTimeEq + Eq + PartialEq + Default + Debug + Sized + 'static, F: WithUnderlier + Zeroable + InvertOrZero + Square + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F, Output = F, Output = F> + for<'a> Sub<&'a F, Output = F, Output = F> + for<'a> Add<&'a F, Output = F, Output = F> + Product + Sum + Mul + Sub + Add + Neg<Output = F> + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + 'static + RefUnwindSafe,

§

impl<F> Send for Matrix<F>
where <F as WithUnderlier>::Underlier: PackScalar<F> + UnderlierType + Sync + Send + Zeroable + NoUninit + Random + Copy + Clone + ConstantTimeEq + Eq + PartialEq + Default + Debug + Sized + 'static, F: WithUnderlier + Zeroable + InvertOrZero + Square + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F, Output = F, Output = F> + for<'a> Sub<&'a F, Output = F, Output = F> + for<'a> Add<&'a F, Output = F, Output = F> + Product + Sum + Mul + Sub + Add + Neg<Output = F> + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + 'static,

§

impl<F> Sync for Matrix<F>
where <F as WithUnderlier>::Underlier: PackScalar<F> + UnderlierType + Sync + Send + Zeroable + NoUninit + Random + Copy + Clone + ConstantTimeEq + Eq + PartialEq + Default + Debug + Sized + 'static, F: WithUnderlier + Zeroable + InvertOrZero + Square + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F, Output = F, Output = F> + for<'a> Sub<&'a F, Output = F, Output = F> + for<'a> Add<&'a F, Output = F, Output = F> + Product + Sum + Mul + Sub + Add + Neg<Output = F> + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + 'static,

§

impl<F> Unpin for Matrix<F>
where <F as WithUnderlier>::Underlier: PackScalar<F> + UnderlierType + Sync + Send + Zeroable + NoUninit + Random + Copy + Clone + ConstantTimeEq + Eq + PartialEq + Default + Debug + Sized + 'static, F: WithUnderlier + Zeroable + InvertOrZero + Square + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F, Output = F, Output = F> + for<'a> Sub<&'a F, Output = F, Output = F> + for<'a> Add<&'a F, Output = F, Output = F> + Product + Sum + Mul + Sub + Add + Neg<Output = F> + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + 'static,

§

impl<F> UnwindSafe for Matrix<F>
where <F as WithUnderlier>::Underlier: PackScalar<F> + UnderlierType + Sync + Send + Zeroable + NoUninit + Random + Copy + Clone + ConstantTimeEq + Eq + PartialEq + Default + Debug + Sized + 'static, F: WithUnderlier + Zeroable + InvertOrZero + Square + for<'a> MulAssign<&'a F> + for<'a> SubAssign<&'a F> + for<'a> AddAssign<&'a F> + MulAssign + SubAssign + AddAssign + for<'a> Product<&'a F> + for<'a> Sum<&'a F> + for<'a> Mul<&'a F, Output = F, Output = F> + for<'a> Sub<&'a F, Output = F, Output = F> + for<'a> Add<&'a F, Output = F, Output = F> + Product + Sum + Mul + Sub + Add + Neg<Output = F> + Debug + Sync + Send + Default + Clone + Copy + Eq + PartialEq + 'static + UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

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
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

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
source§

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> 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
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

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