Struct Linear

pub struct Linear { /* private fields */ }

Strategy which allows the split vector to grow linearly.

In other words, each new fragment will have equal capacity, which is equal to the capacity of the first fragment.

Examples

use orx_split_vec::*;

// SplitVec<usize, Linear>
let mut vec = SplitVec::with_linear_growth(4);

assert_eq!(1, vec.fragments().len());
assert_eq!(Some(16), vec.fragments().first().map(|f| f.capacity()));
assert_eq!(Some(0), vec.fragments().first().map(|f| f.len()));

// push 160 elements
for i in 0..10 * 16 {
    vec.push(i);
}

assert_eq!(10, vec.fragments().len());
for fragment in vec.fragments() {
    assert_eq!(16, fragment.len());
    assert_eq!(16, fragment.capacity());
}

// push the 161-st element
vec.push(42);
assert_eq!(11, vec.fragments().len());
assert_eq!(Some(16), vec.fragments().last().map(|f| f.capacity()));
assert_eq!(Some(1), vec.fragments().last().map(|f| f.len()));

Implementations

impl Linear

pub fn new(constant_fragment_capacity_exponent: usize) -> Self

Creates a linear growth where each fragment will have a capacity of 2 ^ constant_fragment_capacity_exponent.

Panics

Panics if constant_fragment_capacity_exponent is zero or constant_fragment_capacity_exponent >= MAX_EXPONENT where MAX_EXPONENT is:

• 29 in 32-bit targets,
• 32 in 64-bit.

Trait Implementations

impl Clone for Linear

fn clone(&self) -> Linear

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Linear

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Growth for Linear

fn get_ptr<T>( &self, fragments: &[Fragment<T>], index: usize, ) -> Option<*const T>

O(1) Returns a pointer to the index-th element of the split vector of the fragments.

Returns None if index-th position does not belong to the split vector; i.e., if index is out of cumulative capacity of fragments.

Safety

This method allows to write to a memory which is greater than the split vector’s length. On the other hand, it will never return a pointer to a memory location that the vector does not own.

fn get_ptr_mut<T>( &self, fragments: &mut [Fragment<T>], index: usize, ) -> Option<*mut T>

O(1) Returns a mutable reference to the index-th element of the split vector of the fragments.

Returns None if index-th position does not belong to the split vector; i.e., if index is out of cumulative capacity of fragments.

Safety

This method allows to write to a memory which is greater than the split vector’s length. On the other hand, it will never return a pointer to a memory location that the vector does not own.

fn get_ptr_mut_and_indices<T>( &self, fragments: &mut [Fragment<T>], index: usize, ) -> Option<(*mut T, usize, usize)>

O(1) Returns a mutable reference to the index-th element of the split vector of the fragments together with the index of the fragment that the element belongs to and index of the element withing the respective fragment.

Returns None if index-th position does not belong to the split vector; i.e., if index is out of cumulative capacity of fragments.

Safety

This method allows to write to a memory which is greater than the split vector’s length. On the other hand, it will never return a pointer to a memory location that the vector does not own.

fn new_fragment_capacity_from( &self, _fragment_capacities: impl ExactSizeIterator<Item = usize>, ) -> usize

Given that the split vector contains fragments with the given fragment_capacities, returns the capacity of the next fragment.

fn get_fragment_and_inner_indices<T>( &self, vec_len: usize, _fragments: &[Fragment<T>], element_index: usize, ) -> Option<(usize, usize)>

O(fragments.len()) Returns the location of the element with the given element_index on the split vector as a tuple of (fragment-index, index-within-fragment).

fn maximum_concurrent_capacity<T>( &self, fragments: &[Fragment<T>], fragments_capacity: usize, ) -> usize

Returns the maximum number of elements that can safely be stored in a concurrent program.

fn required_fragments_len<T>( &self, _: &[Fragment<T>], maximum_capacity: usize, ) -> Result<usize, String>

Returns the number of fragments with this growth strategy in order to be able to reach a capacity of maximum_capacity of elements. Returns the error if it the growth strategy does not allow the required number of fragments.

fn maximum_concurrent_capacity_bound<T>( &self, _: &[Fragment<T>], _: usize, ) -> usize

Returns the maximum possible bound on concurrent capacity.

fn first_fragment_capacity(&self) -> usize

Given that the split vector has no fragments yet, returns the capacity of the first fragment.

fn new_fragment_capacity<T>(&self, fragments: &[Fragment<T>]) -> usize

Given that the split vector contains the given fragments, returns the capacity of the next fragment.

fn get_ptr_and_indices<T>( &self, fragments: &[Fragment<T>], index: usize, ) -> Option<(*const T, usize, usize)>

O(fragments.len()) Returns a mutable reference to the index-th element of the split vector of the fragments together with the index of the fragment that the element belongs to and index of the element withing the respective fragment.

impl GrowthWithConstantTimeAccess for Linear

fn get_fragment_and_inner_indices_unchecked( &self, element_index: usize, ) -> (usize, usize)

O(1) Returns the location of the element with the given element_index on the split vector as a tuple of (fragment-index, index-within-fragment).

fn fragment_capacity_of(&self, _: usize) -> usize

O(1) Returns the capacity of the fragment with the given fragment_index.

fn get_ptr<T>( &self, fragments: &[Fragment<T>], index: usize, ) -> Option<*const T>

O(1) Returns a pointer to the index-th element of the split vector of the fragments.

fn get_ptr_mut<T>( &self, fragments: &mut [Fragment<T>], index: usize, ) -> Option<*mut T>

O(1) Returns a mutable reference to the index-th element of the split vector of the fragments.

fn get_ptr_mut_and_indices<T>( &self, fragments: &mut [Fragment<T>], index: usize, ) -> Option<(*mut T, usize, usize)>

O(1) Returns a mutable reference to the index-th element of the split vector of the fragments together with the index of the fragment that the element belongs to and index of the element withing the respective fragment.

impl JaggedIndexer for Linear

unsafe fn jagged_index_unchecked<'a, T: 'a>( &self, _: &impl Slices<'a, T>, flat_index: usize, ) -> JaggedIndex

Returns the jagged index of the element flat_index-th position if the raw jagged array defined by the arrays collection would have been flattened.

unsafe fn jagged_index_unchecked_from_slice<'a, T: 'a>( &self, _: &[impl AsRawSlice<T>], flat_index: usize, ) -> JaggedIndex

Returns the jagged index of the element flat_index-th position if the raw jagged array defined by the arrays collection would have been flattened.

impl PartialEq for Linear

fn eq(&self, other: &Linear) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PseudoDefault for Linear

fn pseudo_default() -> Self

PseudoDefault trait allows to create a cheap default instance of a type, which does not claim to be useful.

impl StructuralPartialEq for Linear