19df49d7eSJed Brown // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 29df49d7eSJed Brown // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 39df49d7eSJed Brown // reserved. See files LICENSE and NOTICE for details. 49df49d7eSJed Brown // 59df49d7eSJed Brown // This file is part of CEED, a collection of benchmarks, miniapps, software 69df49d7eSJed Brown // libraries and APIs for efficient high-order finite element and spectral 79df49d7eSJed Brown // element discretizations for exascale applications. For more information and 89df49d7eSJed Brown // source code availability see http://github.com/ceed. 99df49d7eSJed Brown // 109df49d7eSJed Brown // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 119df49d7eSJed Brown // a collaborative effort of two U.S. Department of Energy organizations (Office 129df49d7eSJed Brown // of Science and the National Nuclear Security Administration) responsible for 139df49d7eSJed Brown // the planning and preparation of a capable exascale ecosystem, including 149df49d7eSJed Brown // software, applications, hardware, advanced system engineering and early 159df49d7eSJed Brown // testbed platforms, in support of the nation's exascale computing imperative 169df49d7eSJed Brown 179df49d7eSJed Brown //! A Ceed Vector constitutes the main data structure and serves as input/output 189df49d7eSJed Brown //! for Ceed Operators. 199df49d7eSJed Brown 209df49d7eSJed Brown use std::{ 219df49d7eSJed Brown ops::{Deref, DerefMut}, 229df49d7eSJed Brown os::raw::c_char, 239df49d7eSJed Brown }; 249df49d7eSJed Brown 259df49d7eSJed Brown use crate::prelude::*; 269df49d7eSJed Brown 279df49d7eSJed Brown // ----------------------------------------------------------------------------- 289df49d7eSJed Brown // CeedVector option 299df49d7eSJed Brown // ----------------------------------------------------------------------------- 30c68be7a2SJeremy L Thompson #[derive(Debug)] 319df49d7eSJed Brown pub enum VectorOpt<'a> { 329df49d7eSJed Brown Some(&'a Vector<'a>), 339df49d7eSJed Brown Active, 349df49d7eSJed Brown None, 359df49d7eSJed Brown } 369df49d7eSJed Brown /// Construct a VectorOpt reference from a Vector reference 379df49d7eSJed Brown impl<'a> From<&'a Vector<'_>> for VectorOpt<'a> { 389df49d7eSJed Brown fn from(vec: &'a Vector) -> Self { 399df49d7eSJed Brown debug_assert!(vec.ptr != unsafe { bind_ceed::CEED_VECTOR_ACTIVE }); 40c68be7a2SJeremy L Thompson debug_assert!(vec.ptr != unsafe { bind_ceed::CEED_VECTOR_NONE }); 419df49d7eSJed Brown Self::Some(vec) 429df49d7eSJed Brown } 439df49d7eSJed Brown } 449df49d7eSJed Brown impl<'a> VectorOpt<'a> { 459df49d7eSJed Brown /// Transform a Rust libCEED VectorOpt into C libCEED CeedVector 469df49d7eSJed Brown pub(crate) fn to_raw(self) -> bind_ceed::CeedVector { 479df49d7eSJed Brown match self { 489df49d7eSJed Brown Self::Some(vec) => vec.ptr, 499df49d7eSJed Brown Self::Active => unsafe { bind_ceed::CEED_VECTOR_ACTIVE }, 50c68be7a2SJeremy L Thompson Self::None => unsafe { bind_ceed::CEED_VECTOR_NONE }, 519df49d7eSJed Brown } 529df49d7eSJed Brown } 53e03682afSJeremy L Thompson 54e03682afSJeremy L Thompson /// Check if a VectorOpt is Some 55e03682afSJeremy L Thompson /// 56e03682afSJeremy L Thompson /// ``` 57e03682afSJeremy L Thompson /// # use libceed::prelude::*; 58*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 59e03682afSJeremy L Thompson /// # let ceed = libceed::Ceed::default_init(); 60e03682afSJeremy L Thompson /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 61e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::from(&vec); 62e03682afSJeremy L Thompson /// assert!(vec_opt.is_some(), "Incorrect VectorOpt"); 63e03682afSJeremy L Thompson /// 64e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::Active; 65e03682afSJeremy L Thompson /// assert!(!vec_opt.is_some(), "Incorrect VectorOpt"); 66e03682afSJeremy L Thompson /// 67e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::None; 68e03682afSJeremy L Thompson /// assert!(!vec_opt.is_some(), "Incorrect VectorOpt"); 69e03682afSJeremy L Thompson /// # Ok(()) 70e03682afSJeremy L Thompson /// # } 71e03682afSJeremy L Thompson /// ``` 72e03682afSJeremy L Thompson pub fn is_some(&self) -> bool { 73e03682afSJeremy L Thompson match self { 74e03682afSJeremy L Thompson Self::Some(_) => true, 75e03682afSJeremy L Thompson Self::Active => false, 76e03682afSJeremy L Thompson Self::None => false, 77e03682afSJeremy L Thompson } 78e03682afSJeremy L Thompson } 79e03682afSJeremy L Thompson 80e03682afSJeremy L Thompson /// Check if a VectorOpt is Active 81e03682afSJeremy L Thompson /// 82e03682afSJeremy L Thompson /// ``` 83e03682afSJeremy L Thompson /// # use libceed::prelude::*; 84*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 85e03682afSJeremy L Thompson /// # let ceed = libceed::Ceed::default_init(); 86e03682afSJeremy L Thompson /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 87e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::from(&vec); 88e03682afSJeremy L Thompson /// assert!(!vec_opt.is_active(), "Incorrect VectorOpt"); 89e03682afSJeremy L Thompson /// 90e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::Active; 91e03682afSJeremy L Thompson /// assert!(vec_opt.is_active(), "Incorrect VectorOpt"); 92e03682afSJeremy L Thompson /// 93e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::None; 94e03682afSJeremy L Thompson /// assert!(!vec_opt.is_active(), "Incorrect VectorOpt"); 95e03682afSJeremy L Thompson /// # Ok(()) 96e03682afSJeremy L Thompson /// # } 97e03682afSJeremy L Thompson /// ``` 98e03682afSJeremy L Thompson pub fn is_active(&self) -> bool { 99e03682afSJeremy L Thompson match self { 100e03682afSJeremy L Thompson Self::Some(_) => false, 101e03682afSJeremy L Thompson Self::Active => true, 102e03682afSJeremy L Thompson Self::None => false, 103e03682afSJeremy L Thompson } 104e03682afSJeremy L Thompson } 105e03682afSJeremy L Thompson 106e03682afSJeremy L Thompson /// Check if a VectorOpt is Some 107e03682afSJeremy L Thompson /// 108e03682afSJeremy L Thompson /// ``` 109e03682afSJeremy L Thompson /// # use libceed::prelude::*; 110*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 111e03682afSJeremy L Thompson /// # let ceed = libceed::Ceed::default_init(); 112e03682afSJeremy L Thompson /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 113e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::from(&vec); 114e03682afSJeremy L Thompson /// assert!(!vec_opt.is_none(), "Incorrect VectorOpt"); 115e03682afSJeremy L Thompson /// 116e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::Active; 117e03682afSJeremy L Thompson /// assert!(!vec_opt.is_none(), "Incorrect VectorOpt"); 118e03682afSJeremy L Thompson /// 119e03682afSJeremy L Thompson /// let vec_opt = VectorOpt::None; 120e03682afSJeremy L Thompson /// assert!(vec_opt.is_none(), "Incorrect VectorOpt"); 121e03682afSJeremy L Thompson /// # Ok(()) 122e03682afSJeremy L Thompson /// # } 123e03682afSJeremy L Thompson /// ``` 124e03682afSJeremy L Thompson pub fn is_none(&self) -> bool { 125e03682afSJeremy L Thompson match self { 126e03682afSJeremy L Thompson Self::Some(_) => false, 127e03682afSJeremy L Thompson Self::Active => false, 128e03682afSJeremy L Thompson Self::None => true, 129e03682afSJeremy L Thompson } 130e03682afSJeremy L Thompson } 1319df49d7eSJed Brown } 1329df49d7eSJed Brown 1339df49d7eSJed Brown // ----------------------------------------------------------------------------- 1349df49d7eSJed Brown // CeedVector context wrapper 1359df49d7eSJed Brown // ----------------------------------------------------------------------------- 1369df49d7eSJed Brown #[derive(Debug)] 1379df49d7eSJed Brown pub struct Vector<'a> { 1389df49d7eSJed Brown pub(crate) ptr: bind_ceed::CeedVector, 1391142270cSJeremy L Thompson _lifeline: PhantomData<&'a ()>, 1409df49d7eSJed Brown } 1419df49d7eSJed Brown impl From<&'_ Vector<'_>> for bind_ceed::CeedVector { 1429df49d7eSJed Brown fn from(vec: &Vector) -> Self { 1439df49d7eSJed Brown vec.ptr 1449df49d7eSJed Brown } 1459df49d7eSJed Brown } 1469df49d7eSJed Brown 1479df49d7eSJed Brown // ----------------------------------------------------------------------------- 1489df49d7eSJed Brown // Destructor 1499df49d7eSJed Brown // ----------------------------------------------------------------------------- 1509df49d7eSJed Brown impl<'a> Drop for Vector<'a> { 1519df49d7eSJed Brown fn drop(&mut self) { 1529df49d7eSJed Brown let not_none_and_active = self.ptr != unsafe { bind_ceed::CEED_VECTOR_NONE } 1539df49d7eSJed Brown && self.ptr != unsafe { bind_ceed::CEED_VECTOR_ACTIVE }; 1549df49d7eSJed Brown 1559df49d7eSJed Brown if not_none_and_active { 1569df49d7eSJed Brown unsafe { bind_ceed::CeedVectorDestroy(&mut self.ptr) }; 1579df49d7eSJed Brown } 1589df49d7eSJed Brown } 1599df49d7eSJed Brown } 1609df49d7eSJed Brown 1619df49d7eSJed Brown // ----------------------------------------------------------------------------- 1629df49d7eSJed Brown // Display 1639df49d7eSJed Brown // ----------------------------------------------------------------------------- 1649df49d7eSJed Brown impl<'a> fmt::Display for Vector<'a> { 1659df49d7eSJed Brown /// View a Vector 1669df49d7eSJed Brown /// 1679df49d7eSJed Brown /// ``` 1689df49d7eSJed Brown /// # use libceed::prelude::*; 169*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 1709df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 171c68be7a2SJeremy L Thompson /// let vec = libceed::vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 1729df49d7eSJed Brown /// assert_eq!( 1739df49d7eSJed Brown /// vec.to_string(), 1749df49d7eSJed Brown /// "CeedVector length 3 1759df49d7eSJed Brown /// 1.00000000 1769df49d7eSJed Brown /// 2.00000000 1779df49d7eSJed Brown /// 3.00000000 1789df49d7eSJed Brown /// " 179c68be7a2SJeremy L Thompson /// ); 180c68be7a2SJeremy L Thompson /// # Ok(()) 181c68be7a2SJeremy L Thompson /// # } 1829df49d7eSJed Brown /// ``` 1839df49d7eSJed Brown fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 1849df49d7eSJed Brown let mut ptr = std::ptr::null_mut(); 1859df49d7eSJed Brown let mut sizeloc = crate::MAX_BUFFER_LENGTH; 1869df49d7eSJed Brown let format = CString::new("%12.8f").expect("CString::new failed"); 1879df49d7eSJed Brown let format_c: *const c_char = format.into_raw(); 1889df49d7eSJed Brown let cstring = unsafe { 1899df49d7eSJed Brown let file = bind_ceed::open_memstream(&mut ptr, &mut sizeloc); 1909df49d7eSJed Brown bind_ceed::CeedVectorView(self.ptr, format_c, file); 1919df49d7eSJed Brown bind_ceed::fclose(file); 1929df49d7eSJed Brown CString::from_raw(ptr) 1939df49d7eSJed Brown }; 1949df49d7eSJed Brown cstring.to_string_lossy().fmt(f) 1959df49d7eSJed Brown } 1969df49d7eSJed Brown } 1979df49d7eSJed Brown 1989df49d7eSJed Brown // ----------------------------------------------------------------------------- 1999df49d7eSJed Brown // Implementations 2009df49d7eSJed Brown // ----------------------------------------------------------------------------- 2019df49d7eSJed Brown impl<'a> Vector<'a> { 2029df49d7eSJed Brown // Constructors 2039df49d7eSJed Brown pub fn create(ceed: &'a crate::Ceed, n: usize) -> crate::Result<Self> { 2049df49d7eSJed Brown let n = i32::try_from(n).unwrap(); 2059df49d7eSJed Brown let mut ptr = std::ptr::null_mut(); 2069df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorCreate(ceed.ptr, n, &mut ptr) }; 2079df49d7eSJed Brown ceed.check_error(ierr)?; 2081142270cSJeremy L Thompson Ok(Self { 2091142270cSJeremy L Thompson ptr, 2101142270cSJeremy L Thompson _lifeline: PhantomData, 2111142270cSJeremy L Thompson }) 2129df49d7eSJed Brown } 2139df49d7eSJed Brown 2141142270cSJeremy L Thompson pub(crate) fn from_raw(ptr: bind_ceed::CeedVector) -> crate::Result<Self> { 2151142270cSJeremy L Thompson Ok(Self { 2161142270cSJeremy L Thompson ptr, 2171142270cSJeremy L Thompson _lifeline: PhantomData, 2181142270cSJeremy L Thompson }) 2199df49d7eSJed Brown } 2209df49d7eSJed Brown 2219df49d7eSJed Brown /// Create a Vector from a slice 2229df49d7eSJed Brown /// 2239df49d7eSJed Brown /// # arguments 2249df49d7eSJed Brown /// 2259df49d7eSJed Brown /// * `slice` - values to initialize vector with 2269df49d7eSJed Brown /// 2279df49d7eSJed Brown /// ``` 2289df49d7eSJed Brown /// # use libceed::prelude::*; 229*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 2309df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 231c68be7a2SJeremy L Thompson /// let vec = vector::Vector::from_slice(&ceed, &[1., 2., 3.])?; 2329df49d7eSJed Brown /// assert_eq!(vec.length(), 3, "Incorrect length from slice"); 233c68be7a2SJeremy L Thompson /// # Ok(()) 234c68be7a2SJeremy L Thompson /// # } 2359df49d7eSJed Brown /// ``` 23680a9ef05SNatalie Beams pub fn from_slice(ceed: &'a crate::Ceed, v: &[crate::Scalar]) -> crate::Result<Self> { 2379df49d7eSJed Brown let mut x = Self::create(ceed, v.len())?; 2389df49d7eSJed Brown x.set_slice(v)?; 2399df49d7eSJed Brown Ok(x) 2409df49d7eSJed Brown } 2419df49d7eSJed Brown 2429df49d7eSJed Brown /// Create a Vector from a mutable array reference 2439df49d7eSJed Brown /// 2449df49d7eSJed Brown /// # arguments 2459df49d7eSJed Brown /// 2469df49d7eSJed Brown /// * `slice` - values to initialize vector with 2479df49d7eSJed Brown /// 2489df49d7eSJed Brown /// ``` 2499df49d7eSJed Brown /// # use libceed::prelude::*; 250*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 2519df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 2529df49d7eSJed Brown /// let mut rust_vec = vec![1., 2., 3.]; 253c68be7a2SJeremy L Thompson /// let vec = libceed::vector::Vector::from_array(&ceed, &mut rust_vec)?; 2549df49d7eSJed Brown /// 2559df49d7eSJed Brown /// assert_eq!(vec.length(), 3, "Incorrect length from slice"); 256c68be7a2SJeremy L Thompson /// # Ok(()) 257c68be7a2SJeremy L Thompson /// # } 2589df49d7eSJed Brown /// ``` 25980a9ef05SNatalie Beams pub fn from_array(ceed: &'a crate::Ceed, v: &mut [crate::Scalar]) -> crate::Result<Self> { 2609df49d7eSJed Brown let x = Self::create(ceed, v.len())?; 2619df49d7eSJed Brown let (host, user_pointer) = ( 2629df49d7eSJed Brown crate::MemType::Host as bind_ceed::CeedMemType, 2639df49d7eSJed Brown crate::CopyMode::UsePointer as bind_ceed::CeedCopyMode, 2649df49d7eSJed Brown ); 26580a9ef05SNatalie Beams let v = v.as_ptr() as *mut crate::Scalar; 2669df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorSetArray(x.ptr, host, user_pointer, v) }; 2679df49d7eSJed Brown ceed.check_error(ierr)?; 2689df49d7eSJed Brown Ok(x) 2699df49d7eSJed Brown } 2709df49d7eSJed Brown 2711142270cSJeremy L Thompson // Error handling 2721142270cSJeremy L Thompson #[doc(hidden)] 2731142270cSJeremy L Thompson fn check_error(&self, ierr: i32) -> crate::Result<i32> { 2741142270cSJeremy L Thompson let mut ptr = std::ptr::null_mut(); 2751142270cSJeremy L Thompson unsafe { 2761142270cSJeremy L Thompson bind_ceed::CeedVectorGetCeed(self.ptr, &mut ptr); 2771142270cSJeremy L Thompson } 2781142270cSJeremy L Thompson crate::check_error(ptr, ierr) 2791142270cSJeremy L Thompson } 2801142270cSJeremy L Thompson 2819df49d7eSJed Brown /// Returns the length of a CeedVector 2829df49d7eSJed Brown /// 2839df49d7eSJed Brown /// ``` 2849df49d7eSJed Brown /// # use libceed::prelude::*; 285*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 2869df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 287c68be7a2SJeremy L Thompson /// let vec = ceed.vector(10)?; 2889df49d7eSJed Brown /// 2899df49d7eSJed Brown /// let n = vec.length(); 2909df49d7eSJed Brown /// assert_eq!(n, 10, "Incorrect length"); 291c68be7a2SJeremy L Thompson /// # Ok(()) 292c68be7a2SJeremy L Thompson /// # } 2939df49d7eSJed Brown /// ``` 2949df49d7eSJed Brown pub fn length(&self) -> usize { 2959df49d7eSJed Brown let mut n = 0; 2969df49d7eSJed Brown unsafe { bind_ceed::CeedVectorGetLength(self.ptr, &mut n) }; 2979df49d7eSJed Brown usize::try_from(n).unwrap() 2989df49d7eSJed Brown } 2999df49d7eSJed Brown 3009df49d7eSJed Brown /// Returns the length of a CeedVector 3019df49d7eSJed Brown /// 3029df49d7eSJed Brown /// ``` 3039df49d7eSJed Brown /// # use libceed::prelude::*; 304*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 3059df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 306c68be7a2SJeremy L Thompson /// let vec = ceed.vector(10)?; 3079df49d7eSJed Brown /// assert_eq!(vec.len(), 10, "Incorrect length"); 308c68be7a2SJeremy L Thompson /// # Ok(()) 309c68be7a2SJeremy L Thompson /// # } 3109df49d7eSJed Brown /// ``` 3119df49d7eSJed Brown pub fn len(&self) -> usize { 3129df49d7eSJed Brown self.length() 3139df49d7eSJed Brown } 3149df49d7eSJed Brown 3159df49d7eSJed Brown /// Set the CeedVector to a constant value 3169df49d7eSJed Brown /// 3179df49d7eSJed Brown /// # arguments 3189df49d7eSJed Brown /// 3199df49d7eSJed Brown /// * `val` - Value to be used 3209df49d7eSJed Brown /// 3219df49d7eSJed Brown /// ``` 3229df49d7eSJed Brown /// # use libceed::prelude::*; 323*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 3249df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 3259df49d7eSJed Brown /// let len = 10; 326c68be7a2SJeremy L Thompson /// let mut vec = ceed.vector(len)?; 3279df49d7eSJed Brown /// 3289df49d7eSJed Brown /// let val = 42.0; 329c68be7a2SJeremy L Thompson /// vec.set_value(val)?; 3309df49d7eSJed Brown /// 331e78171edSJeremy L Thompson /// vec.view()?.iter().for_each(|v| { 3329df49d7eSJed Brown /// assert_eq!(*v, val, "Value not set correctly"); 3339df49d7eSJed Brown /// }); 334c68be7a2SJeremy L Thompson /// # Ok(()) 335c68be7a2SJeremy L Thompson /// # } 3369df49d7eSJed Brown /// ``` 33780a9ef05SNatalie Beams pub fn set_value(&mut self, value: crate::Scalar) -> crate::Result<i32> { 3389df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorSetValue(self.ptr, value) }; 3391142270cSJeremy L Thompson self.check_error(ierr) 3409df49d7eSJed Brown } 3419df49d7eSJed Brown 3429df49d7eSJed Brown /// Set values from a slice of the same length 3439df49d7eSJed Brown /// 3449df49d7eSJed Brown /// # arguments 3459df49d7eSJed Brown /// 3469df49d7eSJed Brown /// * `slice` - values to into self; length must match 3479df49d7eSJed Brown /// 3489df49d7eSJed Brown /// ``` 3499df49d7eSJed Brown /// # use libceed::prelude::*; 350*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 3519df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 352c68be7a2SJeremy L Thompson /// let mut vec = ceed.vector(4)?; 353c68be7a2SJeremy L Thompson /// vec.set_slice(&[10., 11., 12., 13.])?; 3549df49d7eSJed Brown /// 355e78171edSJeremy L Thompson /// vec.view()?.iter().enumerate().for_each(|(i, v)| { 35680a9ef05SNatalie Beams /// assert_eq!(*v, 10. + i as Scalar, "Slice not set correctly"); 3579df49d7eSJed Brown /// }); 358c68be7a2SJeremy L Thompson /// # Ok(()) 359c68be7a2SJeremy L Thompson /// # } 3609df49d7eSJed Brown /// ``` 36180a9ef05SNatalie Beams pub fn set_slice(&mut self, slice: &[crate::Scalar]) -> crate::Result<i32> { 3629df49d7eSJed Brown assert_eq!(self.length(), slice.len()); 3639df49d7eSJed Brown let (host, copy_mode) = ( 3649df49d7eSJed Brown crate::MemType::Host as bind_ceed::CeedMemType, 3659df49d7eSJed Brown crate::CopyMode::CopyValues as bind_ceed::CeedCopyMode, 3669df49d7eSJed Brown ); 3679df49d7eSJed Brown let ierr = unsafe { 36880a9ef05SNatalie Beams bind_ceed::CeedVectorSetArray( 36980a9ef05SNatalie Beams self.ptr, 37080a9ef05SNatalie Beams host, 37180a9ef05SNatalie Beams copy_mode, 37280a9ef05SNatalie Beams slice.as_ptr() as *mut crate::Scalar, 37380a9ef05SNatalie Beams ) 3749df49d7eSJed Brown }; 3751142270cSJeremy L Thompson self.check_error(ierr) 3769df49d7eSJed Brown } 3779df49d7eSJed Brown 3789df49d7eSJed Brown /// Sync the CeedVector to a specified memtype 3799df49d7eSJed Brown /// 3809df49d7eSJed Brown /// # arguments 3819df49d7eSJed Brown /// 3829df49d7eSJed Brown /// * `mtype` - Memtype to be synced 3839df49d7eSJed Brown /// 3849df49d7eSJed Brown /// ``` 3859df49d7eSJed Brown /// # use libceed::prelude::*; 386*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 3879df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 3889df49d7eSJed Brown /// let len = 10; 389c68be7a2SJeremy L Thompson /// let mut vec = ceed.vector(len)?; 3909df49d7eSJed Brown /// 3919df49d7eSJed Brown /// let val = 42.0; 3929df49d7eSJed Brown /// vec.set_value(val); 393c68be7a2SJeremy L Thompson /// vec.sync(MemType::Host)?; 3949df49d7eSJed Brown /// 395e78171edSJeremy L Thompson /// vec.view()?.iter().for_each(|v| { 3969df49d7eSJed Brown /// assert_eq!(*v, val, "Value not set correctly"); 3979df49d7eSJed Brown /// }); 398c68be7a2SJeremy L Thompson /// # Ok(()) 399c68be7a2SJeremy L Thompson /// # } 4009df49d7eSJed Brown /// ``` 4019df49d7eSJed Brown pub fn sync(&self, mtype: crate::MemType) -> crate::Result<i32> { 4029df49d7eSJed Brown let ierr = 4039df49d7eSJed Brown unsafe { bind_ceed::CeedVectorSyncArray(self.ptr, mtype as bind_ceed::CeedMemType) }; 4041142270cSJeremy L Thompson self.check_error(ierr) 4059df49d7eSJed Brown } 4069df49d7eSJed Brown 4079df49d7eSJed Brown /// Create an immutable view 4089df49d7eSJed Brown /// 4099df49d7eSJed Brown /// ``` 4109df49d7eSJed Brown /// # use libceed::prelude::*; 411*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 4129df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 413c68be7a2SJeremy L Thompson /// let vec = ceed.vector_from_slice(&[10., 11., 12., 13.])?; 4149df49d7eSJed Brown /// 415e78171edSJeremy L Thompson /// let v = vec.view()?; 4169df49d7eSJed Brown /// assert_eq!(v[0..2], [10., 11.]); 4179df49d7eSJed Brown /// 4189df49d7eSJed Brown /// // It is valid to have multiple immutable views 419e78171edSJeremy L Thompson /// let w = vec.view()?; 4209df49d7eSJed Brown /// assert_eq!(v[1..], w[1..]); 421c68be7a2SJeremy L Thompson /// # Ok(()) 422c68be7a2SJeremy L Thompson /// # } 4239df49d7eSJed Brown /// ``` 424e78171edSJeremy L Thompson pub fn view(&self) -> crate::Result<VectorView> { 4259df49d7eSJed Brown VectorView::new(self) 4269df49d7eSJed Brown } 4279df49d7eSJed Brown 4289df49d7eSJed Brown /// Create an mutable view 4299df49d7eSJed Brown /// 4309df49d7eSJed Brown /// ``` 4319df49d7eSJed Brown /// # use libceed::prelude::*; 432*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 4339df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 434c68be7a2SJeremy L Thompson /// let mut vec = ceed.vector_from_slice(&[10., 11., 12., 13.])?; 4359df49d7eSJed Brown /// 4369df49d7eSJed Brown /// { 437e78171edSJeremy L Thompson /// let mut v = vec.view_mut()?; 4389df49d7eSJed Brown /// v[2] = 9.; 4399df49d7eSJed Brown /// } 4409df49d7eSJed Brown /// 441e78171edSJeremy L Thompson /// let w = vec.view()?; 4429df49d7eSJed Brown /// assert_eq!(w[2], 9., "View did not mutate data"); 443c68be7a2SJeremy L Thompson /// # Ok(()) 444c68be7a2SJeremy L Thompson /// # } 4459df49d7eSJed Brown /// ``` 446e78171edSJeremy L Thompson pub fn view_mut(&mut self) -> crate::Result<VectorViewMut> { 4479df49d7eSJed Brown VectorViewMut::new(self) 4489df49d7eSJed Brown } 4499df49d7eSJed Brown 4509df49d7eSJed Brown /// Return the norm of a CeedVector 4519df49d7eSJed Brown /// 4529df49d7eSJed Brown /// # arguments 4539df49d7eSJed Brown /// 4549df49d7eSJed Brown /// * `ntype` - Norm type One, Two, or Max 4559df49d7eSJed Brown /// 4569df49d7eSJed Brown /// ``` 4579df49d7eSJed Brown /// # use libceed::prelude::*; 458*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 4599df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 460c68be7a2SJeremy L Thompson /// let vec = ceed.vector_from_slice(&[1., 2., 3., 4.])?; 4619df49d7eSJed Brown /// 462c68be7a2SJeremy L Thompson /// let max_norm = vec.norm(NormType::Max)?; 4639df49d7eSJed Brown /// assert_eq!(max_norm, 4.0, "Incorrect Max norm"); 4649df49d7eSJed Brown /// 465c68be7a2SJeremy L Thompson /// let l1_norm = vec.norm(NormType::One)?; 4669df49d7eSJed Brown /// assert_eq!(l1_norm, 10., "Incorrect L1 norm"); 4679df49d7eSJed Brown /// 468c68be7a2SJeremy L Thompson /// let l2_norm = vec.norm(NormType::Two)?; 4699df49d7eSJed Brown /// assert!((l2_norm - 5.477) < 1e-3, "Incorrect L2 norm"); 470c68be7a2SJeremy L Thompson /// # Ok(()) 471c68be7a2SJeremy L Thompson /// # } 4729df49d7eSJed Brown /// ``` 47380a9ef05SNatalie Beams pub fn norm(&self, ntype: crate::NormType) -> crate::Result<crate::Scalar> { 47480a9ef05SNatalie Beams let mut res: crate::Scalar = 0.0; 4759df49d7eSJed Brown let ierr = unsafe { 4769df49d7eSJed Brown bind_ceed::CeedVectorNorm(self.ptr, ntype as bind_ceed::CeedNormType, &mut res) 4779df49d7eSJed Brown }; 4781142270cSJeremy L Thompson self.check_error(ierr)?; 4799df49d7eSJed Brown Ok(res) 4809df49d7eSJed Brown } 4819df49d7eSJed Brown 4829df49d7eSJed Brown /// Compute x = alpha x for a CeedVector 4839df49d7eSJed Brown /// 4849df49d7eSJed Brown /// # arguments 4859df49d7eSJed Brown /// 4869df49d7eSJed Brown /// * `alpha` - scaling factor 4879df49d7eSJed Brown /// 4889df49d7eSJed Brown /// ``` 4899df49d7eSJed Brown /// # use libceed::prelude::*; 490*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 4919df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 492c68be7a2SJeremy L Thompson /// let mut vec = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 4939df49d7eSJed Brown /// 494c68be7a2SJeremy L Thompson /// vec = vec.scale(-1.0)?; 495e78171edSJeremy L Thompson /// vec.view()?.iter().enumerate().for_each(|(i, &v)| { 49680a9ef05SNatalie Beams /// assert_eq!(v, -(i as Scalar), "Value not set correctly"); 4979df49d7eSJed Brown /// }); 498c68be7a2SJeremy L Thompson /// # Ok(()) 499c68be7a2SJeremy L Thompson /// # } 5009df49d7eSJed Brown /// ``` 5019df49d7eSJed Brown #[allow(unused_mut)] 50280a9ef05SNatalie Beams pub fn scale(mut self, alpha: crate::Scalar) -> crate::Result<Self> { 5039df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorScale(self.ptr, alpha) }; 5041142270cSJeremy L Thompson self.check_error(ierr)?; 5059df49d7eSJed Brown Ok(self) 5069df49d7eSJed Brown } 5079df49d7eSJed Brown 5089df49d7eSJed Brown /// Compute y = alpha x + y for a pair of CeedVectors 5099df49d7eSJed Brown /// 5109df49d7eSJed Brown /// # arguments 5119df49d7eSJed Brown /// 5129df49d7eSJed Brown /// * `alpha` - scaling factor 5139df49d7eSJed Brown /// * `x` - second vector, must be different than self 5149df49d7eSJed Brown /// 5159df49d7eSJed Brown /// ``` 5169df49d7eSJed Brown /// # use libceed::prelude::*; 517*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 5189df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 519c68be7a2SJeremy L Thompson /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 520c68be7a2SJeremy L Thompson /// let mut y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 5219df49d7eSJed Brown /// 522c68be7a2SJeremy L Thompson /// y = y.axpy(-0.5, &x)?; 523e78171edSJeremy L Thompson /// y.view()?.iter().enumerate().for_each(|(i, &v)| { 52480a9ef05SNatalie Beams /// assert_eq!(v, (i as Scalar) / 2.0, "Value not set correctly"); 5259df49d7eSJed Brown /// }); 526c68be7a2SJeremy L Thompson /// # Ok(()) 527c68be7a2SJeremy L Thompson /// # } 5289df49d7eSJed Brown /// ``` 5299df49d7eSJed Brown #[allow(unused_mut)] 53080a9ef05SNatalie Beams pub fn axpy(mut self, alpha: crate::Scalar, x: &crate::Vector) -> crate::Result<Self> { 5319df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorAXPY(self.ptr, alpha, x.ptr) }; 5321142270cSJeremy L Thompson self.check_error(ierr)?; 5339df49d7eSJed Brown Ok(self) 5349df49d7eSJed Brown } 5359df49d7eSJed Brown 5369df49d7eSJed Brown /// Compute the pointwise multiplication w = x .* y for CeedVectors 5379df49d7eSJed Brown /// 5389df49d7eSJed Brown /// # arguments 5399df49d7eSJed Brown /// 5409df49d7eSJed Brown /// * `x` - first vector for product 5419df49d7eSJed Brown /// * `y` - second vector for product 5429df49d7eSJed Brown /// 5439df49d7eSJed Brown /// ``` 5449df49d7eSJed Brown /// # use libceed::prelude::*; 545*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 5469df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 547c68be7a2SJeremy L Thompson /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 548c68be7a2SJeremy L Thompson /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 549c68be7a2SJeremy L Thompson /// let y = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 5509df49d7eSJed Brown /// 551c68be7a2SJeremy L Thompson /// w = w.pointwise_mult(&x, &y)?; 552e78171edSJeremy L Thompson /// w.view()?.iter().enumerate().for_each(|(i, &v)| { 55380a9ef05SNatalie Beams /// assert_eq!(v, (i as Scalar).powf(2.0), "Value not set correctly"); 5549df49d7eSJed Brown /// }); 555c68be7a2SJeremy L Thompson /// # Ok(()) 556c68be7a2SJeremy L Thompson /// # } 5579df49d7eSJed Brown /// ``` 5589df49d7eSJed Brown #[allow(unused_mut)] 5599df49d7eSJed Brown pub fn pointwise_mult(mut self, x: &crate::Vector, y: &crate::Vector) -> crate::Result<Self> { 5609df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, x.ptr, y.ptr) }; 5611142270cSJeremy L Thompson self.check_error(ierr)?; 5629df49d7eSJed Brown Ok(self) 5639df49d7eSJed Brown } 5649df49d7eSJed Brown 5659df49d7eSJed Brown /// Compute the pointwise multiplication w = w .* x for CeedVectors 5669df49d7eSJed Brown /// 5679df49d7eSJed Brown /// # arguments 5689df49d7eSJed Brown /// 5699df49d7eSJed Brown /// * `x` - second vector for product 5709df49d7eSJed Brown /// 5719df49d7eSJed Brown /// ``` 5729df49d7eSJed Brown /// # use libceed::prelude::*; 573*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 5749df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 575c68be7a2SJeremy L Thompson /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 576c68be7a2SJeremy L Thompson /// let x = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 5779df49d7eSJed Brown /// 578c68be7a2SJeremy L Thompson /// w = w.pointwise_scale(&x)?; 579e78171edSJeremy L Thompson /// w.view()?.iter().enumerate().for_each(|(i, &v)| { 58080a9ef05SNatalie Beams /// assert_eq!(v, (i as Scalar).powf(2.0), "Value not set correctly"); 5819df49d7eSJed Brown /// }); 582c68be7a2SJeremy L Thompson /// # Ok(()) 583c68be7a2SJeremy L Thompson /// # } 5849df49d7eSJed Brown /// ``` 5859df49d7eSJed Brown #[allow(unused_mut)] 5869df49d7eSJed Brown pub fn pointwise_scale(mut self, x: &crate::Vector) -> crate::Result<Self> { 5879df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, self.ptr, x.ptr) }; 5881142270cSJeremy L Thompson self.check_error(ierr)?; 5899df49d7eSJed Brown Ok(self) 5909df49d7eSJed Brown } 5919df49d7eSJed Brown 5929df49d7eSJed Brown /// Compute the pointwise multiplication w = w .* w for a CeedVector 5939df49d7eSJed Brown /// 5949df49d7eSJed Brown /// ``` 5959df49d7eSJed Brown /// # use libceed::prelude::*; 596*4d27c890SJeremy L Thompson /// # fn main() -> libceed::Result<()> { 5979df49d7eSJed Brown /// # let ceed = libceed::Ceed::default_init(); 598c68be7a2SJeremy L Thompson /// let mut w = ceed.vector_from_slice(&[0., 1., 2., 3., 4.])?; 5999df49d7eSJed Brown /// 600c68be7a2SJeremy L Thompson /// w = w.pointwise_square()?; 601e78171edSJeremy L Thompson /// w.view()?.iter().enumerate().for_each(|(i, &v)| { 60280a9ef05SNatalie Beams /// assert_eq!(v, (i as Scalar).powf(2.0), "Value not set correctly"); 6039df49d7eSJed Brown /// }); 604c68be7a2SJeremy L Thompson /// # Ok(()) 605c68be7a2SJeremy L Thompson /// # } 6069df49d7eSJed Brown /// ``` 6079df49d7eSJed Brown #[allow(unused_mut)] 6089df49d7eSJed Brown pub fn pointwise_square(mut self) -> crate::Result<Self> { 6099df49d7eSJed Brown let ierr = unsafe { bind_ceed::CeedVectorPointwiseMult(self.ptr, self.ptr, self.ptr) }; 6101142270cSJeremy L Thompson self.check_error(ierr)?; 6119df49d7eSJed Brown Ok(self) 6129df49d7eSJed Brown } 6139df49d7eSJed Brown } 6149df49d7eSJed Brown 6159df49d7eSJed Brown // ----------------------------------------------------------------------------- 6169df49d7eSJed Brown // Vector Viewer 6179df49d7eSJed Brown // ----------------------------------------------------------------------------- 6189df49d7eSJed Brown /// A (host) view of a Vector with Deref to slice. We can't make 6199df49d7eSJed Brown /// Vector itself Deref to slice because we can't handle the drop to 6209df49d7eSJed Brown /// call bind_ceed::CeedVectorRestoreArrayRead(). 6219df49d7eSJed Brown #[derive(Debug)] 6229df49d7eSJed Brown pub struct VectorView<'a> { 6239df49d7eSJed Brown vec: &'a Vector<'a>, 62480a9ef05SNatalie Beams array: *const crate::Scalar, 6259df49d7eSJed Brown } 6269df49d7eSJed Brown 6279df49d7eSJed Brown impl<'a> VectorView<'a> { 6289df49d7eSJed Brown /// Construct a VectorView from a Vector reference 629*4d27c890SJeremy L Thompson fn new(vec: &'a Vector) -> crate::Result<Self> { 6309df49d7eSJed Brown let mut array = std::ptr::null(); 631e78171edSJeremy L Thompson let ierr = unsafe { 6329df49d7eSJed Brown bind_ceed::CeedVectorGetArrayRead( 6339df49d7eSJed Brown vec.ptr, 6349df49d7eSJed Brown crate::MemType::Host as bind_ceed::CeedMemType, 6359df49d7eSJed Brown &mut array, 636e78171edSJeremy L Thompson ) 637e78171edSJeremy L Thompson }; 638e78171edSJeremy L Thompson vec.check_error(ierr)?; 639e78171edSJeremy L Thompson Ok(Self { 6409df49d7eSJed Brown vec: vec, 6419df49d7eSJed Brown array: array, 642e78171edSJeremy L Thompson }) 6439df49d7eSJed Brown } 6449df49d7eSJed Brown } 6459df49d7eSJed Brown 6469df49d7eSJed Brown // Destructor 6479df49d7eSJed Brown impl<'a> Drop for VectorView<'a> { 6489df49d7eSJed Brown fn drop(&mut self) { 6499df49d7eSJed Brown unsafe { 6509df49d7eSJed Brown bind_ceed::CeedVectorRestoreArrayRead(self.vec.ptr, &mut self.array); 6519df49d7eSJed Brown } 6529df49d7eSJed Brown } 6539df49d7eSJed Brown } 6549df49d7eSJed Brown 6559df49d7eSJed Brown // Data access 6569df49d7eSJed Brown impl<'a> Deref for VectorView<'a> { 65780a9ef05SNatalie Beams type Target = [crate::Scalar]; 65880a9ef05SNatalie Beams fn deref(&self) -> &[crate::Scalar] { 6599df49d7eSJed Brown unsafe { std::slice::from_raw_parts(self.array, self.vec.len()) } 6609df49d7eSJed Brown } 6619df49d7eSJed Brown } 6629df49d7eSJed Brown 6639df49d7eSJed Brown // Viewing 6649df49d7eSJed Brown impl<'a> fmt::Display for VectorView<'a> { 6659df49d7eSJed Brown fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 6669df49d7eSJed Brown write!(f, "VectorView({:?})", self.deref()) 6679df49d7eSJed Brown } 6689df49d7eSJed Brown } 6699df49d7eSJed Brown 6709df49d7eSJed Brown // ----------------------------------------------------------------------------- 6719df49d7eSJed Brown // Vector Viewer Mutable 6729df49d7eSJed Brown // ----------------------------------------------------------------------------- 6739df49d7eSJed Brown /// A mutable (host) view of a Vector with Deref to slice. 6749df49d7eSJed Brown #[derive(Debug)] 6759df49d7eSJed Brown pub struct VectorViewMut<'a> { 6769df49d7eSJed Brown vec: &'a Vector<'a>, 67780a9ef05SNatalie Beams array: *mut crate::Scalar, 6789df49d7eSJed Brown } 6799df49d7eSJed Brown 6809df49d7eSJed Brown impl<'a> VectorViewMut<'a> { 6819df49d7eSJed Brown /// Construct a VectorViewMut from a Vector reference 682*4d27c890SJeremy L Thompson fn new(vec: &'a mut Vector) -> crate::Result<Self> { 6839df49d7eSJed Brown let mut ptr = std::ptr::null_mut(); 684e78171edSJeremy L Thompson let ierr = unsafe { 6859df49d7eSJed Brown bind_ceed::CeedVectorGetArray( 6869df49d7eSJed Brown vec.ptr, 6879df49d7eSJed Brown crate::MemType::Host as bind_ceed::CeedMemType, 6889df49d7eSJed Brown &mut ptr, 689e78171edSJeremy L Thompson ) 690e78171edSJeremy L Thompson }; 691e78171edSJeremy L Thompson vec.check_error(ierr)?; 692e78171edSJeremy L Thompson Ok(Self { 6939df49d7eSJed Brown vec: vec, 6949df49d7eSJed Brown array: ptr, 695e78171edSJeremy L Thompson }) 6969df49d7eSJed Brown } 6979df49d7eSJed Brown } 6989df49d7eSJed Brown 6999df49d7eSJed Brown // Destructor 7009df49d7eSJed Brown impl<'a> Drop for VectorViewMut<'a> { 7019df49d7eSJed Brown fn drop(&mut self) { 7029df49d7eSJed Brown unsafe { 7039df49d7eSJed Brown bind_ceed::CeedVectorRestoreArray(self.vec.ptr, &mut self.array); 7049df49d7eSJed Brown } 7059df49d7eSJed Brown } 7069df49d7eSJed Brown } 7079df49d7eSJed Brown 7089df49d7eSJed Brown // Data access 7099df49d7eSJed Brown impl<'a> Deref for VectorViewMut<'a> { 71080a9ef05SNatalie Beams type Target = [crate::Scalar]; 71180a9ef05SNatalie Beams fn deref(&self) -> &[crate::Scalar] { 7129df49d7eSJed Brown unsafe { std::slice::from_raw_parts(self.array, self.vec.len()) } 7139df49d7eSJed Brown } 7149df49d7eSJed Brown } 7159df49d7eSJed Brown 7169df49d7eSJed Brown // Mutable data access 7179df49d7eSJed Brown impl<'a> DerefMut for VectorViewMut<'a> { 71880a9ef05SNatalie Beams fn deref_mut(&mut self) -> &mut [crate::Scalar] { 7199df49d7eSJed Brown unsafe { std::slice::from_raw_parts_mut(self.array, self.vec.len()) } 7209df49d7eSJed Brown } 7219df49d7eSJed Brown } 7229df49d7eSJed Brown 7239df49d7eSJed Brown // Viewing 7249df49d7eSJed Brown impl<'a> fmt::Display for VectorViewMut<'a> { 7259df49d7eSJed Brown fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 7269df49d7eSJed Brown write!(f, "VectorViewMut({:?})", self.deref()) 7279df49d7eSJed Brown } 7289df49d7eSJed Brown } 7299df49d7eSJed Brown 7309df49d7eSJed Brown // ----------------------------------------------------------------------------- 731