1 // Copyright (c) 2017-2024, Lawrence Livermore National Security, LLC and other CEED contributors. 2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 // 4 // SPDX-License-Identifier: BSD-2-Clause 5 // 6 // This file is part of CEED: http://github.com/ceed 7 8 //! A Ceed Vector constitutes the main data structure and serves as input/output 9 //! for Ceed Operators. 10 11 use std::{ 12 ops::{Deref, DerefMut}, 13 os::raw::c_char, 14 }; 15 16 use crate::prelude::*; 17 18 // ----------------------------------------------------------------------------- 19 // Vector option 20 // ----------------------------------------------------------------------------- 21 #[derive(Debug)] 22 pub enum VectorOpt<'a> { 23 Some(&'a Vector<'a>), 24 Active, 25 None, 26 } 27 /// Construct a VectorOpt reference from a Vector reference 28 impl<'a> From<&'a Vector<'_>> for VectorOpt<'a> { 29 fn from(vec: &'a Vector) -> Self { 30 debug_assert!(vec.ptr != unsafe { bind_ceed::CEED_VECTOR_ACTIVE }); 31 debug_assert!(vec.ptr != unsafe { bind_ceed::CEED_VECTOR_NONE }); 32 Self::Some(vec) 33 } 34 } 35 impl<'a> VectorOpt<'a> { 36 /// Transform a Rust libCEED VectorOpt into C libCEED CeedVector 37 pub(crate) fn to_raw(self) -> bind_ceed::CeedVector { 38 match self { 39 Self::Some(vec) => vec.ptr, 40 Self::Active => unsafe { bind_ceed::CEED_VECTOR_ACTIVE }, 41 Self::None => unsafe { bind_ceed::CEED_VECTOR_NONE }, 42 } 43 } 44 45 /// Check if a VectorOpt is Some 46 /// 47 /// ``` 48 /// # use libceed::prelude::*; 49 /// # fn main() -> libceed::Result<()> { 50 /// # let ceed = libceed::Ceed::default_init(); 51 /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 52 /// let vec_opt = VectorOpt::from(&vec); 53 /// assert!(vec_opt.is_some(), "Incorrect VectorOpt"); 54 /// 55 /// let vec_opt = VectorOpt::Active; 56 /// assert!(!vec_opt.is_some(), "Incorrect VectorOpt"); 57 /// 58 /// let vec_opt = VectorOpt::None; 59 /// assert!(!vec_opt.is_some(), "Incorrect VectorOpt"); 60 /// # Ok(()) 61 /// # } 62 /// ``` 63 pub fn is_some(&self) -> bool { 64 match self { 65 Self::Some(_) => true, 66 Self::Active => false, 67 Self::None => false, 68 } 69 } 70 71 /// Check if a VectorOpt is Active 72 /// 73 /// ``` 74 /// # use libceed::prelude::*; 75 /// # fn main() -> libceed::Result<()> { 76 /// # let ceed = libceed::Ceed::default_init(); 77 /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 78 /// let vec_opt = VectorOpt::from(&vec); 79 /// assert!(!vec_opt.is_active(), "Incorrect VectorOpt"); 80 /// 81 /// let vec_opt = VectorOpt::Active; 82 /// assert!(vec_opt.is_active(), "Incorrect VectorOpt"); 83 /// 84 /// let vec_opt = VectorOpt::None; 85 /// assert!(!vec_opt.is_active(), "Incorrect VectorOpt"); 86 /// # Ok(()) 87 /// # } 88 /// ``` 89 pub fn is_active(&self) -> bool { 90 match self { 91 Self::Some(_) => false, 92 Self::Active => true, 93 Self::None => false, 94 } 95 } 96 97 /// Check if a VectorOpt is Some 98 /// 99 /// ``` 100 /// # use libceed::prelude::*; 101 /// # fn main() -> libceed::Result<()> { 102 /// # let ceed = libceed::Ceed::default_init(); 103 /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 104 /// let vec_opt = VectorOpt::from(&vec); 105 /// assert!(!vec_opt.is_none(), "Incorrect VectorOpt"); 106 /// 107 /// let vec_opt = VectorOpt::Active; 108 /// assert!(!vec_opt.is_none(), "Incorrect VectorOpt"); 109 /// 110 /// let vec_opt = VectorOpt::None; 111 /// assert!(vec_opt.is_none(), "Incorrect VectorOpt"); 112 /// # Ok(()) 113 /// # } 114 /// ``` 115 pub fn is_none(&self) -> bool { 116 match self { 117 Self::Some(_) => false, 118 Self::Active => false, 119 Self::None => true, 120 } 121 } 122 } 123 124 // ----------------------------------------------------------------------------- 125 // Vector borrowed slice wrapper 126 // ----------------------------------------------------------------------------- 127 pub struct VectorSliceWrapper<'a> { 128 pub(crate) vector: crate::Vector<'a>, 129 pub(crate) _slice: &'a mut [crate::Scalar], 130 } 131 132 // ----------------------------------------------------------------------------- 133 // Destructor 134 // ----------------------------------------------------------------------------- 135 impl<'a> Drop for VectorSliceWrapper<'a> { 136 fn drop(&mut self) { 137 unsafe { 138 bind_ceed::CeedVectorTakeArray( 139 self.vector.ptr, 140 crate::MemType::Host as bind_ceed::CeedMemType, 141 std::ptr::null_mut(), 142 ) 143 }; 144 } 145 } 146 147 // ----------------------------------------------------------------------------- 148 // Convenience constructor 149 // ----------------------------------------------------------------------------- 150 impl<'a> VectorSliceWrapper<'a> { 151 fn from_vector_and_slice_mut<'b>( 152 vec: &'b mut crate::Vector, 153 slice: &'a mut [crate::Scalar], 154 ) -> crate::Result<Self> { 155 assert_eq!(vec.length(), slice.len()); 156 let (host, copy_mode) = ( 157 crate::MemType::Host as bind_ceed::CeedMemType, 158 crate::CopyMode::UsePointer as bind_ceed::CeedCopyMode, 159 ); 160 let ierr = unsafe { 161 bind_ceed::CeedVectorSetArray( 162 vec.ptr, 163 host, 164 copy_mode, 165 slice.as_ptr() as *mut crate::Scalar, 166 ) 167 }; 168 vec.check_error(ierr)?; 169 170 Ok(Self { 171 vector: crate::Vector::from_raw(vec.ptr_copy_mut()?)?, 172 _slice: slice, 173 }) 174 } 175 } 176 177 // ----------------------------------------------------------------------------- 178 // Vector context wrapper 179 // ----------------------------------------------------------------------------- 180 #[derive(Debug)] 181 pub struct Vector<'a> { 182 pub(crate) ptr: bind_ceed::CeedVector, 183 _lifeline: PhantomData<&'a ()>, 184 } 185 impl From<&'_ Vector<'_>> for bind_ceed::CeedVector { 186 fn from(vec: &Vector) -> Self { 187 vec.ptr 188 } 189 } 190 191 // ----------------------------------------------------------------------------- 192 // Destructor 193 // ----------------------------------------------------------------------------- 194 impl<'a> Drop for Vector<'a> { 195 fn drop(&mut self) { 196 let not_none_and_active = self.ptr != unsafe { bind_ceed::CEED_VECTOR_NONE } 197 && self.ptr != unsafe { bind_ceed::CEED_VECTOR_ACTIVE }; 198 199 if not_none_and_active { 200 unsafe { bind_ceed::CeedVectorDestroy(&mut self.ptr) }; 201 } 202 } 203 } 204 205 // ----------------------------------------------------------------------------- 206 // Display 207 // ----------------------------------------------------------------------------- 208 impl<'a> fmt::Display for Vector<'a> { 209 /// View a Vector 210 /// 211 /// ``` 212 /// # use libceed::prelude::*; 213 /// # fn main() -> libceed::Result<()> { 214 /// # let ceed = libceed::Ceed::default_init(); 215 /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 216 /// assert_eq!( 217 /// vec.to_string(), 218 /// "CeedVector length 3 219 /// 1.00000000 220 /// 2.00000000 221 /// 3.00000000 222 /// " 223 /// ); 224 /// # Ok(()) 225 /// # } 226 /// ``` 227 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 228 let mut ptr = std::ptr::null_mut(); 229 let mut sizeloc = crate::MAX_BUFFER_LENGTH; 230 let format = CString::new("%12.8f").expect("CString::new failed"); 231 let format_c: *const c_char = format.into_raw(); 232 let cstring = unsafe { 233 let file = bind_ceed::open_memstream(&mut ptr, &mut sizeloc); 234 bind_ceed::CeedVectorView(self.ptr, format_c, file); 235 bind_ceed::fclose(file); 236 CString::from_raw(ptr) 237 }; 238 cstring.to_string_lossy().fmt(f) 239 } 240 } 241 242 // ----------------------------------------------------------------------------- 243 // Implementations 244 // ----------------------------------------------------------------------------- 245 impl<'a> Vector<'a> { 246 // Constructors 247 pub fn create(ceed: &crate::Ceed, n: usize) -> crate::Result<Self> { 248 let n = isize::try_from(n).unwrap(); 249 let mut ptr = std::ptr::null_mut(); 250 let ierr = unsafe { bind_ceed::CeedVectorCreate(ceed.ptr, n, &mut ptr) }; 251 ceed.check_error(ierr)?; 252 Ok(Self { 253 ptr, 254 _lifeline: PhantomData, 255 }) 256 } 257 258 pub(crate) fn from_raw(ptr: bind_ceed::CeedVector) -> crate::Result<Self> { 259 Ok(Self { 260 ptr, 261 _lifeline: PhantomData, 262 }) 263 } 264 265 fn ptr_copy_mut(&mut self) -> crate::Result<bind_ceed::CeedVector> { 266 let mut ptr_copy = std::ptr::null_mut(); 267 let ierr = unsafe { bind_ceed::CeedVectorReferenceCopy(self.ptr, &mut ptr_copy) }; 268 self.check_error(ierr)?; 269 Ok(ptr_copy) 270 } 271 272 /// Copy the array of self into vec_copy 273 /// 274 /// # arguments 275 /// 276 /// * `vec_source` - vector to copy array values from 277 /// 278 /// ``` 279 /// # use libceed::prelude::*; 280 /// # fn main() -> libceed::Result<()> { 281 /// # let ceed = libceed::Ceed::default_init(); 282 /// let a = ceed.vector_from_slice(&[1., 2., 3.])?; 283 /// let mut b = ceed.vector(3)?; 284 /// 285 /// b.copy_from(&a)?; 286 /// for (i, v) in b.view()?.iter().enumerate() { 287 /// assert_eq!(*v, (i + 1) as Scalar, "Copy contents not set correctly"); 288 /// } 289 /// # Ok(()) 290 /// # } 291 /// ``` 292 /// ``` 293 pub fn copy_from(&mut self, vec_source: &crate::Vector) -> crate::Result<i32> { 294 let ierr = unsafe { bind_ceed::CeedVectorCopy(vec_source.ptr, self.ptr) }; 295 self.check_error(ierr) 296 } 297 298 /// Create a Vector from a slice 299 /// 300 /// # arguments 301 /// 302 /// * `slice` - values to initialize vector with 303 /// 304 /// ``` 305 /// # use libceed::prelude::*; 306 /// # fn main() -> libceed::Result<()> { 307 /// # let ceed = libceed::Ceed::default_init(); 308 /// let vec = vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 309 /// assert_eq!(vec.length(), 3, "Incorrect length from slice"); 310 /// # Ok(()) 311 /// # } 312 /// ``` 313 pub fn from_slice(ceed: &crate::Ceed, v: &[crate::Scalar]) -> crate::Result<Self> { 314 let mut x = Self::create(ceed, v.len())?; 315 x.set_slice(v)?; 316 Ok(x) 317 } 318 319 /// Create a Vector from a mutable array reference 320 /// 321 /// # arguments 322 /// 323 /// * `slice` - values to initialize vector with 324 /// 325 /// ``` 326 /// # use libceed::prelude::*; 327 /// # fn main() -> libceed::Result<()> { 328 /// # let ceed = libceed::Ceed::default_init(); 329 /// let mut rust_vec = vec![1., 2., 3.]; 330 /// let vec = libceed::vector::Vector::from_array(&ceed, &mut rust_vec)?; 331 /// 332 /// assert_eq!(vec.length(), 3, "Incorrect length from slice"); 333 /// # Ok(()) 334 /// # } 335 /// ``` 336 pub fn from_array(ceed: &crate::Ceed, v: &mut [crate::Scalar]) -> crate::Result<Self> { 337 let x = Self::create(ceed, v.len())?; 338 let (host, user_pointer) = ( 339 crate::MemType::Host as bind_ceed::CeedMemType, 340 crate::CopyMode::UsePointer as bind_ceed::CeedCopyMode, 341 ); 342 let v = v.as_ptr() as *mut crate::Scalar; 343 let ierr = unsafe { bind_ceed::CeedVectorSetArray(x.ptr, host, user_pointer, v) }; 344 ceed.check_error(ierr)?; 345 Ok(x) 346 } 347 348 // Error handling 349 #[doc(hidden)] 350 fn check_error(&self, ierr: i32) -> crate::Result<i32> { 351 unsafe { crate::check_error(bind_ceed::CeedVectorReturnCeed(self.ptr), ierr) } 352 } 353 354 /// Returns the length of a Vector 355 /// 356 /// ``` 357 /// # use libceed::prelude::*; 358 /// # fn main() -> libceed::Result<()> { 359 /// # let ceed = libceed::Ceed::default_init(); 360 /// let vec = ceed.vector(10)?; 361 /// 362 /// let n = vec.length(); 363 /// assert_eq!(n, 10, "Incorrect length"); 364 /// # Ok(()) 365 /// # } 366 /// ``` 367 pub fn length(&self) -> usize { 368 let mut n = 0; 369 unsafe { bind_ceed::CeedVectorGetLength(self.ptr, &mut n) }; 370 usize::try_from(n).unwrap() 371 } 372 373 /// Returns the length of a Vector 374 /// 375 /// ``` 376 /// # use libceed::prelude::*; 377 /// # fn main() -> libceed::Result<()> { 378 /// # let ceed = libceed::Ceed::default_init(); 379 /// let vec = ceed.vector(10)?; 380 /// assert_eq!(vec.len(), 10, "Incorrect length"); 381 /// # Ok(()) 382 /// # } 383 /// ``` 384 pub fn len(&self) -> usize { 385 self.length() 386 } 387 388 /// Set the Vector to a constant value 389 /// 390 /// # arguments 391 /// 392 /// * `val` - Value to be used 393 /// 394 /// ``` 395 /// # use libceed::prelude::*; 396 /// # fn main() -> libceed::Result<()> { 397 /// # let ceed = libceed::Ceed::default_init(); 398 /// let len = 10; 399 /// let mut vec = ceed.vector(len)?; 400 /// 401 /// let val = 42.0; 402 /// vec.set_value(val)?; 403 /// 404 /// for v in vec.view()?.iter() { 405 /// assert_eq!(*v, val, "Value not set correctly"); 406 /// } 407 /// # Ok(()) 408 /// # } 409 /// ``` 410 pub fn set_value(&mut self, value: crate::Scalar) -> crate::Result<i32> { 411 let ierr = unsafe { bind_ceed::CeedVectorSetValue(self.ptr, value) }; 412 self.check_error(ierr) 413 } 414 415 /// Set values from a slice of the same length 416 /// 417 /// # arguments 418 /// 419 /// * `slice` - values to into self; length must match 420 /// 421 /// ``` 422 /// # use libceed::prelude::*; 423 /// # fn main() -> libceed::Result<()> { 424 /// # let ceed = libceed::Ceed::default_init(); 425 /// let mut vec = ceed.vector(4)?; 426 /// vec.set_slice(&[10., 11., 12., 13.])?; 427 /// 428 /// for (i, v) in vec.view()?.iter().enumerate() { 429 /// assert_eq!(*v, 10. + i as Scalar, "Slice not set correctly"); 430 /// } 431 /// # Ok(()) 432 /// # } 433 /// ``` 434 pub fn set_slice(&mut self, slice: &[crate::Scalar]) -> crate::Result<i32> { 435 assert_eq!(self.length(), slice.len()); 436 let (host, copy_mode) = ( 437 crate::MemType::Host as bind_ceed::CeedMemType, 438 crate::CopyMode::CopyValues as bind_ceed::CeedCopyMode, 439 ); 440 let ierr = unsafe { 441 bind_ceed::CeedVectorSetArray( 442 self.ptr, 443 host, 444 copy_mode, 445 slice.as_ptr() as *mut crate::Scalar, 446 ) 447 }; 448 self.check_error(ierr) 449 } 450 451 /// Wrap a mutable slice in a Vector of the same length 452 /// 453 /// # arguments 454 /// 455 /// * `slice` - values to wrap in self; length must match 456 /// 457 /// ``` 458 /// # use libceed::prelude::*; 459 /// # fn main() -> libceed::Result<()> { 460 /// # let ceed = libceed::Ceed::default_init(); 461 /// let mut vec = ceed.vector(4)?; 462 /// let mut array = [10., 11., 12., 13.]; 463 /// 464 /// { 465 /// // `wrapper` holds a mutable reference to the wrapped slice 466 /// // that is dropped when `wrapper` goes out of scope 467 /// let wrapper = vec.wrap_slice_mut(&mut array)?; 468 /// for (i, v) in vec.view()?.iter().enumerate() { 469 /// assert_eq!(*v, 10. + i as Scalar, "Slice not set correctly"); 470 /// } 471 /// 472 /// // This line will not compile, as the `wrapper` holds mutable 473 /// // access to the `array` 474 /// // array[0] = 5.0; 475 /// 476 /// // Changes here are reflected in the `array` 477 /// vec.set_value(5.0)?; 478 /// for v in vec.view()?.iter() { 479 /// assert_eq!(*v, 5.0 as Scalar, "Value not set correctly"); 480 /// } 481 /// } 482 /// 483 /// // 'array' remains changed 484 /// for v in array.iter() { 485 /// assert_eq!(*v, 5.0 as Scalar, "Array not mutated correctly"); 486 /// } 487 /// 488 /// // While changes to `vec` no longer affect `array` 489 /// vec.set_value(6.0)?; 490 /// for v in array.iter() { 491 /// assert_eq!(*v, 5.0 as Scalar, "Array mutated without permission"); 492 /// } 493 /// # Ok(()) 494 /// # } 495 /// ``` 496 pub fn wrap_slice_mut<'b>( 497 &mut self, 498 slice: &'b mut [crate::Scalar], 499 ) -> crate::Result<VectorSliceWrapper<'b>> { 500 crate::VectorSliceWrapper::from_vector_and_slice_mut(self, slice) 501 } 502 503 /// Sync the Vector to a specified memtype 504 /// 505 /// # arguments 506 /// 507 /// * `mtype` - Memtype to be synced 508 /// 509 /// ``` 510 /// # use libceed::prelude::*; 511 /// # fn main() -> libceed::Result<()> { 512 /// # let ceed = libceed::Ceed::default_init(); 513 /// let len = 10; 514 /// let mut vec = ceed.vector(len)?; 515 /// 516 /// let val = 42.0; 517 /// vec.set_value(val); 518 /// vec.sync(MemType::Host)?; 519 /// 520 /// for v in vec.view()?.iter() { 521 /// assert_eq!(*v, val, "Value not set correctly"); 522 /// } 523 /// # Ok(()) 524 /// # } 525 /// ``` 526 pub fn sync(&self, mtype: crate::MemType) -> crate::Result<i32> { 527 let ierr = 528 unsafe { bind_ceed::CeedVectorSyncArray(self.ptr, mtype as bind_ceed::CeedMemType) }; 529 self.check_error(ierr) 530 } 531 532 /// Create an immutable view 533 /// 534 /// ``` 535 /// # use libceed::prelude::*; 536 /// # fn main() -> libceed::Result<()> { 537 /// # let ceed = libceed::Ceed::default_init(); 538 /// let vec = ceed.vector_from_slice(&[10., 11., 12., 13.])?; 539 /// 540 /// let v = vec.view()?; 541 /// assert_eq!(v[0..2], [10., 11.]); 542 /// 543 /// // It is valid to have multiple immutable views 544 /// let w = vec.view()?; 545 /// assert_eq!(v[1..], w[1..]); 546 /// # Ok(()) 547 /// # } 548 /// ``` 549 pub fn view(&self) -> crate::Result<VectorView> { 550 VectorView::new(self) 551 } 552 553 /// Create an mutable view 554 /// 555 /// ``` 556 /// # use libceed::prelude::*; 557 /// # fn main() -> libceed::Result<()> { 558 /// # let ceed = libceed::Ceed::default_init(); 559 /// let mut vec = ceed.vector_from_slice(&[10., 11., 12., 13.])?; 560 /// 561 /// { 562 /// let mut v = vec.view_mut()?; 563 /// v[2] = 9.; 564 /// } 565 /// 566 /// let w = vec.view()?; 567 /// assert_eq!(w[2], 9., "View did not mutate data"); 568 /// # Ok(()) 569 /// # } 570 /// ``` 571 pub fn view_mut(&mut self) -> crate::Result<VectorViewMut> { 572 VectorViewMut::new(self) 573 } 574 575 /// Return the norm of a Vector 576 /// 577 /// # arguments 578 /// 579 /// * `ntype` - Norm type One, Two, or Max 580 /// 581 /// ``` 582 /// # use libceed::prelude::*; 583 /// # fn main() -> libceed::Result<()> { 584 /// # let ceed = libceed::Ceed::default_init(); 585 /// let vec = ceed.vector_from_slice(&[1., 2., 3., 4.])?; 586 /// 587 /// let max_norm = vec.norm(NormType::Max)?; 588 /// assert_eq!(max_norm, 4.0, "Incorrect Max norm"); 589 /// 590 /// let l1_norm = vec.norm(NormType::One)?; 591 /// assert_eq!(l1_norm, 10., "Incorrect L1 norm"); 592 /// 593 /// let l2_norm = vec.norm(NormType::Two)?; 594 /// assert!((l2_norm - 5.477) < 1e-3, "Incorrect L2 norm"); 595 /// # Ok(()) 596 /// # } 597 /// ``` 598 pub fn norm(&self, ntype: crate::NormType) -> crate::Result<crate::Scalar> { 599 let mut res: crate::Scalar = 0.0; 600 let ierr = unsafe { 601 bind_ceed::CeedVectorNorm(self.ptr, ntype as bind_ceed::CeedNormType, &mut res) 602 }; 603 self.check_error(ierr)?; 604 Ok(res) 605 } 606 607 /// Compute x = alpha x for a Vector 608 /// 609 /// # arguments 610 /// 611 /// * `alpha` - scaling factor 612 /// 613 /// ``` 614 /// # use libceed::prelude::*; 615 /// # fn main() -> libceed::Result<()> { 616 /// # let ceed = libceed::Ceed::default_init(); 617 /// let mut vec = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 618 /// 619 /// vec = vec.scale(-1.0)?; 620 /// for (i, v) in vec.view()?.iter().enumerate() { 621 /// assert_eq!(*v, -(i as Scalar), "Value not set correctly"); 622 /// } 623 /// # Ok(()) 624 /// # } 625 /// ``` 626 #[allow(unused_mut)] 627 pub fn scale(mut self, alpha: crate::Scalar) -> crate::Result<Self> { 628 let ierr = unsafe { bind_ceed::CeedVectorScale(self.ptr, alpha) }; 629 self.check_error(ierr)?; 630 Ok(self) 631 } 632 633 /// Compute y = alpha x + y for a pair of Vectors 634 /// 635 /// # arguments 636 /// 637 /// * `alpha` - scaling factor 638 /// * `x` - second vector, must be different than self 639 /// 640 /// ``` 641 /// # use libceed::prelude::*; 642 /// # fn main() -> libceed::Result<()> { 643 /// # let ceed = libceed::Ceed::default_init(); 644 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 645 /// let mut y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 646 /// 647 /// y = y.axpy(-0.5, &x)?; 648 /// for (i, y) in y.view()?.iter().enumerate() { 649 /// assert_eq!(*y, (i as Scalar) / 2.0, "Value not set correctly"); 650 /// } 651 /// # Ok(()) 652 /// # } 653 /// ``` 654 #[allow(unused_mut)] 655 pub fn axpy(mut self, alpha: crate::Scalar, x: &crate::Vector) -> crate::Result<Self> { 656 let ierr = unsafe { bind_ceed::CeedVectorAXPY(self.ptr, alpha, x.ptr) }; 657 self.check_error(ierr)?; 658 Ok(self) 659 } 660 661 /// Compute y = alpha x + beta y for a pair of Vectors 662 /// 663 /// # arguments 664 /// 665 /// * `alpha` - first scaling factor 666 /// * `beta` - second scaling factor 667 /// * `x` - second vector, must be different than self 668 /// 669 /// ``` 670 /// # use libceed::prelude::*; 671 /// # fn main() -> libceed::Result<()> { 672 /// # let ceed = libceed::Ceed::default_init(); 673 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 674 /// let mut y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 675 /// 676 /// y = y.axpby(-0.5, 1.0, &x)?; 677 /// for (i, y) in y.view()?.iter().enumerate() { 678 /// assert_eq!(*y, (i as Scalar) * 0.5, "Value not set correctly"); 679 /// } 680 /// # Ok(()) 681 /// # } 682 /// ``` 683 #[allow(unused_mut)] 684 pub fn axpby( 685 mut self, 686 alpha: crate::Scalar, 687 beta: crate::Scalar, 688 x: &crate::Vector, 689 ) -> crate::Result<Self> { 690 let ierr = unsafe { bind_ceed::CeedVectorAXPBY(self.ptr, alpha, beta, x.ptr) }; 691 self.check_error(ierr)?; 692 Ok(self) 693 } 694 695 /// Compute the pointwise multiplication w = x .* y for Vectors 696 /// 697 /// # arguments 698 /// 699 /// * `x` - first vector for product 700 /// * `y` - second vector for product 701 /// 702 /// ``` 703 /// # use libceed::prelude::*; 704 /// # fn main() -> libceed::Result<()> { 705 /// # let ceed = libceed::Ceed::default_init(); 706 /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 707 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 708 /// let y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 709 /// 710 /// w = w.pointwise_mult(&x, &y)?; 711 /// for (i, w) in w.view()?.iter().enumerate() { 712 /// assert_eq!(*w, (i as Scalar).powf(2.0), "Value not set correctly"); 713 /// } 714 /// # Ok(()) 715 /// # } 716 /// ``` 717 #[allow(unused_mut)] 718 pub fn pointwise_mult(mut self, x: &crate::Vector, y: &crate::Vector) -> crate::Result<Self> { 719 let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, x.ptr, y.ptr) }; 720 self.check_error(ierr)?; 721 Ok(self) 722 } 723 724 /// Compute the pointwise multiplication w = w .* x for Vectors 725 /// 726 /// # arguments 727 /// 728 /// * `x` - second vector for product 729 /// 730 /// ``` 731 /// # use libceed::prelude::*; 732 /// # fn main() -> libceed::Result<()> { 733 /// # let ceed = libceed::Ceed::default_init(); 734 /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 735 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 736 /// 737 /// w = w.pointwise_scale(&x)?; 738 /// for (i, w) in w.view()?.iter().enumerate() { 739 /// assert_eq!(*w, (i as Scalar).powf(2.0), "Value not set correctly"); 740 /// } 741 /// # Ok(()) 742 /// # } 743 /// ``` 744 #[allow(unused_mut)] 745 pub fn pointwise_scale(mut self, x: &crate::Vector) -> crate::Result<Self> { 746 let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, self.ptr, x.ptr) }; 747 self.check_error(ierr)?; 748 Ok(self) 749 } 750 751 /// Compute the pointwise multiplication w = w .* w for a Vector 752 /// 753 /// ``` 754 /// # use libceed::prelude::*; 755 /// # fn main() -> libceed::Result<()> { 756 /// # let ceed = libceed::Ceed::default_init(); 757 /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 758 /// 759 /// w = w.pointwise_square()?; 760 /// for (i, w) in w.view()?.iter().enumerate() { 761 /// assert_eq!(*w, (i as Scalar).powf(2.0), "Value not set correctly"); 762 /// } 763 /// # Ok(()) 764 /// # } 765 /// ``` 766 #[allow(unused_mut)] 767 pub fn pointwise_square(mut self) -> crate::Result<Self> { 768 let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, self.ptr, self.ptr) }; 769 self.check_error(ierr)?; 770 Ok(self) 771 } 772 } 773 774 // ----------------------------------------------------------------------------- 775 // Vector Viewer 776 // ----------------------------------------------------------------------------- 777 /// A (host) view of a Vector with Deref to slice. We can't make 778 /// Vector itself Deref to slice because we can't handle the drop to 779 /// call bind_ceed::CeedVectorRestoreArrayRead(). 780 #[derive(Debug)] 781 pub struct VectorView<'a> { 782 vec: &'a Vector<'a>, 783 array: *const crate::Scalar, 784 } 785 786 impl<'a> VectorView<'a> { 787 /// Construct a VectorView from a Vector reference 788 fn new(vec: &'a Vector) -> crate::Result<Self> { 789 let mut array = std::ptr::null(); 790 let ierr = unsafe { 791 bind_ceed::CeedVectorGetArrayRead( 792 vec.ptr, 793 crate::MemType::Host as bind_ceed::CeedMemType, 794 &mut array, 795 ) 796 }; 797 vec.check_error(ierr)?; 798 Ok(Self { 799 vec: vec, 800 array: array, 801 }) 802 } 803 } 804 805 // Destructor 806 impl<'a> Drop for VectorView<'a> { 807 fn drop(&mut self) { 808 unsafe { 809 bind_ceed::CeedVectorRestoreArrayRead(self.vec.ptr, &mut self.array); 810 } 811 } 812 } 813 814 // Data access 815 impl<'a> Deref for VectorView<'a> { 816 type Target = [crate::Scalar]; 817 fn deref(&self) -> &[crate::Scalar] { 818 unsafe { std::slice::from_raw_parts(self.array, self.vec.len()) } 819 } 820 } 821 822 // Viewing 823 impl<'a> fmt::Display for VectorView<'a> { 824 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 825 write!(f, "VectorView({:?})", self.deref()) 826 } 827 } 828 829 // ----------------------------------------------------------------------------- 830 // Vector Viewer Mutable 831 // ----------------------------------------------------------------------------- 832 /// A mutable (host) view of a Vector with Deref to slice. 833 #[derive(Debug)] 834 pub struct VectorViewMut<'a> { 835 vec: &'a Vector<'a>, 836 array: *mut crate::Scalar, 837 } 838 839 impl<'a> VectorViewMut<'a> { 840 /// Construct a VectorViewMut from a Vector reference 841 fn new(vec: &'a mut Vector) -> crate::Result<Self> { 842 let mut ptr = std::ptr::null_mut(); 843 let ierr = unsafe { 844 bind_ceed::CeedVectorGetArray( 845 vec.ptr, 846 crate::MemType::Host as bind_ceed::CeedMemType, 847 &mut ptr, 848 ) 849 }; 850 vec.check_error(ierr)?; 851 Ok(Self { 852 vec: vec, 853 array: ptr, 854 }) 855 } 856 } 857 858 // Destructor 859 impl<'a> Drop for VectorViewMut<'a> { 860 fn drop(&mut self) { 861 unsafe { 862 bind_ceed::CeedVectorRestoreArray(self.vec.ptr, &mut self.array); 863 } 864 } 865 } 866 867 // Data access 868 impl<'a> Deref for VectorViewMut<'a> { 869 type Target = [crate::Scalar]; 870 fn deref(&self) -> &[crate::Scalar] { 871 unsafe { std::slice::from_raw_parts(self.array, self.vec.len()) } 872 } 873 } 874 875 // Mutable data access 876 impl<'a> DerefMut for VectorViewMut<'a> { 877 fn deref_mut(&mut self) -> &mut [crate::Scalar] { 878 unsafe { std::slice::from_raw_parts_mut(self.array, self.vec.len()) } 879 } 880 } 881 882 // Viewing 883 impl<'a> fmt::Display for VectorViewMut<'a> { 884 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 885 write!(f, "VectorViewMut({:?})", self.deref()) 886 } 887 } 888 889 // ----------------------------------------------------------------------------- 890