malachite-float 0.9.1

The arbitrary-precision floating-point type Float, with efficient algorithms partially derived from MPFR.
Documentation
// Copyright © 2026 Mikhail Hogrefe
//
// This file is part of Malachite.
//
// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.

use crate::Float;
use core::cmp::Ordering;
use malachite_base::num::basic::traits::Two;
use malachite_base::rounding_modes::RoundingMode::{self, *};

impl Float {
    /// Returns an approximation of half of the square root of 2, with the given precision and
    /// rounded using the given [`RoundingMode`]. An [`Ordering`] is also returned, indicating
    /// whether the rounded value is less than or greater than the exact value of the constant.
    /// (Since the constant is irrational, the rounded value is never equal to the exact value.)
    ///
    /// $$
    /// x = \sqrt{2}/2+\varepsilon=\sqrt{1/2}+\varepsilon=1/\sqrt{2}+\varepsilon.
    /// $$
    /// - If $m$ is not `Nearest`, then $|\varepsilon| < 2^{-p}$.
    /// - If $m$ is `Nearest`, then $|\varepsilon| < 2^{-p-1}$.
    ///
    /// The constant is irrational and algebraic.
    ///
    /// The output has precision `prec`.
    ///
    /// # Worst-case complexity
    /// $T(n) = O(n \log n \log\log n)$
    ///
    /// $M(n) = O(n \log n)$
    ///
    /// where $T$ is time, $M$ is additional memory, and $n$ is `prec`.
    ///
    /// # Panics
    /// Panics if `prec` is zero or if `rm` is `Exact`.
    ///
    /// # Examples
    /// ```
    /// use malachite_base::rounding_modes::RoundingMode::*;
    /// use malachite_float::Float;
    /// use std::cmp::Ordering::*;
    ///
    /// let (sqrt_2_over_2, o) = Float::sqrt_2_over_2_prec_round(100, Floor);
    /// assert_eq!(
    ///     sqrt_2_over_2.to_string(),
    ///     "0.7071067811865475244008443621046"
    /// );
    /// assert_eq!(o, Less);
    ///
    /// let (sqrt_2_over_2, o) = Float::sqrt_2_over_2_prec_round(100, Ceiling);
    /// assert_eq!(
    ///     sqrt_2_over_2.to_string(),
    ///     "0.7071067811865475244008443621054"
    /// );
    /// assert_eq!(o, Greater);
    /// ```
    #[inline]
    pub fn sqrt_2_over_2_prec_round(prec: u64, rm: RoundingMode) -> (Self, Ordering) {
        let (sqrt_2, o) = Self::sqrt_prec_round(Self::TWO, prec, rm);
        (sqrt_2 >> 1u32, o)
    }

    /// Returns an approximation of half of the square root of 2, with the given precision and
    /// rounded to the nearest [`Float`] of that precision. An [`Ordering`] is also returned,
    /// indicating whether the rounded value is less than or greater than the exact value of the
    /// constant. (Since the constant is irrational, the rounded value is never equal to the exact
    /// value.)
    ///
    /// $$
    /// x = \sqrt{2}/2+\varepsilon=\sqrt{1/2}+\varepsilon=1/\sqrt{2}+\varepsilon.
    /// $$
    /// - $|\varepsilon| < 2^{-p-1}$.
    ///
    /// The constant is irrational and algebraic.
    ///
    /// The output has precision `prec`.
    ///
    /// # Worst-case complexity
    /// $T(n) = O(n \log n \log\log n)$
    ///
    /// $M(n) = O(n \log n)$
    ///
    /// where $T$ is time, $M$ is additional memory, and $n$ is `prec`.
    ///
    /// # Panics
    /// Panics if `prec` is zero.
    ///
    /// # Examples
    /// ```
    /// use malachite_float::Float;
    /// use std::cmp::Ordering::*;
    ///
    /// let (sqrt_2_over_2, o) = Float::sqrt_2_over_2_prec(1);
    /// assert_eq!(sqrt_2_over_2.to_string(), "0.5");
    /// assert_eq!(o, Less);
    ///
    /// let (sqrt_2_over_2, o) = Float::sqrt_2_over_2_prec(10);
    /// assert_eq!(sqrt_2_over_2.to_string(), "0.707");
    /// assert_eq!(o, Less);
    ///
    /// let (sqrt_2_over_2, o) = Float::sqrt_2_over_2_prec(100);
    /// assert_eq!(
    ///     sqrt_2_over_2.to_string(),
    ///     "0.7071067811865475244008443621046"
    /// );
    /// assert_eq!(o, Less);
    /// ```
    #[inline]
    pub fn sqrt_2_over_2_prec(prec: u64) -> (Self, Ordering) {
        Self::sqrt_2_over_2_prec_round(prec, Nearest)
    }
}