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_polynomial::RationalPolynomial;
use malachite_base::polynomial::{MulPowerOfX, MulPowerOfXAssign};

impl MulPowerOfX for RationalPolynomial {
    type Output = Self;

    /// Multiplies a [`RationalPolynomial`] by $x^n$, taking it by value. Every coefficient moves up
    /// by $n$ places, and $n$ zeros fill the places below them.
    ///
    /// $$
    /// f(p, n) = x^np.
    /// $$
    ///
    /// Only the numerator changes, so the denominator stays the same and the result is still in
    /// lowest terms. The zero polynomial stays zero, and multiplying by $x^0$ changes nothing.
    ///
    /// # Worst-case complexity
    /// $T(n, m) = O(n + m)$
    ///
    /// $M(n, m) = O(1)$
    ///
    /// where $T$ is time, $M$ is additional memory, $n$ is `n`, and $m$ is the total number of bits
    /// of the numerator's coefficients and the denominator.
    ///
    /// # Panics
    /// Panics if the polynomial is nonzero and `n` is greater than `usize::MAX`.
    ///
    /// # Examples
    /// ```
    /// use core::str::FromStr;
    /// use malachite_base::num::basic::traits::Zero;
    /// use malachite_base::polynomial::MulPowerOfX;
    /// use malachite_q::rational_polynomial::RationalPolynomial;
    ///
    /// assert_eq!(
    ///     RationalPolynomial::from_str("1/2*x^2-1/3")
    ///         .unwrap()
    ///         .mul_power_of_x(2)
    ///         .to_string(),
    ///     "1/2*x^4-1/3*x^2"
    /// );
    /// assert_eq!(
    ///     RationalPolynomial::from_str("-5/3")
    ///         .unwrap()
    ///         .mul_power_of_x(1)
    ///         .to_string(),
    ///     "-5/3*x"
    /// );
    /// assert_eq!(
    ///     RationalPolynomial::ZERO.mul_power_of_x(3),
    ///     RationalPolynomial::ZERO
    /// );
    /// ```
    ///
    /// This is equivalent to `fmpq_poly_shift_left` from `fmpq_poly/shift_left.c`, FLINT 3.6.0.
    #[inline]
    fn mul_power_of_x(mut self, n: u64) -> Self {
        self.mul_power_of_x_assign(n);
        self
    }
}

impl MulPowerOfX for &RationalPolynomial {
    type Output = RationalPolynomial;

    /// Multiplies a [`RationalPolynomial`] by $x^n$, taking it by reference. Every coefficient
    /// moves up by $n$ places, and $n$ zeros fill the places below them.
    ///
    /// $$
    /// f(p, n) = x^np.
    /// $$
    ///
    /// Only the numerator changes, so the denominator stays the same and the result is still in
    /// lowest terms. The zero polynomial stays zero, and multiplying by $x^0$ changes nothing.
    ///
    /// # Worst-case complexity
    /// $T(n, m) = O(n + m)$
    ///
    /// $M(n, m) = O(n + m)$
    ///
    /// where $T$ is time, $M$ is additional memory, $n$ is `n`, and $m$ is the total number of bits
    /// of the numerator's coefficients and the denominator.
    ///
    /// # Panics
    /// Panics if the polynomial is nonzero and `n` is greater than `usize::MAX`.
    ///
    /// # Examples
    /// ```
    /// use core::str::FromStr;
    /// use malachite_base::num::basic::traits::Zero;
    /// use malachite_base::polynomial::MulPowerOfX;
    /// use malachite_q::rational_polynomial::RationalPolynomial;
    ///
    /// assert_eq!(
    ///     (&RationalPolynomial::from_str("1/2*x^2-1/3").unwrap())
    ///         .mul_power_of_x(2)
    ///         .to_string(),
    ///     "1/2*x^4-1/3*x^2"
    /// );
    /// assert_eq!(
    ///     (&RationalPolynomial::from_str("-5/3").unwrap())
    ///         .mul_power_of_x(1)
    ///         .to_string(),
    ///     "-5/3*x"
    /// );
    /// assert_eq!(
    ///     (&RationalPolynomial::ZERO).mul_power_of_x(3),
    ///     RationalPolynomial::ZERO
    /// );
    /// ```
    ///
    /// This is equivalent to `fmpq_poly_shift_left` from `fmpq_poly/shift_left.c`, FLINT 3.6.0.
    fn mul_power_of_x(self, n: u64) -> RationalPolynomial {
        RationalPolynomial {
            numerator: (&self.numerator).mul_power_of_x(n),
            denominator: self.denominator.clone(),
        }
    }
}

impl MulPowerOfXAssign for RationalPolynomial {
    /// Multiplies a [`RationalPolynomial`] by $x^n$ in place. Every coefficient moves up by $n$
    /// places, and $n$ zeros fill the places below them.
    ///
    /// $$
    /// p \gets x^np.
    /// $$
    ///
    /// Only the numerator changes, so the denominator stays the same and the result is still in
    /// lowest terms. The zero polynomial stays zero, and multiplying by $x^0$ changes nothing.
    ///
    /// # Worst-case complexity
    /// $T(n, m) = O(n + m)$
    ///
    /// $M(n, m) = O(n)$
    ///
    /// where $T$ is time, $M$ is additional memory, $n$ is `n`, and $m$ is the total number of bits
    /// of the numerator's coefficients and the denominator.
    ///
    /// # Panics
    /// Panics if the polynomial is nonzero and `n` is greater than `usize::MAX`.
    ///
    /// # Examples
    /// ```
    /// use core::str::FromStr;
    /// use malachite_base::num::basic::traits::Zero;
    /// use malachite_base::polynomial::MulPowerOfXAssign;
    /// use malachite_q::rational_polynomial::RationalPolynomial;
    ///
    /// let mut p = RationalPolynomial::from_str("1/2*x^2-1/3").unwrap();
    /// p.mul_power_of_x_assign(2);
    /// assert_eq!(p.to_string(), "1/2*x^4-1/3*x^2");
    ///
    /// let mut p = RationalPolynomial::from_str("-5/3").unwrap();
    /// p.mul_power_of_x_assign(1);
    /// assert_eq!(p.to_string(), "-5/3*x");
    ///
    /// let mut p = RationalPolynomial::ZERO;
    /// p.mul_power_of_x_assign(3);
    /// assert_eq!(p, RationalPolynomial::ZERO);
    /// ```
    ///
    /// This is equivalent to `fmpq_poly_shift_left` from `fmpq_poly/shift_left.c`, FLINT 3.6.0.
    #[inline]
    fn mul_power_of_x_assign(&mut self, n: u64) {
        self.numerator.mul_power_of_x_assign(n);
    }
}