Trait malachite_base::num::arithmetic::traits::FloorSqrt

pub trait FloorSqrt {
    type Output;

    // Required method
    fn floor_sqrt(self) -> Self::Output;
}

Finds the floor of the square root of a number.

Required Associated Types

type Output

Required Methods

fn floor_sqrt(self) -> Self::Output

Implementations on Foreign Types

impl FloorSqrt for i8

fn floor_sqrt(self) -> Self

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Panics

Panics if self is negative.

Examples

See here.

type Output = i8

impl FloorSqrt for i16

fn floor_sqrt(self) -> Self

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Panics

Panics if self is negative.

Examples

See here.

type Output = i16

impl FloorSqrt for i32

fn floor_sqrt(self) -> Self

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Panics

Panics if self is negative.

Examples

See here.

type Output = i32

impl FloorSqrt for i64

fn floor_sqrt(self) -> Self

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Panics

Panics if self is negative.

Examples

See here.

type Output = i64

impl FloorSqrt for i128

fn floor_sqrt(self) -> Self

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Panics

Panics if self is negative.

Examples

See here.

type Output = i128

impl FloorSqrt for isize

fn floor_sqrt(self) -> Self

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Panics

Panics if self is negative.

Examples

See here.

type Output = isize

impl FloorSqrt for u8

fn floor_sqrt(self) -> u8

Returns the floor of the square root of a u8.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

Notes

The u8 implementation uses a lookup table.

type Output = u8

impl FloorSqrt for u16

fn floor_sqrt(self) -> u16

Returns the floor of the square root of a u16.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

Notes

The u16 implementation calls the implementation for u32s.

type Output = u16

impl FloorSqrt for u32

fn floor_sqrt(self) -> u32

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

Notes

For u32 and u64, the square root is computed using Newton’s method.

type Output = u32

impl FloorSqrt for u64

fn floor_sqrt(self) -> u64

Returns the floor of the square root of an integer.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

Notes

For u32 and u64, the square root is computed using Newton’s method.

type Output = u64

impl FloorSqrt for u128

fn floor_sqrt(self) -> u128

Returns the floor of the square root of a u128.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

$T(n) = O(n)$

$M(n) = O(1)$

where $T$ is time, $M$ is additional memory, and $n$ is self.significant_bits().

Examples

See here.

Notes

For u128, using a floating-point approximation and refining the result works, but the number of necessary adjustments becomes large for large u128s. To overcome this, large u128s switch to a binary search algorithm. To get decent starting bounds, the following fact is used:

If $x$ is nonzero and has $b$ significant bits, then

$2^{b-1} \leq x \leq 2^b-1$,

$2^{b-1} \leq x \leq 2^b$,

$2^{2\lfloor (b-1)/2 \rfloor} \leq x \leq 2^{2\lceil b/2 \rceil}$,

$2^{2(\lceil b/2 \rceil-1)} \leq x \leq 2^{2\lceil b/2 \rceil}$,

$\lfloor\sqrt{2^{2(\lceil b/2 \rceil-1)}}\rfloor \leq \lfloor\sqrt{x}\rfloor \leq \lfloor\sqrt{2^{2\lceil b/2 \rceil}}\rfloor$, since $x \mapsto \lfloor\sqrt{x}\rfloor$ is weakly increasing,

$2^{\lceil b/2 \rceil-1} \leq \lfloor\sqrt{x}\rfloor \leq 2^{\lceil b/2 \rceil}$.

For example, since $10^9$ has 30 significant bits, we know that $2^{14} \leq \lfloor\sqrt{10^9}\rfloor \leq 2^{15}$.

type Output = u128

impl FloorSqrt for usize

fn floor_sqrt(self) -> usize

Returns the floor of the square root of a usize.

$f(x) = \lfloor\sqrt{x}\rfloor$.

Worst-case complexity

Constant time and additional memory.

Examples

See here.

Notes

The usize implementation calls the u32 or u64 implementations.

type Output = usize

Implementors