1 // Copyright (c) 2017-2022, 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 /// Create a Vector from a slice 273 /// 274 /// # arguments 275 /// 276 /// * `slice` - values to initialize vector with 277 /// 278 /// ``` 279 /// # use libceed::prelude::*; 280 /// # fn main() -> libceed::Result<()> { 281 /// # let ceed = libceed::Ceed::default_init(); 282 /// let vec = vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 283 /// assert_eq!(vec.length(), 3, "Incorrect length from slice"); 284 /// # Ok(()) 285 /// # } 286 /// ``` 287 pub fn from_slice(ceed: &crate::Ceed, v: &[crate::Scalar]) -> crate::Result<Self> { 288 let mut x = Self::create(ceed, v.len())?; 289 x.set_slice(v)?; 290 Ok(x) 291 } 292 293 /// Create a Vector from a mutable array reference 294 /// 295 /// # arguments 296 /// 297 /// * `slice` - values to initialize vector with 298 /// 299 /// ``` 300 /// # use libceed::prelude::*; 301 /// # fn main() -> libceed::Result<()> { 302 /// # let ceed = libceed::Ceed::default_init(); 303 /// let mut rust_vec = vec![1., 2., 3.]; 304 /// let vec = libceed::vector::Vector::from_array(&ceed, &mut rust_vec)?; 305 /// 306 /// assert_eq!(vec.length(), 3, "Incorrect length from slice"); 307 /// # Ok(()) 308 /// # } 309 /// ``` 310 pub fn from_array(ceed: &crate::Ceed, v: &mut [crate::Scalar]) -> crate::Result<Self> { 311 let x = Self::create(ceed, v.len())?; 312 let (host, user_pointer) = ( 313 crate::MemType::Host as bind_ceed::CeedMemType, 314 crate::CopyMode::UsePointer as bind_ceed::CeedCopyMode, 315 ); 316 let v = v.as_ptr() as *mut crate::Scalar; 317 let ierr = unsafe { bind_ceed::CeedVectorSetArray(x.ptr, host, user_pointer, v) }; 318 ceed.check_error(ierr)?; 319 Ok(x) 320 } 321 322 // Error handling 323 #[doc(hidden)] 324 fn check_error(&self, ierr: i32) -> crate::Result<i32> { 325 let mut ptr = std::ptr::null_mut(); 326 unsafe { 327 bind_ceed::CeedVectorGetCeed(self.ptr, &mut ptr); 328 } 329 crate::check_error(ptr, ierr) 330 } 331 332 /// Returns the length of a Vector 333 /// 334 /// ``` 335 /// # use libceed::prelude::*; 336 /// # fn main() -> libceed::Result<()> { 337 /// # let ceed = libceed::Ceed::default_init(); 338 /// let vec = ceed.vector(10)?; 339 /// 340 /// let n = vec.length(); 341 /// assert_eq!(n, 10, "Incorrect length"); 342 /// # Ok(()) 343 /// # } 344 /// ``` 345 pub fn length(&self) -> usize { 346 let mut n = 0; 347 unsafe { bind_ceed::CeedVectorGetLength(self.ptr, &mut n) }; 348 usize::try_from(n).unwrap() 349 } 350 351 /// Returns the length of a Vector 352 /// 353 /// ``` 354 /// # use libceed::prelude::*; 355 /// # fn main() -> libceed::Result<()> { 356 /// # let ceed = libceed::Ceed::default_init(); 357 /// let vec = ceed.vector(10)?; 358 /// assert_eq!(vec.len(), 10, "Incorrect length"); 359 /// # Ok(()) 360 /// # } 361 /// ``` 362 pub fn len(&self) -> usize { 363 self.length() 364 } 365 366 /// Set the Vector to a constant value 367 /// 368 /// # arguments 369 /// 370 /// * `val` - Value to be used 371 /// 372 /// ``` 373 /// # use libceed::prelude::*; 374 /// # fn main() -> libceed::Result<()> { 375 /// # let ceed = libceed::Ceed::default_init(); 376 /// let len = 10; 377 /// let mut vec = ceed.vector(len)?; 378 /// 379 /// let val = 42.0; 380 /// vec.set_value(val)?; 381 /// 382 /// for v in vec.view()?.iter() { 383 /// assert_eq!(*v, val, "Value not set correctly"); 384 /// } 385 /// # Ok(()) 386 /// # } 387 /// ``` 388 pub fn set_value(&mut self, value: crate::Scalar) -> crate::Result<i32> { 389 let ierr = unsafe { bind_ceed::CeedVectorSetValue(self.ptr, value) }; 390 self.check_error(ierr) 391 } 392 393 /// Set values from a slice of the same length 394 /// 395 /// # arguments 396 /// 397 /// * `slice` - values to into self; length must match 398 /// 399 /// ``` 400 /// # use libceed::prelude::*; 401 /// # fn main() -> libceed::Result<()> { 402 /// # let ceed = libceed::Ceed::default_init(); 403 /// let mut vec = ceed.vector(4)?; 404 /// vec.set_slice(&[10., 11., 12., 13.])?; 405 /// 406 /// for (i, v) in vec.view()?.iter().enumerate() { 407 /// assert_eq!(*v, 10. + i as Scalar, "Slice not set correctly"); 408 /// } 409 /// # Ok(()) 410 /// # } 411 /// ``` 412 pub fn set_slice(&mut self, slice: &[crate::Scalar]) -> crate::Result<i32> { 413 assert_eq!(self.length(), slice.len()); 414 let (host, copy_mode) = ( 415 crate::MemType::Host as bind_ceed::CeedMemType, 416 crate::CopyMode::CopyValues as bind_ceed::CeedCopyMode, 417 ); 418 let ierr = unsafe { 419 bind_ceed::CeedVectorSetArray( 420 self.ptr, 421 host, 422 copy_mode, 423 slice.as_ptr() as *mut crate::Scalar, 424 ) 425 }; 426 self.check_error(ierr) 427 } 428 429 /// Wrap a mutable slice in a Vector of the same length 430 /// 431 /// # arguments 432 /// 433 /// * `slice` - values to wrap in self; length must match 434 /// 435 /// ``` 436 /// # use libceed::prelude::*; 437 /// # fn main() -> libceed::Result<()> { 438 /// # let ceed = libceed::Ceed::default_init(); 439 /// let mut vec = ceed.vector(4)?; 440 /// let mut array = [10., 11., 12., 13.]; 441 /// 442 /// { 443 /// // `wrapper` holds a mutable reference to the wrapped slice 444 /// // that is dropped when `wrapper` goes out of scope 445 /// let wrapper = vec.wrap_slice_mut(&mut array)?; 446 /// for (i, v) in vec.view()?.iter().enumerate() { 447 /// assert_eq!(*v, 10. + i as Scalar, "Slice not set correctly"); 448 /// } 449 /// 450 /// // This line will not compile, as the `wrapper` holds mutable 451 /// // access to the `array` 452 /// // array[0] = 5.0; 453 /// 454 /// // Changes here are reflected in the `array` 455 /// vec.set_value(5.0)?; 456 /// for v in vec.view()?.iter() { 457 /// assert_eq!(*v, 5.0 as Scalar, "Value not set correctly"); 458 /// } 459 /// } 460 /// 461 /// // 'array' remains changed 462 /// for v in array.iter() { 463 /// assert_eq!(*v, 5.0 as Scalar, "Array not mutated correctly"); 464 /// } 465 /// 466 /// // While changes to `vec` no longer affect `array` 467 /// vec.set_value(6.0)?; 468 /// for v in array.iter() { 469 /// assert_eq!(*v, 5.0 as Scalar, "Array mutated without permission"); 470 /// } 471 /// # Ok(()) 472 /// # } 473 /// ``` 474 pub fn wrap_slice_mut<'b>( 475 &mut self, 476 slice: &'b mut [crate::Scalar], 477 ) -> crate::Result<VectorSliceWrapper<'b>> { 478 crate::VectorSliceWrapper::from_vector_and_slice_mut(self, slice) 479 } 480 481 /// Sync the Vector to a specified memtype 482 /// 483 /// # arguments 484 /// 485 /// * `mtype` - Memtype to be synced 486 /// 487 /// ``` 488 /// # use libceed::prelude::*; 489 /// # fn main() -> libceed::Result<()> { 490 /// # let ceed = libceed::Ceed::default_init(); 491 /// let len = 10; 492 /// let mut vec = ceed.vector(len)?; 493 /// 494 /// let val = 42.0; 495 /// vec.set_value(val); 496 /// vec.sync(MemType::Host)?; 497 /// 498 /// for v in vec.view()?.iter() { 499 /// assert_eq!(*v, val, "Value not set correctly"); 500 /// } 501 /// # Ok(()) 502 /// # } 503 /// ``` 504 pub fn sync(&self, mtype: crate::MemType) -> crate::Result<i32> { 505 let ierr = 506 unsafe { bind_ceed::CeedVectorSyncArray(self.ptr, mtype as bind_ceed::CeedMemType) }; 507 self.check_error(ierr) 508 } 509 510 /// Create an immutable view 511 /// 512 /// ``` 513 /// # use libceed::prelude::*; 514 /// # fn main() -> libceed::Result<()> { 515 /// # let ceed = libceed::Ceed::default_init(); 516 /// let vec = ceed.vector_from_slice(&[10., 11., 12., 13.])?; 517 /// 518 /// let v = vec.view()?; 519 /// assert_eq!(v[0..2], [10., 11.]); 520 /// 521 /// // It is valid to have multiple immutable views 522 /// let w = vec.view()?; 523 /// assert_eq!(v[1..], w[1..]); 524 /// # Ok(()) 525 /// # } 526 /// ``` 527 pub fn view(&self) -> crate::Result<VectorView> { 528 VectorView::new(self) 529 } 530 531 /// Create an mutable view 532 /// 533 /// ``` 534 /// # use libceed::prelude::*; 535 /// # fn main() -> libceed::Result<()> { 536 /// # let ceed = libceed::Ceed::default_init(); 537 /// let mut vec = ceed.vector_from_slice(&[10., 11., 12., 13.])?; 538 /// 539 /// { 540 /// let mut v = vec.view_mut()?; 541 /// v[2] = 9.; 542 /// } 543 /// 544 /// let w = vec.view()?; 545 /// assert_eq!(w[2], 9., "View did not mutate data"); 546 /// # Ok(()) 547 /// # } 548 /// ``` 549 pub fn view_mut(&mut self) -> crate::Result<VectorViewMut> { 550 VectorViewMut::new(self) 551 } 552 553 /// Return the norm of a Vector 554 /// 555 /// # arguments 556 /// 557 /// * `ntype` - Norm type One, Two, or Max 558 /// 559 /// ``` 560 /// # use libceed::prelude::*; 561 /// # fn main() -> libceed::Result<()> { 562 /// # let ceed = libceed::Ceed::default_init(); 563 /// let vec = ceed.vector_from_slice(&[1., 2., 3., 4.])?; 564 /// 565 /// let max_norm = vec.norm(NormType::Max)?; 566 /// assert_eq!(max_norm, 4.0, "Incorrect Max norm"); 567 /// 568 /// let l1_norm = vec.norm(NormType::One)?; 569 /// assert_eq!(l1_norm, 10., "Incorrect L1 norm"); 570 /// 571 /// let l2_norm = vec.norm(NormType::Two)?; 572 /// assert!((l2_norm - 5.477) < 1e-3, "Incorrect L2 norm"); 573 /// # Ok(()) 574 /// # } 575 /// ``` 576 pub fn norm(&self, ntype: crate::NormType) -> crate::Result<crate::Scalar> { 577 let mut res: crate::Scalar = 0.0; 578 let ierr = unsafe { 579 bind_ceed::CeedVectorNorm(self.ptr, ntype as bind_ceed::CeedNormType, &mut res) 580 }; 581 self.check_error(ierr)?; 582 Ok(res) 583 } 584 585 /// Compute x = alpha x for a Vector 586 /// 587 /// # arguments 588 /// 589 /// * `alpha` - scaling factor 590 /// 591 /// ``` 592 /// # use libceed::prelude::*; 593 /// # fn main() -> libceed::Result<()> { 594 /// # let ceed = libceed::Ceed::default_init(); 595 /// let mut vec = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 596 /// 597 /// vec = vec.scale(-1.0)?; 598 /// for (i, v) in vec.view()?.iter().enumerate() { 599 /// assert_eq!(*v, -(i as Scalar), "Value not set correctly"); 600 /// } 601 /// # Ok(()) 602 /// # } 603 /// ``` 604 #[allow(unused_mut)] 605 pub fn scale(mut self, alpha: crate::Scalar) -> crate::Result<Self> { 606 let ierr = unsafe { bind_ceed::CeedVectorScale(self.ptr, alpha) }; 607 self.check_error(ierr)?; 608 Ok(self) 609 } 610 611 /// Compute y = alpha x + y for a pair of Vectors 612 /// 613 /// # arguments 614 /// 615 /// * `alpha` - scaling factor 616 /// * `x` - second vector, must be different than self 617 /// 618 /// ``` 619 /// # use libceed::prelude::*; 620 /// # fn main() -> libceed::Result<()> { 621 /// # let ceed = libceed::Ceed::default_init(); 622 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 623 /// let mut y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 624 /// 625 /// y = y.axpy(-0.5, &x)?; 626 /// for (i, y) in y.view()?.iter().enumerate() { 627 /// assert_eq!(*y, (i as Scalar) / 2.0, "Value not set correctly"); 628 /// } 629 /// # Ok(()) 630 /// # } 631 /// ``` 632 #[allow(unused_mut)] 633 pub fn axpy(mut self, alpha: crate::Scalar, x: &crate::Vector) -> crate::Result<Self> { 634 let ierr = unsafe { bind_ceed::CeedVectorAXPY(self.ptr, alpha, x.ptr) }; 635 self.check_error(ierr)?; 636 Ok(self) 637 } 638 639 /// Compute the pointwise multiplication w = x .* y for Vectors 640 /// 641 /// # arguments 642 /// 643 /// * `x` - first vector for product 644 /// * `y` - second vector for product 645 /// 646 /// ``` 647 /// # use libceed::prelude::*; 648 /// # fn main() -> libceed::Result<()> { 649 /// # let ceed = libceed::Ceed::default_init(); 650 /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 651 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 652 /// let y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 653 /// 654 /// w = w.pointwise_mult(&x, &y)?; 655 /// for (i, w) in w.view()?.iter().enumerate() { 656 /// assert_eq!(*w, (i as Scalar).powf(2.0), "Value not set correctly"); 657 /// } 658 /// # Ok(()) 659 /// # } 660 /// ``` 661 #[allow(unused_mut)] 662 pub fn pointwise_mult(mut self, x: &crate::Vector, y: &crate::Vector) -> crate::Result<Self> { 663 let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, x.ptr, y.ptr) }; 664 self.check_error(ierr)?; 665 Ok(self) 666 } 667 668 /// Compute the pointwise multiplication w = w .* x for Vectors 669 /// 670 /// # arguments 671 /// 672 /// * `x` - second vector for product 673 /// 674 /// ``` 675 /// # use libceed::prelude::*; 676 /// # fn main() -> libceed::Result<()> { 677 /// # let ceed = libceed::Ceed::default_init(); 678 /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 679 /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 680 /// 681 /// w = w.pointwise_scale(&x)?; 682 /// for (i, w) in w.view()?.iter().enumerate() { 683 /// assert_eq!(*w, (i as Scalar).powf(2.0), "Value not set correctly"); 684 /// } 685 /// # Ok(()) 686 /// # } 687 /// ``` 688 #[allow(unused_mut)] 689 pub fn pointwise_scale(mut self, x: &crate::Vector) -> crate::Result<Self> { 690 let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, self.ptr, x.ptr) }; 691 self.check_error(ierr)?; 692 Ok(self) 693 } 694 695 /// Compute the pointwise multiplication w = w .* w for a Vector 696 /// 697 /// ``` 698 /// # use libceed::prelude::*; 699 /// # fn main() -> libceed::Result<()> { 700 /// # let ceed = libceed::Ceed::default_init(); 701 /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 702 /// 703 /// w = w.pointwise_square()?; 704 /// for (i, w) in w.view()?.iter().enumerate() { 705 /// assert_eq!(*w, (i as Scalar).powf(2.0), "Value not set correctly"); 706 /// } 707 /// # Ok(()) 708 /// # } 709 /// ``` 710 #[allow(unused_mut)] 711 pub fn pointwise_square(mut self) -> crate::Result<Self> { 712 let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, self.ptr, self.ptr) }; 713 self.check_error(ierr)?; 714 Ok(self) 715 } 716 } 717 718 // ----------------------------------------------------------------------------- 719 // Vector Viewer 720 // ----------------------------------------------------------------------------- 721 /// A (host) view of a Vector with Deref to slice. We can't make 722 /// Vector itself Deref to slice because we can't handle the drop to 723 /// call bind_ceed::CeedVectorRestoreArrayRead(). 724 #[derive(Debug)] 725 pub struct VectorView<'a> { 726 vec: &'a Vector<'a>, 727 array: *const crate::Scalar, 728 } 729 730 impl<'a> VectorView<'a> { 731 /// Construct a VectorView from a Vector reference 732 fn new(vec: &'a Vector) -> crate::Result<Self> { 733 let mut array = std::ptr::null(); 734 let ierr = unsafe { 735 bind_ceed::CeedVectorGetArrayRead( 736 vec.ptr, 737 crate::MemType::Host as bind_ceed::CeedMemType, 738 &mut array, 739 ) 740 }; 741 vec.check_error(ierr)?; 742 Ok(Self { 743 vec: vec, 744 array: array, 745 }) 746 } 747 } 748 749 // Destructor 750 impl<'a> Drop for VectorView<'a> { 751 fn drop(&mut self) { 752 unsafe { 753 bind_ceed::CeedVectorRestoreArrayRead(self.vec.ptr, &mut self.array); 754 } 755 } 756 } 757 758 // Data access 759 impl<'a> Deref for VectorView<'a> { 760 type Target = [crate::Scalar]; 761 fn deref(&self) -> &[crate::Scalar] { 762 unsafe { std::slice::from_raw_parts(self.array, self.vec.len()) } 763 } 764 } 765 766 // Viewing 767 impl<'a> fmt::Display for VectorView<'a> { 768 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 769 write!(f, "VectorView({:?})", self.deref()) 770 } 771 } 772 773 // ----------------------------------------------------------------------------- 774 // Vector Viewer Mutable 775 // ----------------------------------------------------------------------------- 776 /// A mutable (host) view of a Vector with Deref to slice. 777 #[derive(Debug)] 778 pub struct VectorViewMut<'a> { 779 vec: &'a Vector<'a>, 780 array: *mut crate::Scalar, 781 } 782 783 impl<'a> VectorViewMut<'a> { 784 /// Construct a VectorViewMut from a Vector reference 785 fn new(vec: &'a mut Vector) -> crate::Result<Self> { 786 let mut ptr = std::ptr::null_mut(); 787 let ierr = unsafe { 788 bind_ceed::CeedVectorGetArray( 789 vec.ptr, 790 crate::MemType::Host as bind_ceed::CeedMemType, 791 &mut ptr, 792 ) 793 }; 794 vec.check_error(ierr)?; 795 Ok(Self { 796 vec: vec, 797 array: ptr, 798 }) 799 } 800 } 801 802 // Destructor 803 impl<'a> Drop for VectorViewMut<'a> { 804 fn drop(&mut self) { 805 unsafe { 806 bind_ceed::CeedVectorRestoreArray(self.vec.ptr, &mut self.array); 807 } 808 } 809 } 810 811 // Data access 812 impl<'a> Deref for VectorViewMut<'a> { 813 type Target = [crate::Scalar]; 814 fn deref(&self) -> &[crate::Scalar] { 815 unsafe { std::slice::from_raw_parts(self.array, self.vec.len()) } 816 } 817 } 818 819 // Mutable data access 820 impl<'a> DerefMut for VectorViewMut<'a> { 821 fn deref_mut(&mut self) -> &mut [crate::Scalar] { 822 unsafe { std::slice::from_raw_parts_mut(self.array, self.vec.len()) } 823 } 824 } 825 826 // Viewing 827 impl<'a> fmt::Display for VectorViewMut<'a> { 828 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 829 write!(f, "VectorViewMut({:?})", self.deref()) 830 } 831 } 832 833 // ----------------------------------------------------------------------------- 834