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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
// Copyright © 2016–2020 University of Malta // 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::{ ext::xmpfr, float::{small::Mpfr, ToSmall}, Assign, Complex, }; use core::{ cell::UnsafeCell, mem::{self, MaybeUninit}, ops::Deref, ptr, }; use gmp_mpfr_sys::{ gmp::{self, limb_t}, mpc::mpc_t, mpfr::mpfr_t, }; const LIMBS_IN_SMALL: usize = (128 / gmp::LIMB_BITS) as usize; type Limbs = [MaybeUninit<limb_t>; LIMBS_IN_SMALL]; /** A small complex number that does not require any memory allocation. This can be useful when you have real and imaginary numbers that are primitive integers or floats and you need a reference to a [`Complex`]. The `SmallComplex` will have a precision according to the types of the primitives used to set its real and imaginary parts. Note that if different types are used to set the parts, the parts can have different precisions. * [`i8`], [`u8`]: the part will have eight bits of precision. * [`i16`], [`u16`]: the part will have 16 bits of precision. * [`i32`], [`u32`]: the part will have 32 bits of precision. * [`i64`], [`u64`]: the part will have 64 bits of precision. * [`i128`], [`u128`]: the part will have 128 bits of precision. * [`isize`], [`usize`]: the part will have 32 or 64 bits of precision, depending on the platform. * [`f32`]: the part will have 24 bits of precision. * [`f64`]: the part will have 53 bits of precision. The `SmallComplex` type can be coerced to a [`Complex`], as it implements <code>[Deref]<[Target] = [Complex][`Complex`]></code>. # Examples ```rust use rug::{complex::SmallComplex, Complex}; // `a` requires a heap allocation let mut a = Complex::with_val(53, (1, 2)); // `b` can reside on the stack let b = SmallComplex::from((-10f64, -20.5f64)); a += &*b; assert_eq!(*a.real(), -9); assert_eq!(*a.imag(), -18.5); ``` [Deref]: https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html [Target]: https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#associatedtype.Target [`Complex`]: ../struct.Complex.html [`f32`]: https://doc.rust-lang.org/nightly/std/primitive.f32.html [`f64`]: https://doc.rust-lang.org/nightly/std/primitive.f64.html [`i128`]: https://doc.rust-lang.org/nightly/std/primitive.i128.html [`i16`]: https://doc.rust-lang.org/nightly/std/primitive.i16.html [`i32`]: https://doc.rust-lang.org/nightly/std/primitive.i32.html [`i64`]: https://doc.rust-lang.org/nightly/std/primitive.i64.html [`i8`]: https://doc.rust-lang.org/nightly/std/primitive.i8.html [`isize`]: https://doc.rust-lang.org/nightly/std/primitive.isize.html [`u128`]: https://doc.rust-lang.org/nightly/std/primitive.u128.html [`u16`]: https://doc.rust-lang.org/nightly/std/primitive.u16.html [`u32`]: https://doc.rust-lang.org/nightly/std/primitive.u32.html [`u64`]: https://doc.rust-lang.org/nightly/std/primitive.u64.html [`u8`]: https://doc.rust-lang.org/nightly/std/primitive.u8.html [`usize`]: https://doc.rust-lang.org/nightly/std/primitive.usize.html */ pub struct SmallComplex { inner: Mpc, // real part is first in limbs if inner.re.d <= inner.im.d first_limbs: Limbs, last_limbs: Limbs, } unsafe impl Send for SmallComplex {} impl Clone for SmallComplex { #[inline] fn clone(&self) -> SmallComplex { let (first_limbs, last_limbs) = if self.re_is_first() { (&self.first_limbs, &self.last_limbs) } else { (&self.last_limbs, &self.first_limbs) }; SmallComplex { inner: self.inner.clone(), first_limbs: *first_limbs, last_limbs: *last_limbs, } } } #[derive(Clone)] #[repr(C)] struct Mpc { re: Mpfr, im: Mpfr, } static_assert_same_layout!(Mpc, mpc_t); impl SmallComplex { /// Returns a mutable reference to a [`Complex`] number for simple /// operations that do not need to change the precision of the /// real or imaginary part. /// /// # Safety /// /// It is undefined behaviour to modify the precision of the /// referenced [`Complex`] number or to swap it with another /// number. /// /// # Examples /// /// ```rust /// use rug::complex::SmallComplex; /// let mut c = SmallComplex::from((1.0f32, 3.0f32)); /// // rotation does not change the precision /// unsafe { /// c.as_nonreallocating_complex().mul_i_mut(false); /// } /// assert_eq!(*c, (-3.0, 1.0)); /// ``` /// /// [`Complex`]: ../struct.Complex.html #[inline] pub unsafe fn as_nonreallocating_complex(&mut self) -> &mut Complex { self.update_d(); let ptr = cast_ptr_mut!(&mut self.inner, Complex); &mut *ptr } #[inline] fn re_is_first(&self) -> bool { unsafe { (*self.inner.re.d.get() as usize) <= (*self.inner.im.d.get() as usize) } } // To be used when offsetting re and im in case the struct has // been displaced in memory; if currently re.d <= im.d then re.d // points to first_limbs and im.d points to last_limbs, otherwise // re.d points to last_limbs and im.d points to first_limbs. #[inline] fn update_d(&self) { // Since this is borrowed, the limbs won't move around, and we // can set the d fields. let first = self.first_limbs[0].as_ptr() as *mut limb_t; let last = self.last_limbs[0].as_ptr() as *mut limb_t; let (re_d, im_d) = if self.re_is_first() { (first, last) } else { (last, first) }; unsafe { *self.inner.re.d.get() = re_d; *self.inner.im.d.get() = im_d; } } } impl Deref for SmallComplex { type Target = Complex; #[inline] fn deref(&self) -> &Complex { self.update_d(); let ptr = cast_ptr!(&self.inner, Complex); unsafe { &*ptr } } } impl<Re: ToSmall> Assign<Re> for SmallComplex { fn assign(&mut self, src: Re) { unsafe { src.copy(&mut self.inner.re, &mut self.first_limbs); xmpfr::custom_zero( cast_ptr_mut!(&mut self.inner.im, mpfr_t), self.last_limbs[0].as_mut_ptr(), self.inner.re.prec, ); } } } impl<Re: ToSmall> From<Re> for SmallComplex { fn from(src: Re) -> Self { let mut dst = SmallComplex { inner: Mpc { re: Mpfr { prec: 0, sign: 0, exp: 0, d: UnsafeCell::new(ptr::null_mut()), }, im: Mpfr { prec: 0, sign: 0, exp: 0, d: UnsafeCell::new(ptr::null_mut()), }, }, first_limbs: small_limbs![], last_limbs: small_limbs![], }; unsafe { src.copy(&mut dst.inner.re, &mut dst.first_limbs); xmpfr::custom_zero( cast_ptr_mut!(&mut dst.inner.im, mpfr_t), dst.last_limbs[0].as_mut_ptr(), dst.inner.re.prec, ); } dst } } impl<Re: ToSmall, Im: ToSmall> Assign<(Re, Im)> for SmallComplex { fn assign(&mut self, src: (Re, Im)) { unsafe { src.0.copy(&mut self.inner.re, &mut self.first_limbs); src.1.copy(&mut self.inner.im, &mut self.last_limbs); } } } impl<Re: ToSmall, Im: ToSmall> From<(Re, Im)> for SmallComplex { fn from(src: (Re, Im)) -> Self { let mut dst = SmallComplex { inner: Mpc { re: Mpfr { prec: 0, sign: 0, exp: 0, d: UnsafeCell::new(ptr::null_mut()), }, im: Mpfr { prec: 0, sign: 0, exp: 0, d: UnsafeCell::new(ptr::null_mut()), }, }, first_limbs: small_limbs![], last_limbs: small_limbs![], }; unsafe { src.0.copy(&mut dst.inner.re, &mut dst.first_limbs); src.1.copy(&mut dst.inner.im, &mut dst.last_limbs); } dst } } impl Assign<&Self> for SmallComplex { #[inline] fn assign(&mut self, other: &Self) { self.clone_from(other); } } impl Assign for SmallComplex { #[inline] fn assign(&mut self, other: Self) { drop(mem::replace(self, other)); } } #[cfg(test)] mod tests { use crate::{ complex::SmallComplex, float::{self, FreeCache}, Assign, }; #[test] fn check_assign() { let mut c = SmallComplex::from((1.0, 2.0)); assert_eq!(*c, (1.0, 2.0)); c.assign(3.0); assert_eq!(*c, (3.0, 0.0)); let other = SmallComplex::from((4.0, 5.0)); c.assign(&other); assert_eq!(*c, (4.0, 5.0)); c.assign((6.0, 7.0)); assert_eq!(*c, (6.0, 7.0)); c.assign(other); assert_eq!(*c, (4.0, 5.0)); float::free_cache(FreeCache::All); } fn swapped_parts(small: &SmallComplex) -> bool { unsafe { let re = (*small.real().as_raw()).d; let im = (*small.imag().as_raw()).d; (re as usize) > (im as usize) } } #[test] fn check_swapped_parts() { let mut c = SmallComplex::from((1, 2)); assert!(!swapped_parts(&c)); assert_eq!(*c.clone(), *c); unsafe { c.as_nonreallocating_complex().mul_i_mut(false); } assert!(swapped_parts(&c)); assert_eq!(*c, (-2, 1)); assert_eq!(*c.clone(), *c); c.assign(12); assert!(!swapped_parts(&c)); assert_eq!(*c, 12); unsafe { c.as_nonreallocating_complex().mul_i_mut(false); } assert!(swapped_parts(&c)); c.assign((4, 5)); assert!(!swapped_parts(&c)); assert_eq!(*c, (4, 5)); } }