Trait malachite_base::num::arithmetic::traits::CheckedSquare

pub trait CheckedSquare {
    type Output;

    // Required method
    fn checked_square(self) -> Option<Self::Output>;
}

Squares a number, returning None if the result is not representable.

Required Associated Types

type Output

Required Methods

fn checked_square(self) -> Option<Self::Output>

Implementations on Foreign Types

impl CheckedSquare for i8

fn checked_square(self) -> Option<i8>

Squares a number, returning None if the result cannot be represented.

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

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i8

impl CheckedSquare for i16

fn checked_square(self) -> Option<i16>

Squares a number, returning None if the result cannot be represented.

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

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i16

impl CheckedSquare for i32

fn checked_square(self) -> Option<i32>

Squares a number, returning None if the result cannot be represented.

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

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i32

impl CheckedSquare for i64

fn checked_square(self) -> Option<i64>

Squares a number, returning None if the result cannot be represented.

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

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i64

impl CheckedSquare for i128

fn checked_square(self) -> Option<i128>

Squares a number, returning None if the result cannot be represented.

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

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = i128

impl CheckedSquare for isize

fn checked_square(self) -> Option<isize>

Squares a number, returning None if the result cannot be represented.

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

Worst-case complexity

Constant time and additional memory.

Examples

See here.

type Output = isize

impl CheckedSquare for u8

fn checked_square(self) -> Option<u8>

Squares a number, returning None if the result cannot be represented.

$$ f(x) = \begin{cases} \operatorname{Some}(x^2) & \text{if} \quad x^2 < 2^W, \\ \operatorname{None} & \text{if} \quad x^2 \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 CheckedSquare for u16

fn checked_square(self) -> Option<u16>

Squares a number, returning None if the result cannot be represented.

$$ f(x) = \begin{cases} \operatorname{Some}(x^2) & \text{if} \quad x^2 < 2^W, \\ \operatorname{None} & \text{if} \quad x^2 \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 CheckedSquare for u32

fn checked_square(self) -> Option<u32>

Squares a number, returning None if the result cannot be represented.

$$ f(x) = \begin{cases} \operatorname{Some}(x^2) & \text{if} \quad x^2 < 2^W, \\ \operatorname{None} & \text{if} \quad x^2 \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 CheckedSquare for u64

fn checked_square(self) -> Option<u64>

Squares a number, returning None if the result cannot be represented.

$$ f(x) = \begin{cases} \operatorname{Some}(x^2) & \text{if} \quad x^2 < 2^W, \\ \operatorname{None} & \text{if} \quad x^2 \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 CheckedSquare for u128

fn checked_square(self) -> Option<u128>

Squares a number, returning None if the result cannot be represented.

$$ f(x) = \begin{cases} \operatorname{Some}(x^2) & \text{if} \quad x^2 < 2^W, \\ \operatorname{None} & \text{if} \quad x^2 \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 CheckedSquare for usize

fn checked_square(self) -> Option<usize>

Squares a number, returning None if the result cannot be represented.

$$ f(x) = \begin{cases} \operatorname{Some}(x^2) & \text{if} \quad x^2 < 2^W, \\ \operatorname{None} & \text{if} \quad x^2 \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