Struct RingRef 

pub struct RingRef<'a, R: RingBase + ?Sized> { /* private fields */ }

The second most basic crate::ring::RingStore. Similarly to crate::ring::RingValue it is just a no-op container.

Why do we need this in addition to crate::ring::RingValue?

Before RingValue::from_ref() was added, this was important to allow using a reference to a RingBase as RingStore. Since then, it indeed has only a marginal importance, but note that it is currently the only way of working with unsized rings (an admittedly pretty exotic case).

Implementations

impl<'a, R: RingBase + ?Sized> RingRef<'a, R>

pub const fn new(value: &'a R) -> Self

Creates a new RingRef from a reference to a RingBase.

pub fn into(self) -> &'a R

Returns the stored reference to the RingBase.

This is almost the same as RingStore::get_ring(), except for that the lifetime of the returned reference is not bounded to the lifetime of the RingRef.

Trait Implementations

impl<'a, R: RingBase + ?Sized> Clone for RingRef<'a, R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, R: Debug + RingBase + ?Sized> Debug for RingRef<'a, R>

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

Formats the value using the given formatter.

impl<'a, R: RingBase + ?Sized> RingStore for RingRef<'a, R>

type Type = R

The type of the stored ring.

fn get_ring(&self) -> &R

Returns a reference to the stored ring.

fn clone_el(&self, val: &El<Self>) -> El<Self>

See RingBase::clone_el()

fn add_assign_ref(&self, lhs: &mut El<Self>, rhs: &El<Self>)

See RingBase::add_assign_ref()

fn add_assign(&self, lhs: &mut El<Self>, rhs: El<Self>)

See RingBase::add_assign()

fn sub_assign_ref(&self, lhs: &mut El<Self>, rhs: &El<Self>)

See RingBase::sub_assign_ref()

fn sub_self_assign(&self, lhs: &mut El<Self>, rhs: El<Self>)

See RingBase::sub_self_assign()

fn sub_self_assign_ref(&self, lhs: &mut El<Self>, rhs: &El<Self>)

See RingBase::sub_self_assign_ref()

fn negate_inplace(&self, lhs: &mut El<Self>)

See RingBase::negate_inplace()

fn mul_assign(&self, lhs: &mut El<Self>, rhs: El<Self>)

See RingBase::mul_assign()

fn mul_assign_ref(&self, lhs: &mut El<Self>, rhs: &El<Self>)

See RingBase::mul_assign_ref()

fn zero(&self) -> El<Self>

See RingBase::zero()

fn one(&self) -> El<Self>

See RingBase::one()

fn neg_one(&self) -> El<Self>

See RingBase::neg_one()

fn eq_el(&self, lhs: &El<Self>, rhs: &El<Self>) -> bool

See RingBase::eq_el()

fn is_zero(&self, value: &El<Self>) -> bool

See RingBase::is_zero()

fn is_one(&self, value: &El<Self>) -> bool

See RingBase::is_one()

fn is_neg_one(&self, value: &El<Self>) -> bool

See RingBase::is_neg_one()

fn is_commutative(&self) -> bool

See RingBase::is_commutative()

fn is_noetherian(&self) -> bool

See RingBase::is_noetherian()

fn negate(&self, value: El<Self>) -> El<Self>

See RingBase::negate()

fn sub_assign(&self, lhs: &mut El<Self>, rhs: El<Self>)

See RingBase::sub_assign()

fn add_ref(&self, lhs: &El<Self>, rhs: &El<Self>) -> El<Self>

See RingBase::add_ref()

fn add_ref_fst(&self, lhs: &El<Self>, rhs: El<Self>) -> El<Self>

See RingBase::add_ref_fst()

fn add_ref_snd(&self, lhs: El<Self>, rhs: &El<Self>) -> El<Self>

See RingBase::add_ref_snd()

fn add(&self, lhs: El<Self>, rhs: El<Self>) -> El<Self>

See RingBase::add()

fn sub_ref(&self, lhs: &El<Self>, rhs: &El<Self>) -> El<Self>

See RingBase::sub_ref()

fn sub_ref_fst(&self, lhs: &El<Self>, rhs: El<Self>) -> El<Self>

See RingBase::sub_ref_fst()

fn sub_ref_snd(&self, lhs: El<Self>, rhs: &El<Self>) -> El<Self>

See RingBase::sub_ref_snd()

fn sub(&self, lhs: El<Self>, rhs: El<Self>) -> El<Self>

See RingBase::sub()

fn mul_ref(&self, lhs: &El<Self>, rhs: &El<Self>) -> El<Self>

See RingBase::mul_ref()

fn mul_ref_fst(&self, lhs: &El<Self>, rhs: El<Self>) -> El<Self>

See RingBase::mul_ref_fst()

fn mul_ref_snd(&self, lhs: El<Self>, rhs: &El<Self>) -> El<Self>

See RingBase::mul_ref_snd()

fn mul(&self, lhs: El<Self>, rhs: El<Self>) -> El<Self>

See RingBase::mul()

fn square(&self, value: &mut El<Self>)

See RingBase::square()

fn fma(&self, lhs: &El<Self>, rhs: &El<Self>, summand: El<Self>) -> El<Self>

See RingBase::fma()

fn coerce<S>(&self, from: &S, el: El<S>) -> El<Self>

where S: RingStore, Self::Type: CanHomFrom<S::Type>,

Tries to map the given element into this ring.

fn into_identity(self) -> Identity<Self>

Returns the identity map self -> self.

fn identity<'a>(&'a self) -> Identity<&'a Self>

Returns the identity map self -> self.

fn into_can_hom<S>(self, from: S) -> Result<CanHom<S, Self>, (S, Self)>

where Self: Sized, S: RingStore, Self::Type: CanHomFrom<S::Type>,

Returns the canonical homomorphism from -> self, if it exists, moving both rings into the CanHom object.

fn into_can_iso<S>(self, from: S) -> Result<CanIso<S, Self>, (S, Self)>

where Self: Sized, S: RingStore, Self::Type: CanIsoFromTo<S::Type>,

Returns the canonical isomorphism from -> self, if it exists, moving both rings into the CanHom object.

fn can_hom<'a, S>(&'a self, from: &'a S) -> Option<CanHom<&'a S, &'a Self>>

where S: RingStore, Self::Type: CanHomFrom<S::Type>,

Returns the canonical homomorphism from -> self, if it exists.

fn can_iso<'a, S>(&'a self, from: &'a S) -> Option<CanIso<&'a S, &'a Self>>

where S: RingStore, Self::Type: CanIsoFromTo<S::Type>,

Returns the canonical isomorphism from -> self, if it exists.

fn into_int_hom(self) -> IntHom<Self>

Returns the homomorphism Z -> self that exists for any ring.

fn int_hom<'a>(&'a self) -> IntHom<&'a Self>

Returns the homomorphism Z -> self that exists for any ring.

fn sum<I>(&self, els: I) -> El<Self>

where I: IntoIterator<Item = El<Self>>,

Computes the sum of all elements returned by the iterator.

fn try_sum<I, E>(&self, els: I) -> Result<El<Self>, E>

where I: IntoIterator<Item = Result<El<Self>, E>>,

Equivalent of RingStore::sum() if the producer of the ring elements can fail, in which case summation is aborted and the error returned.

fn prod<I>(&self, els: I) -> El<Self>

where I: IntoIterator<Item = El<Self>>,

Computes the product of all elements returned by the iterator.

fn pow(&self, x: El<Self>, power: usize) -> El<Self>

Raises the given element to the given power.

fn pow_gen<R: RingStore>( &self, x: El<Self>, power: &El<R>, integers: R, ) -> El<Self>

where R::Type: IntegerRing,

Raises the given element to the given power, which should be a positive integer belonging to an arbitrary IntegerRing.

fn format<'a>( &'a self, value: &'a El<Self>, ) -> RingElementDisplayWrapper<'a, Self>

Returns an object that represents the given ring element and implements std::fmt::Display, to use as formatting parameter.

fn format_within<'a>( &'a self, value: &'a El<Self>, within: EnvBindingStrength, ) -> RingElementDisplayWrapper<'a, Self>

Returns an object that represents the given ring element and implements std::fmt::Display, to use as formatting parameter. As opposed to RingStore::format(), this function takes an additional argument to specify the context the result is printed in, which is used to determine whether to put the value in parenthesis or not.

fn println(&self, value: &El<Self>)

Prints the given element. Use for quick & dirty debugging.

fn characteristic<I: RingStore + Copy>(&self, ZZ: I) -> Option<El<I>>

where I::Type: IntegerRing,

See RingBase::characteristic().

impl<'a, R: RingBase + ?Sized> Copy for RingRef<'a, R>