Trait malachite_base::num::arithmetic::traits::OverflowingSquare

pub trait OverflowingSquare {
    type Output;

    // Required method
    fn overflowing_square(self) -> (Self::Output, bool);
}

Squares a number.

Returns a tuple of the sum along with a boolean indicating whether an arithmetic overflow occurred. If an overflow occurred, then the wrapped number is returned.

Required Associated Types

type Output

Required Methods

fn overflowing_square(self) -> (Self::Output, bool)

Implementations on Foreign Types

impl OverflowingSquare for i8

fn overflowing_square(self) -> (i8, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i8

impl OverflowingSquare for i16

fn overflowing_square(self) -> (i16, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i16

impl OverflowingSquare for i32

fn overflowing_square(self) -> (i32, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i32

impl OverflowingSquare for i64

fn overflowing_square(self) -> (i64, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i64

impl OverflowingSquare for i128

fn overflowing_square(self) -> (i128, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i128

impl OverflowingSquare for isize

fn overflowing_square(self) -> (isize, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = isize

impl OverflowingSquare for u8

fn overflowing_square(self) -> (u8, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u8

impl OverflowingSquare for u16

fn overflowing_square(self) -> (u16, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u16

impl OverflowingSquare for u32

fn overflowing_square(self) -> (u32, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u32

impl OverflowingSquare for u64

fn overflowing_square(self) -> (u64, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u64

impl OverflowingSquare for u128

fn overflowing_square(self) -> (u128, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = u128

impl OverflowingSquare for usize

fn overflowing_square(self) -> (usize, bool)

Squares a number.

Returns a tuple containing the result and a boolean indicating whether an arithmetic occurred. If an overflow occurred, then the wrapped value is returned.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = usize

Implementors