Trait malachite_base::num::arithmetic::traits::CheckedAddMul

pub trait CheckedAddMul<Y = Self, Z = Self> {
    type Output;

    // Required method
    fn checked_add_mul(self, y: Y, z: Z) -> Option<Self::Output>;
}

Adds a number and the product of two other numbers, returning None if the result is not representable.

Required Associated Types

type Output

Required Methods

fn checked_add_mul(self, y: Y, z: Z) -> Option<Self::Output>

Implementations on Foreign Types

impl CheckedAddMul for i8

fn checked_add_mul(self, y: i8, z: i8) -> Option<i8>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad -2^{W-1} \leq x + yz < 2^{W-1}, \\ \operatorname{None} & \text{if} \quad x + yz < -2^{W-1} \ \mathrm{or} \ x + yz \geq 2^{W-1}, \\ \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i8

impl CheckedAddMul for i16

fn checked_add_mul(self, y: i16, z: i16) -> Option<i16>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad -2^{W-1} \leq x + yz < 2^{W-1}, \\ \operatorname{None} & \text{if} \quad x + yz < -2^{W-1} \ \mathrm{or} \ x + yz \geq 2^{W-1}, \\ \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i16

impl CheckedAddMul for i32

fn checked_add_mul(self, y: i32, z: i32) -> Option<i32>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad -2^{W-1} \leq x + yz < 2^{W-1}, \\ \operatorname{None} & \text{if} \quad x + yz < -2^{W-1} \ \mathrm{or} \ x + yz \geq 2^{W-1}, \\ \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i32

impl CheckedAddMul for i64

fn checked_add_mul(self, y: i64, z: i64) -> Option<i64>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad -2^{W-1} \leq x + yz < 2^{W-1}, \\ \operatorname{None} & \text{if} \quad x + yz < -2^{W-1} \ \mathrm{or} \ x + yz \geq 2^{W-1}, \\ \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i64

impl CheckedAddMul for i128

fn checked_add_mul(self, y: i128, z: i128) -> Option<i128>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad -2^{W-1} \leq x + yz < 2^{W-1}, \\ \operatorname{None} & \text{if} \quad x + yz < -2^{W-1} \ \mathrm{or} \ x + yz \geq 2^{W-1}, \\ \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i128

impl CheckedAddMul for isize

fn checked_add_mul(self, y: isize, z: isize) -> Option<isize>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad -2^{W-1} \leq x + yz < 2^{W-1}, \\ \operatorname{None} & \text{if} \quad x + yz < -2^{W-1} \ \mathrm{or} \ x + yz \geq 2^{W-1}, \\ \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = isize

impl CheckedAddMul for u8

fn checked_add_mul(self, y: u8, z: u8) -> Option<u8>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad x + yz < 2^W, \\ \operatorname{None} & \text{if} \quad x + yz \geq 2^W, \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u8

impl CheckedAddMul for u16

fn checked_add_mul(self, y: u16, z: u16) -> Option<u16>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad x + yz < 2^W, \\ \operatorname{None} & \text{if} \quad x + yz \geq 2^W, \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u16

impl CheckedAddMul for u32

fn checked_add_mul(self, y: u32, z: u32) -> Option<u32>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad x + yz < 2^W, \\ \operatorname{None} & \text{if} \quad x + yz \geq 2^W, \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u32

impl CheckedAddMul for u64

fn checked_add_mul(self, y: u64, z: u64) -> Option<u64>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad x + yz < 2^W, \\ \operatorname{None} & \text{if} \quad x + yz \geq 2^W, \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u64

impl CheckedAddMul for u128

fn checked_add_mul(self, y: u128, z: u128) -> Option<u128>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad x + yz < 2^W, \\ \operatorname{None} & \text{if} \quad x + yz \geq 2^W, \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u128

impl CheckedAddMul for usize

fn checked_add_mul(self, y: usize, z: usize) -> Option<usize>

Adds a number and the product of two other numbers, returning None if the result cannot be represented.

$$ f(x, y, z) = \begin{cases} \operatorname{Some}(x + yz) & \text{if} \quad x + yz < 2^W, \\ \operatorname{None} & \text{if} \quad x + yz \geq 2^W, \end{cases} $$ where $W$ is Self::WIDTH.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = usize

Implementors