1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
// Copyright © 2016–2023 Trevor Spiteri
// This program is free software: you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option) any
// later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License and
// a copy of the GNU General Public License along with this program. If not, see
// <https://www.gnu.org/licenses/>.
use crate::Float;
use core::fmt::{
Binary, Debug, Display, Formatter, LowerExp, LowerHex, Octal, Pointer, Result as FmtResult,
UpperExp, UpperHex,
};
use core::marker::PhantomData;
use core::ops::Deref;
use gmp_mpfr_sys::mpfr::mpfr_t;
/// Used to get a reference to a [`Float`].
///
/// The struct implements <code>[Deref]\<[Target][Deref::Target] = [Float]></code>.
///
/// No memory is unallocated when this struct is dropped.
///
/// # Examples
///
/// ```rust
/// use rug::float::BorrowFloat;
/// use rug::Float;
/// let f = Float::with_val(53, 4.2);
/// let neg: BorrowFloat = f.as_neg();
/// // f is still valid
/// assert_eq!(f, 4.2);
/// assert_eq!(*neg, -4.2);
/// ```
#[derive(Clone, Copy)]
#[repr(transparent)]
pub struct BorrowFloat<'a> {
inner: mpfr_t,
phantom: PhantomData<&'a Float>,
}
impl<'a> BorrowFloat<'a> {
/// Create a borrow from a raw [MPFR floating-point number][mpfr_t].
///
/// # Safety
///
/// * The value must be initialized as a valid [`mpfr_t`].
/// * The [`mpfr_t`] type can be considered as a kind of pointer, so there
/// can be multiple copies of it. [`BorrowFloat`] cannot mutate the
/// value, so there can be other copies, but none of them are allowed to
/// mutate the value.
/// * The lifetime is obtained from the return type. The user must ensure
/// the value remains valid for the duration of the lifetime.
///
/// # Examples
///
/// ```rust
/// use rug::float::BorrowFloat;
/// use rug::Float;
/// let f = Float::with_val(53, 4.2);
/// // Safety: f.as_raw() is a valid pointer.
/// let raw = unsafe { *f.as_raw() };
/// // Safety: f is still valid when borrow is used.
/// let borrow = unsafe { BorrowFloat::from_raw(raw) };
/// assert_eq!(f, *borrow);
/// ```
pub const unsafe fn from_raw(raw: mpfr_t) -> BorrowFloat<'a> {
BorrowFloat {
inner: raw,
phantom: PhantomData,
}
}
/// Gets a reference to [`Float`] from a `BorrowFloat`.
///
/// This is equivalent to taking the reference of the dereferencing operator
/// `*` or to <code>[Deref]::[deref][Deref::deref]</code>, but can also be
/// used in constant context. Unless required in constant context, use the
/// operator or trait instead.
///
/// # Planned deprecation
///
/// This method will be deprecated when the unary `*` operator and the
/// [`Deref`] trait are usable in constant context.
///
/// # Examples
///
/// ```rust
/// use core::ops::Deref;
/// use core::ptr;
/// use rug::float::BorrowFloat;
/// use rug::Float;
///
/// let f = Float::with_val(53, 23.5);
/// let b = f.as_neg();
/// let using_method: &Float = BorrowFloat::const_deref(&b);
/// let using_operator: &Float = &*b;
/// let using_trait: &Float = b.deref();
/// assert_eq!(*using_method, -23.5);
/// assert!(ptr::eq(using_method, using_operator));
/// assert!(ptr::eq(using_method, using_trait));
/// ```
///
/// This method can be used to create a constant reference.
///
/// ```rust
/// use core::ptr::NonNull;
/// use gmp_mpfr_sys::gmp::limb_t;
/// use gmp_mpfr_sys::mpfr::{mpfr_t, prec_t};
/// use rug::float::BorrowFloat;
/// use rug::Float;
///
/// const LIMBS: [limb_t; 2] = [5, 1 << (limb_t::BITS - 1)];
/// const LIMBS_PTR: *const [limb_t; 2] = &LIMBS;
/// const MANTISSA_DIGITS: u32 = limb_t::BITS * 2;
/// const MPFR: mpfr_t = mpfr_t {
/// prec: MANTISSA_DIGITS as prec_t,
/// sign: -1,
/// exp: 1,
/// d: unsafe { NonNull::new_unchecked(LIMBS_PTR.cast_mut().cast()) },
/// };
/// // Safety: MPFR will remain valid, and will not be changed.
/// const BORROW: BorrowFloat = unsafe { BorrowFloat::from_raw(MPFR) };
/// const F: &Float = BorrowFloat::const_deref(&BORROW);
/// let lsig = Float::with_val(MANTISSA_DIGITS, 5) >> (MANTISSA_DIGITS - 1);
/// let msig = 1u32;
/// let check = -(lsig + msig);
/// assert_eq!(*F, check);
/// ```
#[inline]
pub const fn const_deref<'b>(b: &'b BorrowFloat<'a>) -> &'b Float {
let ptr = cast_ptr!(&b.inner, Float);
// Safety: the inner pointer is valid for the duration of the lifetime.
unsafe { &*ptr }
}
}
impl Deref for BorrowFloat<'_> {
type Target = Float;
#[inline]
fn deref(&self) -> &Float {
BorrowFloat::const_deref(self)
}
}
impl Pointer for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
Pointer::fmt(&&**self, f)
}
}
impl Display for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
Display::fmt(&**self, f)
}
}
impl Debug for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
Debug::fmt(&**self, f)
}
}
impl Binary for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
Binary::fmt(&**self, f)
}
}
impl Octal for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
Octal::fmt(&**self, f)
}
}
impl LowerHex for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
LowerHex::fmt(&**self, f)
}
}
impl UpperHex for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
UpperHex::fmt(&**self, f)
}
}
impl LowerExp for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
LowerExp::fmt(&**self, f)
}
}
impl UpperExp for BorrowFloat<'_> {
fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
UpperExp::fmt(&**self, f)
}
}
// Safety: mpfr_t is thread safe as guaranteed by the MPFR library.
unsafe impl Send for BorrowFloat<'_> {}
unsafe impl Sync for BorrowFloat<'_> {}