malachite-q 0.14.0

The arbitrary-precision type Rational, with efficient algorithms partially derived from GMP and FLINT.
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::Rational;
use malachite_base::num::conversion::traits::ConvertibleFrom;
use malachite_nz::gaussian_integer::GaussianInteger;

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct RationalFromGaussianIntegerError;

impl TryFrom<GaussianInteger> for Rational {
    type Error = RationalFromGaussianIntegerError;

    /// Converts a [`GaussianInteger`] to a [`Rational`], taking the [`GaussianInteger`] by value.
    /// If the [`GaussianInteger`] is not real, an error is returned.
    ///
    /// # Worst-case complexity
    /// Constant time and additional memory.
    ///
    /// # Examples
    /// ```
    /// use malachite_nz::gaussian_integer::GaussianInteger;
    /// use malachite_q::Rational;
    /// use malachite_q::rational::conversion::from_gaussian_integer::*;
    /// use std::str::FromStr;
    ///
    /// let x = GaussianInteger::from_str("123").unwrap();
    /// assert_eq!(Rational::try_from(x).unwrap(), 123);
    ///
    /// let x = GaussianInteger::from_str("-123").unwrap();
    /// assert_eq!(Rational::try_from(x).unwrap(), -123);
    ///
    /// let x = GaussianInteger::from_str("2-3i").unwrap();
    /// assert_eq!(Rational::try_from(x), Err(RationalFromGaussianIntegerError));
    /// ```
    fn try_from(x: GaussianInteger) -> Result<Self, Self::Error> {
        if x.imaginary == 0u32 {
            Ok(Self::from(x.real))
        } else {
            Err(RationalFromGaussianIntegerError)
        }
    }
}

impl TryFrom<&GaussianInteger> for Rational {
    type Error = RationalFromGaussianIntegerError;

    /// Converts a [`GaussianInteger`] to a [`Rational`], taking the [`GaussianInteger`] by
    /// reference. If the [`GaussianInteger`] is not real, an error is returned.
    ///
    /// # Worst-case complexity
    /// $T(n) = O(n)$
    ///
    /// $M(n) = O(n)$
    ///
    /// where $T$ is time, $M$ is additional memory, and $n$ is `x.real.significant_bits()`.
    ///
    /// # Examples
    /// ```
    /// use malachite_nz::gaussian_integer::GaussianInteger;
    /// use malachite_q::Rational;
    /// use malachite_q::rational::conversion::from_gaussian_integer::*;
    /// use std::str::FromStr;
    ///
    /// let x = GaussianInteger::from_str("123").unwrap();
    /// assert_eq!(Rational::try_from(&x).unwrap(), 123);
    ///
    /// let x = GaussianInteger::from_str("-123").unwrap();
    /// assert_eq!(Rational::try_from(&x).unwrap(), -123);
    ///
    /// let x = GaussianInteger::from_str("2-3i").unwrap();
    /// assert_eq!(
    ///     Rational::try_from(&x),
    ///     Err(RationalFromGaussianIntegerError)
    /// );
    /// ```
    fn try_from(x: &GaussianInteger) -> Result<Self, Self::Error> {
        if x.imaginary == 0u32 {
            Ok(Self::from(&x.real))
        } else {
            Err(RationalFromGaussianIntegerError)
        }
    }
}

impl ConvertibleFrom<&GaussianInteger> for Rational {
    /// Determines whether a [`GaussianInteger`] can be converted to a [`Rational`] (that is,
    /// whether it is real), taking the [`GaussianInteger`] by reference.
    ///
    /// # Worst-case complexity
    /// Constant time and additional memory.
    ///
    /// # Examples
    /// ```
    /// use malachite_base::num::conversion::traits::ConvertibleFrom;
    /// use malachite_nz::gaussian_integer::GaussianInteger;
    /// use malachite_q::Rational;
    /// use std::str::FromStr;
    ///
    /// let x = GaussianInteger::from_str("123").unwrap();
    /// assert_eq!(Rational::convertible_from(&x), true);
    ///
    /// let x = GaussianInteger::from_str("-123").unwrap();
    /// assert_eq!(Rational::convertible_from(&x), true);
    ///
    /// let x = GaussianInteger::from_str("2-3i").unwrap();
    /// assert_eq!(Rational::convertible_from(&x), false);
    /// ```
    #[inline]
    fn convertible_from(x: &GaussianInteger) -> bool {
        x.imaginary == 0u32
    }
}