-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
302 additions
and
310 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| //! Common RLST data structures | ||
| #![cfg_attr(feature = "strict", deny(warnings))] | ||
|
|
||
| pub mod tools; | ||
| pub mod traits; | ||
| pub mod types; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,143 +1 @@ | ||
| //! Traits for access to matrix data. | ||
| //! | ||
| //! Each random access trait has a two-dimensional and a one-dimensional access method, | ||
| //! namely `get` and `get1d` (together with their mutable and unsafe variants). | ||
| //! The two-dimensional access takes a row and a column and returns the corresponding | ||
| //! matrix element. The one-dimensional access takes a single `index` parameter that | ||
| //! iterates through the matrix elements. | ||
| //! | ||
| //! If the [`crate::traits::properties::Shape`] and [`crate::traits::properties::NumberOfElements`] | ||
| //! traits are implemented on top of [`UnsafeRandomAccessByValue`], [`UnsafeRandomAccessByRef`] | ||
| //! and [`UnsafeRandomAccessMut`] then the | ||
| //! corresponding bounds-checked traits [`RandomAccessByValue`], [`RandomAccessByRef`] and | ||
| //! [`RandomAccessMut`] are auto-implemented. | ||
| //! | ||
| //! To get raw access to the underlying data use the [`RawAccess`] and [`RawAccessMut`] traits. | ||
|
|
||
| use crate::traits::properties::Shape; | ||
| use crate::types::{DataChunk, Scalar}; | ||
|
|
||
| /// This trait provides unsafe access by value to the underlying data. | ||
| pub trait UnsafeRandomAccessByValue<const NDIM: usize> { | ||
| type Item: Scalar; | ||
|
|
||
| /// Return the element at position determined by `multi_index`. | ||
| /// | ||
| /// # Safety | ||
| /// `multi_index` must not be out of bounds. | ||
| unsafe fn get_value_unchecked(&self, multi_index: [usize; NDIM]) -> Self::Item; | ||
| } | ||
|
|
||
| /// This trait provides unsafe access by reference to the underlying data. | ||
| pub trait UnsafeRandomAccessByRef<const NDIM: usize> { | ||
| type Item: Scalar; | ||
|
|
||
| /// Return a mutable reference to the element at position determined by `multi_index`. | ||
| /// | ||
| /// # Safety | ||
| /// `multi_index` must not be out of bounds. | ||
| unsafe fn get_unchecked(&self, multi_index: [usize; NDIM]) -> &Self::Item; | ||
| } | ||
|
|
||
| /// This trait provides unsafe mutable access to the underlying data. | ||
| pub trait UnsafeRandomAccessMut<const NDIM: usize> { | ||
| type Item: Scalar; | ||
|
|
||
| /// Return a mutable reference to the element at position determined by `multi_index`. | ||
| /// | ||
| /// # Safety | ||
| /// `multi_index` must not be out of bounds. | ||
| unsafe fn get_unchecked_mut(&mut self, multi_index: [usize; NDIM]) -> &mut Self::Item; | ||
| } | ||
|
|
||
| /// This trait provides bounds checked access to the underlying data by value. | ||
| pub trait RandomAccessByValue<const NDIM: usize>: UnsafeRandomAccessByValue<NDIM> { | ||
| /// Return the element at position determined by `multi_index`. | ||
| fn get_value(&self, multi_index: [usize; NDIM]) -> Option<Self::Item>; | ||
| } | ||
|
|
||
| /// This trait provides bounds checked access to the underlying data by reference. | ||
| pub trait RandomAccessByRef<const NDIM: usize>: UnsafeRandomAccessByRef<NDIM> { | ||
| /// Return a reference to the element at position determined by `multi_index`. | ||
| fn get(&self, multi_index: [usize; NDIM]) -> Option<&Self::Item>; | ||
| } | ||
|
|
||
| /// This trait provides bounds checked mutable access to the underlying data. | ||
| pub trait RandomAccessMut<const NDIM: usize>: UnsafeRandomAccessMut<NDIM> { | ||
| /// Return a mutable reference to the element at position determined by `multi_index`. | ||
| fn get_mut(&mut self, multi_index: [usize; NDIM]) -> Option<&mut Self::Item>; | ||
| } | ||
|
|
||
| /// Return chunks of data of size N; | ||
| pub trait ChunkedAccess<const N: usize> { | ||
| type Item: Scalar; | ||
| fn get_chunk(&self, chunk_index: usize) -> Option<DataChunk<Self::Item, N>>; | ||
| } | ||
|
|
||
| /// Get raw access to the underlying data. | ||
| pub trait RawAccess { | ||
| type Item: Scalar; | ||
|
|
||
| /// Get a slice of the whole data. | ||
| fn data(&self) -> &[Self::Item]; | ||
| } | ||
|
|
||
| /// Get mutable raw access to the underlying data. | ||
| pub trait RawAccessMut: RawAccess { | ||
| /// Get a mutable slice of the whole data. | ||
| fn data_mut(&mut self) -> &mut [Self::Item]; | ||
| } | ||
|
|
||
| /// Check if `multi_index` not out of bounds with respect to `shape`. | ||
| #[inline] | ||
| fn check_dimension<const NDIM: usize>(multi_index: [usize; NDIM], shape: [usize; NDIM]) -> bool { | ||
| multi_index | ||
| .iter() | ||
| .zip(shape.iter()) | ||
| .fold(true, |acc, (ind, s)| acc && (ind < s)) | ||
| } | ||
|
|
||
| impl< | ||
| Item: Scalar, | ||
| Mat: UnsafeRandomAccessByValue<NDIM, Item = Item> + Shape<NDIM>, | ||
| const NDIM: usize, | ||
| > RandomAccessByValue<NDIM> for Mat | ||
| { | ||
| fn get_value(&self, multi_index: [usize; NDIM]) -> Option<Self::Item> { | ||
| if check_dimension(multi_index, self.shape()) { | ||
| Some(unsafe { self.get_value_unchecked(multi_index) }) | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl< | ||
| Item: Scalar, | ||
| Mat: UnsafeRandomAccessMut<NDIM, Item = Item> + Shape<NDIM>, | ||
| const NDIM: usize, | ||
| > RandomAccessMut<NDIM> for Mat | ||
| { | ||
| fn get_mut(&mut self, multi_index: [usize; NDIM]) -> Option<&mut Self::Item> { | ||
| if check_dimension(multi_index, self.shape()) { | ||
| unsafe { Some(self.get_unchecked_mut(multi_index)) } | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl< | ||
| Item: Scalar, | ||
| Mat: UnsafeRandomAccessByRef<NDIM, Item = Item> + Shape<NDIM>, | ||
| const NDIM: usize, | ||
| > RandomAccessByRef<NDIM> for Mat | ||
| { | ||
| fn get(&self, multi_index: [usize; NDIM]) -> Option<&Self::Item> { | ||
| if check_dimension(multi_index, self.shape()) { | ||
| unsafe { Some(self.get_unchecked(multi_index)) } | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1 @@ | ||
| //! Traits describing properties of objects. | ||
|
|
||
| /// Return the shape of the object. | ||
| pub trait Shape<const NDIM: usize> { | ||
| fn shape(&self) -> [usize; NDIM]; | ||
|
|
||
| /// Return true if a dimension is 0. | ||
| fn is_empty(&self) -> bool { | ||
| let shape = self.shape(); | ||
| for elem in shape { | ||
| if elem == 0 { | ||
| return true; | ||
| } | ||
| } | ||
| false | ||
| } | ||
| } | ||
|
|
||
| /// Return the stride of the object. | ||
| pub trait Stride<const NDIM: usize> { | ||
| fn stride(&self) -> [usize; NDIM]; | ||
| } | ||
|
|
||
| /// Return the number of elements. | ||
| pub trait NumberOfElements { | ||
| fn number_of_elements(&self) -> usize; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.