Trait sp_std::ops::Rem

1.0.0 · source · [−]

pub trait Rem<Rhs = Self> {
    type Output;
    fn rem(self, rhs: Rhs) -> Self::Output;
}

Expand description

The remainder operator %.

Note that Rhs is Self by default, but this is not mandatory.

Examples

This example implements Rem on a SplitSlice object. After Rem is implemented, one can use the % operator to find out what the remaining elements of the slice would be after splitting it into equal slices of a given length.

use std::ops::Rem;

#[derive(PartialEq, Debug)]
struct SplitSlice<'a, T: 'a> {
    slice: &'a [T],
}

impl<'a, T> Rem<usize> for SplitSlice<'a, T> {
    type Output = Self;

    fn rem(self, modulus: usize) -> Self::Output {
        let len = self.slice.len();
        let rem = len % modulus;
        let start = len - rem;
        Self {slice: &self.slice[start..]}
    }
}

// If we were to divide &[0, 1, 2, 3, 4, 5, 6, 7] into slices of size 3,
// the remainder would be &[6, 7].
assert_eq!(SplitSlice { slice: &[0, 1, 2, 3, 4, 5, 6, 7] } % 3,
           SplitSlice { slice: &[6, 7] });

Associated Types

source

type Output

The resulting type after applying the % operator.

Required methods

source

fn rem(self, rhs: Rhs) -> Self::Output

Performs the % operation.

Example

assert_eq!(12 % 10, 2);

Implementations on Foreign Types

const: unstable · source

impl<'a> Rem<u32> for &'a u32

type Output = <u32 as Rem<u32>>::Output

const: unstable · source

pub fn rem(self, other: u32) -> <u32 as Rem<u32>>::Output

const: unstable · source

impl<'a> Rem<u16> for &'a u16

type Output = <u16 as Rem<u16>>::Output

const: unstable · source

pub fn rem(self, other: u16) -> <u16 as Rem<u16>>::Output

1.51.0 (const: unstable) · source

impl Rem<NonZeroU8> for u8

const: unstable · source

pub fn rem(self, other: NonZeroU8) -> u8

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

type Output = u8

source

impl<'_, T, const LANES: usize> Rem<Simd<T, LANES>> for &'_ Simd<T, LANES> where
    T: SimdElement,
    Simd<T, LANES>: Rem<Simd<T, LANES>>,
    LaneCount<LANES>: SupportedLaneCount,
    <Simd<T, LANES> as Rem<Simd<T, LANES>>>::Output == Simd<T, LANES>,

type Output = Simd<T, LANES>

source

pub fn rem(
self,
rhs: Simd<T, LANES>
) -> <&'_ Simd<T, LANES> as Rem<Simd<T, LANES>>>::Output

const: unstable · source

impl Rem<i32> for i32

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i32

const: unstable · source

pub fn rem(self, other: i32) -> i32

const: unstable · source

impl<'a> Rem<i64> for &'a i64

type Output = <i64 as Rem<i64>>::Output

const: unstable · source

pub fn rem(self, other: i64) -> <i64 as Rem<i64>>::Output

const: unstable · source

impl<'_> Rem<&'_ i64> for i64

type Output = <i64 as Rem<i64>>::Output

const: unstable · source

pub fn rem(self, other: &i64) -> <i64 as Rem<i64>>::Output

const: unstable · source

impl<'_> Rem<&'_ u16> for u16

type Output = <u16 as Rem<u16>>::Output

const: unstable · source

pub fn rem(self, other: &u16) -> <u16 as Rem<u16>>::Output

const: unstable · source

impl<'_, '_> Rem<&'_ u64> for &'_ u64

type Output = <u64 as Rem<u64>>::Output

const: unstable · source

pub fn rem(self, other: &u64) -> <u64 as Rem<u64>>::Output

const: unstable · source

impl Rem<u16> for u16

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u16

const: unstable · source

pub fn rem(self, other: u16) -> u16

1.51.0 (const: unstable) · source

impl Rem<NonZeroU16> for u16

const: unstable · source

pub fn rem(self, other: NonZeroU16) -> u16

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

type Output = u16

const: unstable · source

impl<'_> Rem<&'_ i16> for i16

type Output = <i16 as Rem<i16>>::Output

const: unstable · source

pub fn rem(self, other: &i16) -> <i16 as Rem<i16>>::Output

1.51.0 (const: unstable) · source

impl Rem<NonZeroU128> for u128

const: unstable · source

pub fn rem(self, other: NonZeroU128) -> u128

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

type Output = u128

source

impl<const N: usize> Rem<Simd<i16, N>> for Simd<i16, N> where
i16: SimdElement,
LaneCount<N>: SupportedLaneCount,

type Output = Simd<i16, N>

source

pub fn rem(
self,
rhs: Simd<i16, N>
) -> <Simd<i16, N> as Rem<Simd<i16, N>>>::Output

source

impl<const N: usize> Rem<Simd<u64, N>> for Simd<u64, N> where
u64: SimdElement,
LaneCount<N>: SupportedLaneCount,

type Output = Simd<u64, N>

source

pub fn rem(
self,
rhs: Simd<u64, N>
) -> <Simd<u64, N> as Rem<Simd<u64, N>>>::Output

const: unstable · source

impl<'_> Rem<&'_ u128> for u128

type Output = <u128 as Rem<u128>>::Output

const: unstable · source

pub fn rem(self, other: &u128) -> <u128 as Rem<u128>>::Output

const: unstable · source

impl<'_, '_> Rem<&'_ f64> for &'_ f64

type Output = <f64 as Rem<f64>>::Output

const: unstable · source

pub fn rem(self, other: &f64) -> <f64 as Rem<f64>>::Output

source

impl<const N: usize> Rem<Simd<u8, N>> for Simd<u8, N> where
u8: SimdElement,
LaneCount<N>: SupportedLaneCount,

type Output = Simd<u8, N>

source

pub fn rem(self, rhs: Simd<u8, N>) -> <Simd<u8, N> as Rem<Simd<u8, N>>>::Output

const: unstable · source

impl<'a> Rem<i8> for &'a i8

type Output = <i8 as Rem<i8>>::Output

const: unstable · source

pub fn rem(self, other: i8) -> <i8 as Rem<i8>>::Output

const: unstable · source

impl<'a> Rem<u64> for &'a u64

type Output = <u64 as Rem<u64>>::Output

const: unstable · source

pub fn rem(self, other: u64) -> <u64 as Rem<u64>>::Output

const: unstable · source

impl<'a> Rem<f32> for &'a f32

type Output = <f32 as Rem<f32>>::Output

const: unstable · source

pub fn rem(self, other: f32) -> <f32 as Rem<f32>>::Output

const: unstable · source

impl Rem<i128> for i128

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i128

const: unstable · source

pub fn rem(self, other: i128) -> i128

source

impl<const N: usize> Rem<Simd<i32, N>> for Simd<i32, N> where
i32: SimdElement,
LaneCount<N>: SupportedLaneCount,

type Output = Simd<i32, N>

source

pub fn rem(
self,
rhs: Simd<i32, N>
) -> <Simd<i32, N> as Rem<Simd<i32, N>>>::Output

const: unstable · source

impl<'_, '_> Rem<&'_ i32> for &'_ i32

type Output = <i32 as Rem<i32>>::Output

const: unstable · source

pub fn rem(self, other: &i32) -> <i32 as Rem<i32>>::Output

const: unstable · source

impl<'_> Rem<&'_ i32> for i32

type Output = <i32 as Rem<i32>>::Output

const: unstable · source

pub fn rem(self, other: &i32) -> <i32 as Rem<i32>>::Output

const: unstable · source

impl Rem<u32> for u32

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u32

const: unstable · source

pub fn rem(self, other: u32) -> u32

const: unstable · source

impl<'a> Rem<i128> for &'a i128

type Output = <i128 as Rem<i128>>::Output

const: unstable · source

pub fn rem(self, other: i128) -> <i128 as Rem<i128>>::Output

1.51.0 (const: unstable) · source

impl Rem<NonZeroU32> for u32

const: unstable · source

pub fn rem(self, other: NonZeroU32) -> u32

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

type Output = u32

const: unstable · source

impl Rem<isize> for isize

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = isize

const: unstable · source

pub fn rem(self, other: isize) -> isize

source

impl<'lhs, 'rhs, T, const LANES: usize> Rem<&'rhs Simd<T, LANES>> for &'lhs Simd<T, LANES> where
    T: SimdElement,
    Simd<T, LANES>: Rem<Simd<T, LANES>>,
    LaneCount<LANES>: SupportedLaneCount,
    <Simd<T, LANES> as Rem<Simd<T, LANES>>>::Output == Simd<T, LANES>,

type Output = Simd<T, LANES>

source

pub fn rem(
self,
rhs: &Simd<T, LANES>
) -> <&'lhs Simd<T, LANES> as Rem<&'rhs Simd<T, LANES>>>::Output

source

impl<const N: usize> Rem<Simd<u16, N>> for Simd<u16, N> where
u16: SimdElement,
LaneCount<N>: SupportedLaneCount,

type Output = Simd<u16, N>

source

pub fn rem(
self,
rhs: Simd<u16, N>
) -> <Simd<u16, N> as Rem<Simd<u16, N>>>::Output

const: unstable · source

impl<'a> Rem<isize> for &'a isize

type Output = <isize as Rem<isize>>::Output

const: unstable · source

pub fn rem(self, other: isize) -> <isize as Rem<isize>>::Output

const: unstable · source

impl<'_, '_> Rem<&'_ u32> for &'_ u32

type Output = <u32 as Rem<u32>>::Output

const: unstable · source

pub fn rem(self, other: &u32) -> <u32 as Rem<u32>>::Output

const: unstable · source

impl Rem<f64> for f64

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);

type Output = f64

const: unstable · source

pub fn rem(self, other: f64) -> f64

const: unstable · source

impl Rem<u128> for u128

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0.

type Output = u128

const: unstable · source

pub fn rem(self, other: u128) -> u128

const: unstable · source

impl Rem<i16> for i16

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i16

const: unstable · source

pub fn rem(self, other: i16) -> i16

source

impl<const N: usize> Rem<Simd<u32, N>> for Simd<u32, N> where
u32: SimdElement,
LaneCount<N>: SupportedLaneCount,

type Output = Simd<u32, N>

source

pub fn rem(
self,
rhs: Simd<u32, N>
) -> <Simd<u32, N> as Rem<Simd<u32, N>>>::Output

const: unstable · source

impl Rem<f32> for f32

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);