Struct RingElementWrapper 

pub struct RingElementWrapper<R>
where
    R: RingStore,
{ /* private fields */ }

Stores a ring element together with its ring, so that ring operations do not require explicit mention of the ring object. This can be used both for convenience of notation (i.e. use a + b instead of ring.add(a, b)) and might also be necessary when e.g. storing elements in a set.

Examples

let ring = DensePolyRing::new(StaticRing::<i64>::RING, "X");
let x = RingElementWrapper::new(&ring, ring.indeterminate());
println!("The result is: {}", x.clone() + x.clone() * x);
// instead of
let x = ring.indeterminate();
println!("The result is: {}", ring.format(&ring.add(ring.mul(ring.clone_el(&x), ring.clone_el(&x)), ring.clone_el(&x))));

You can also retrieve the wrapped element

let ring = DensePolyRing::new(StaticRing::<i64>::RING, "X");
let x = RingElementWrapper::new(&ring, ring.indeterminate());
assert_el_eq!(&ring, ring.add(ring.mul(ring.clone_el(&x), ring.clone_el(&x)), ring.clone_el(&x)), (x.clone() + x.clone() * x).unwrap());

Implementations

impl<R: RingStore> RingElementWrapper<R>

pub const fn new(ring: R, element: El<R>) -> Self

Creates a new RingElementWrapper wrapping the given element of the given ring.

pub fn pow(self, power: usize) -> Self

Raises the stored element to the given power.

Consider using RingElementWrapper::pow_ref() if you don’t want to move the element.

pub fn pow_ref(&self, power: usize) -> Self

where R: Clone,

Raises the stored element to the given power.

pub fn unwrap(self) -> El<R>

Returns the stored element.

pub fn unwrap_ref(&self) -> &El<R>

Returns the stored element as reference.

pub fn parent(&self) -> &R

Returns a reference to the ring that this element belongs to.

pub fn is_zero(&self) -> bool

Returns true if this element is zero.

Equivalent to self.parent().is_zero(self.unwrap_ref()).

pub fn is_one(&self) -> bool

Returns true if this element is one.

Equivalent to self.parent().is_one(self.unwrap_ref()).

pub fn is_neg_one(&self) -> bool

Returns true if this element is negative one.

Equivalent to self.parent().is_neg_one(self.unwrap_ref()).

Trait Implementations

impl<'a, 'b, R: RingStore + Clone> Add<&'a RingElementWrapper<R>> for &'b RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

fn add(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the + operation.

impl<'a, R: RingStore> Add<&'a RingElementWrapper<R>> for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

fn add(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the + operation.

impl<'a, R: RingStore + Clone> Add<&'a RingElementWrapper<R>> for i32

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

fn add(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the + operation.

impl<'a, R: RingStore> Add<RingElementWrapper<R>> for &'a RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<R: RingStore> Add<RingElementWrapper<R>> for i32

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, R: RingStore + Clone> Add<i32> for &'a RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<R: RingStore> Add<i32> for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<R: RingStore> Add for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, R: RingStore> AddAssign<&'a RingElementWrapper<R>> for RingElementWrapper<R>

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

Performs the += operation.

impl<R: RingStore> AddAssign<i32> for RingElementWrapper<R>

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

impl<R: RingStore> AddAssign for RingElementWrapper<R>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<R: RingStore + Clone> Clone for RingElementWrapper<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: RingStore> Debug for RingElementWrapper<R>

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

Formats the value using the given formatter.

impl<R: RingStore> Deref for RingElementWrapper<R>

type Target = <<R as RingStore>::Type as RingBase>::Element

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<R: RingStore> Display for RingElementWrapper<R>

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

Formats the value using the given formatter.

impl<'a, 'b, R: RingStore + Clone> Div<&'a RingElementWrapper<R>> for &'b RingElementWrapper<R>

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the / operation.

impl<'a, R: RingStore + Clone> Div<&'a RingElementWrapper<R>> for RingElementWrapper<R>

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the / operation.

impl<'a, R: RingStore + Clone> Div<&'a RingElementWrapper<R>> for i32

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the / operation.

impl<'a, R: RingStore + Clone> Div<RingElementWrapper<R>> for &'a RingElementWrapper<R>

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: RingElementWrapper<R>) -> Self::Output

Performs the / operation.

impl<R: RingStore> Div<RingElementWrapper<R>> for i32

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: RingElementWrapper<R>) -> Self::Output

Performs the / operation.

impl<'a, R: RingStore + Clone> Div<i32> for &'a RingElementWrapper<R>

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> Self::Output

Performs the / operation.

impl<R: RingStore> Div<i32> for RingElementWrapper<R>

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> Self::Output

Performs the / operation.

impl<R: RingStore> Div for RingElementWrapper<R>

where R::Type: Field,

type Output = RingElementWrapper<R>

The resulting type after applying the / operator.

fn div(self, rhs: RingElementWrapper<R>) -> Self::Output

Performs the / operation.

impl<R: RingStore> Hash for RingElementWrapper<R>

where R::Type: HashableElRing,

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<'a, 'b, R: RingStore + Clone> Mul<&'a RingElementWrapper<R>> for &'b RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the * operation.

impl<'a, R: RingStore> Mul<&'a RingElementWrapper<R>> for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the * operation.

impl<'a, R: RingStore + Clone> Mul<&'a RingElementWrapper<R>> for i32

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the * operation.

impl<'a, R: RingStore> Mul<RingElementWrapper<R>> for &'a RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: RingElementWrapper<R>) -> Self::Output

Performs the * operation.

impl<R: RingStore> Mul<RingElementWrapper<R>> for i32

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: RingElementWrapper<R>) -> Self::Output

Performs the * operation.

impl<'a, R: RingStore + Clone> Mul<i32> for &'a RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Self::Output

Performs the * operation.

impl<R: RingStore> Mul<i32> for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Self::Output

Performs the * operation.

impl<R: RingStore> Mul for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, R: RingStore> MulAssign<&'a RingElementWrapper<R>> for RingElementWrapper<R>

fn mul_assign(&mut self, rhs: &'a Self)

Performs the *= operation.

impl<R: RingStore> MulAssign<i32> for RingElementWrapper<R>

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl<R: RingStore> MulAssign for RingElementWrapper<R>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<R: RingStore> PartialEq<RingElementWrapper<R>> for i32

fn eq(&self, other: &RingElementWrapper<R>) -> 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<R: RingStore> PartialEq<i32> for RingElementWrapper<R>

fn eq(&self, other: &i32) -> 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<R: RingStore> PartialEq for RingElementWrapper<R>

fn eq(&self, other: &Self) -> 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<'a, 'b, R: RingStore + Clone> Sub<&'a RingElementWrapper<R>> for &'b RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the - operation.

impl<'a, R: RingStore> Sub<&'a RingElementWrapper<R>> for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the - operation.

impl<'a, R: RingStore + Clone> Sub<&'a RingElementWrapper<R>> for i32

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a RingElementWrapper<R>) -> Self::Output

Performs the - operation.

impl<'a, R: RingStore> Sub<RingElementWrapper<R>> for &'a RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<R: RingStore> Sub<RingElementWrapper<R>> for i32

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, R: RingStore + Clone> Sub<i32> for &'a RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<R: RingStore> Sub<i32> for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<R: RingStore> Sub for RingElementWrapper<R>

type Output = RingElementWrapper<R>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, R: RingStore> SubAssign<&'a RingElementWrapper<R>> for RingElementWrapper<R>

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

Performs the -= operation.

impl<R: RingStore> SubAssign<i32> for RingElementWrapper<R>

fn sub_assign(&mut self, rhs: i32)

Performs the -= operation.

impl<R: RingStore> SubAssign for RingElementWrapper<R>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<R: RingStore + Copy> Copy for RingElementWrapper<R>

where El<R>: Copy,

impl<R: RingStore> Eq for RingElementWrapper<R>