Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#58] add functionality to vec #59

Merged
merged 1 commit into from
Dec 29, 2023
+146 −92
Merged

[#58] add functionality to vec #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/release-notes/iceoryx2-unreleased.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
### New API features

* Add `FixedSizeByteString::from_bytes_truncated` [#56](https://github.com/eclipse-iceoryx/iceoryx2/issues/56)
* Add `Deref`, `DerefMut`, `Clone`, `Eq`, `PartialEq` and `extend_from_slice` to (FixedSize)Vec [#58](https://github.com/eclipse-iceoryx/iceoryx2/issues/58)

### API Breaking Changes

Expand Down
187 changes: 97 additions & 90 deletions iceoryx2-bb/container/src/vec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@
use std::{
alloc::Layout,
mem::MaybeUninit,
ops::Deref,
ops::DerefMut,
sync::atomic::{AtomicBool, Ordering},
};

Expand Down Expand Up @@ -136,6 +138,42 @@ impl<T> RelocatableContainer for Vec<T> {
}
}

impl<T> Deref for Vec<T> {
type Target = [T];

fn deref(&self) -> &Self::Target {
self.verify_init(&format!("Vec<{}>::push()", std::any::type_name::<T>()));
unsafe { core::slice::from_raw_parts((*self.data_ptr.as_ptr()).as_ptr(), self.len) }
}
}

impl<T> DerefMut for Vec<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.verify_init(&format!("Vec<{}>::push()", std::any::type_name::<T>()));
unsafe {
core::slice::from_raw_parts_mut((*self.data_ptr.as_mut_ptr()).as_mut_ptr(), self.len)
}
}
}

impl<T: PartialEq> PartialEq for Vec<T> {
fn eq(&self, other: &Self) -> bool {
if other.len() != self.len() {
return false;
}

for i in 0..self.len() {
if other[i] != self[i] {
return false;
}
}

true
Comment on lines +165 to +171
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just as food for thought, this would be the equivalent approach with iterators

self.iter()
    .zip(other.iter())
    .try_for_each(|(lhs, rhs)| if lhs == rhs { Some(()) } else { None })
    .is_some()

}
}

impl<T: Eq> Eq for Vec<T> {}

impl<T> Vec<T> {
fn verify_init(&self, source: &str) {
if !self
Expand Down Expand Up @@ -212,6 +250,27 @@ impl<T> Vec<T> {
self.len += 1;
}

/// Append all elements from other via [`Clone`].
///
/// # Safety
///
/// * Only use this method when [`Vec::init()`] was called before
///
pub unsafe fn extend_from_slice(&mut self, other: &[T]) -> bool
where
T: Clone,
{
if self.capacity < self.len + other.len() {
return false;
}

for element in other {
self.push_unchecked(element.clone());
}

true
}

/// Removes the last element of the vector and returns it to the user. If the vector is empty
/// it returns [`None`].
///
Expand Down Expand Up @@ -249,62 +308,6 @@ impl<T> Vec<T> {

value.assume_init()
}

/// Returns a reference to the element at the specified index. If the index is out of bounds it
/// returns [`None`].
///
/// # Safety
///
/// * Only use this method when [`Vec::init()`] was called before
///
pub unsafe fn get(&self, index: usize) -> Option<&T> {
if self.len <= index {
None
} else {
self.verify_init(&format!("Vec<{}>::get()", std::any::type_name::<T>()));
Some(self.get_unchecked(index))
}
}

/// Returns a reference to the element at the specified index. The user has to ensure that the
/// index is present in the vector otherwise it leads to undefined behavior.
///
/// # Safety
///
/// * Only use this method when [`Vec::init()`] was called before
/// * The index must be not out of bounds
///
pub unsafe fn get_unchecked(&self, index: usize) -> &T {
&*(*self.data_ptr.as_ptr().add(index)).as_ptr()
}

/// Returns a mutable reference to the element at the specified index. If the index is out of
/// bounds it returns [`None`].
///
/// # Safety
///
/// * Only use this method when [`Vec::init()`] was called before
///
pub unsafe fn get_mut(&mut self, index: usize) -> Option<&mut T> {
if self.len <= index {
None
} else {
self.verify_init(&format!("Vec<{}>::get_mut()", std::any::type_name::<T>()));
Some(self.get_unchecked_mut(index))
}
}

/// Returns a mutable reference to the element at the specified index. The user has to ensure
/// that the index is present in the vector otherwise it leads to undefined behavior.
///
/// # Safety
///
/// * Only use this method when [`Vec::init()`] was called before
/// * The index must be not out of bounds
///
pub unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
&mut *(*self.data_ptr.as_mut_ptr().add(index)).as_mut_ptr()
}
}

/// Relocatable vector with compile time fixed size capacity. In contrast to its counterpart the
Expand All @@ -330,6 +333,36 @@ impl<T, const CAPACITY: usize> Default for FixedSizeVec<T, CAPACITY> {
}
}

impl<T, const CAPACITY: usize> Deref for FixedSizeVec<T, CAPACITY> {
type Target = [T];

fn deref(&self) -> &Self::Target {
self.state.deref()
}
}

impl<T, const CAPACITY: usize> DerefMut for FixedSizeVec<T, CAPACITY> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.state.deref_mut()
}
}

impl<T: PartialEq, const CAPACITY: usize> PartialEq for FixedSizeVec<T, CAPACITY> {
fn eq(&self, other: &Self) -> bool {
self.state.eq(&other.state)
}
}

impl<T: Eq, const CAPACITY: usize> Eq for FixedSizeVec<T, CAPACITY> {}

impl<T: Clone, const CAPACITY: usize> Clone for FixedSizeVec<T, CAPACITY> {
fn clone(&self) -> Self {
let mut new_self = Self::new();
new_self.extend_from_slice(self.deref());
new_self
}
}

unsafe impl<T: Send, const CAPACITY: usize> Send for FixedSizeVec<T, CAPACITY> {}
unsafe impl<T: Sync, const CAPACITY: usize> Sync for FixedSizeVec<T, CAPACITY> {}

Expand Down Expand Up @@ -373,6 +406,14 @@ impl<T, const CAPACITY: usize> FixedSizeVec<T, CAPACITY> {
unsafe { self.state.fill(value) }
}

/// Append all elements from other via [`Clone`].
pub fn extend_from_slice(&mut self, other: &[T]) -> bool
where
T: Clone,
{
unsafe { self.state.extend_from_slice(other) }
}

/// Removes the last element of the vector and returns it to the user. If the vector is empty
/// it returns [`None`].
pub fn pop(&mut self) -> Option<T> {
Expand All @@ -383,38 +424,4 @@ impl<T, const CAPACITY: usize> FixedSizeVec<T, CAPACITY> {
pub fn clear(&mut self) {
unsafe { self.state.clear() }
}

/// Returns a reference to the element at the specified index. If the index is out of bounds it
/// returns [`None`].
pub fn get(&self, index: usize) -> Option<&T> {
unsafe { self.state.get(index) }
}

/// Returns a reference to the element at the specified index. The user has to ensure that the
/// index is present in the vector otherwise it leads to undefined behavior.
///
/// # Safety
///
/// * The index must be not out of bounds
///
pub unsafe fn get_unchecked(&self, index: usize) -> &T {
unsafe { self.state.get_unchecked(index) }
}

/// Returns a mutable reference to the element at the specified index. If the index is out of
/// bounds it returns [`None`].
pub fn get_mut(&mut self, index: usize) -> Option<&mut T> {
unsafe { self.state.get_mut(index) }
}

/// Returns a mutable reference to the element at the specified index. The user has to ensure
/// that the index is present in the vector otherwise it leads to undefined behavior.
///
/// # Safety
///
/// * The index must be not out of bounds
///
pub unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
unsafe { self.state.get_unchecked_mut(index) }
}
}
50 changes: 48 additions & 2 deletions iceoryx2-bb/container/tests/vec_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ fn vec_push_pop_works_with_uninitialized_memory() {
assert_that!(sut.is_full(), eq true);

for i in 0..sut.capacity() {
assert_that!(unsafe { *sut.get(i).unwrap() }, eq i * 2 + 3);
assert_that!(unsafe { *sut.get_mut(i).unwrap() }, eq i * 2 + 3);
assert_that!(*sut.get(i).unwrap(), eq i * 2 + 3);
assert_that!(*sut.get_mut(i).unwrap(), eq i * 2 + 3);
assert_that!(unsafe { *sut.get_unchecked(i) }, eq i * 2 + 3);
assert_that!(unsafe { *sut.get_unchecked_mut(i) }, eq i * 2 + 3);
}
Expand Down Expand Up @@ -151,3 +151,49 @@ fn fixed_size_vec_valid_after_move() {
assert_that!(result, eq Some((sut2.capacity() - i - 1) * 2 + 3));
}
}

#[test]
fn fixed_size_vec_eq_works() {
let create_vec = |n| {
let mut sut = Sut::new();
for i in 0..n {
sut.push(4 * i + 3);
}
sut
};

let vec1 = create_vec(SUT_CAPACITY - 2);
let vec2 = create_vec(SUT_CAPACITY - 1);
let vec3 = create_vec(SUT_CAPACITY);

assert_that!(Sut::new() == Sut::new(), eq true);

assert_that!(vec1 == vec1, eq true);
assert_that!(vec1 == vec2, eq false);
assert_that!(vec1 == vec3, eq false);
assert_that!(vec1 == Sut::new(), eq false);

assert_that!(vec2 == vec1, eq false);
assert_that!(vec2 == vec2, eq true);
assert_that!(vec2 == vec3, eq false);
assert_that!(vec2 == Sut::new(), eq false);

assert_that!(vec3 == vec1, eq false);
assert_that!(vec3 == vec2, eq false);
assert_that!(vec3 == vec3, eq true);
assert_that!(vec3 == Sut::new(), eq false);
}

#[test]
fn fixed_size_vec_clone_works() {
let mut sut = Sut::new();
let sut1 = sut.clone();
for i in 0..SUT_CAPACITY {
sut.push(8 * i + 6);
}

let sut2 = sut.clone();

assert_that!(Sut::new() == sut1, eq true);
assert_that!(sut == sut2, eq true);
}
Loading