Enum BitWidth

pub enum BitWidth {
    Minimal,
    PowerOfTwo,
    Explicit(usize),
}

Specifies the strategy for determining the number of bits for each integer.

This enum controls how the bit width of a FixedVec is determined during its construction. The choice of strategy involves a trade-off between memory usage and random access performance.

Performance Considerations

• Minimal vs. PowerOfTwo: While Minimal provides the most compact storage, PowerOfTwo can offer better performance for certain operations. When the bit_width is a power of two (e.g., 8, 16, 32) and aligns with word boundaries, some in-place operations like map_in_place can use a faster, word-at-a-time algorithm.

• Explicit: This is the fastest strategy at construction time, as it avoids the need to iterate through the input data to find the maximum value. Use this when the required bit width is known in advance.

Variants

Minimal

Use the minimum number of bits required to store the largest value.

This strategy analyzes the input data to find the maximum value and sets the bit width accordingly. It ensures the most compact memory representation.

PowerOfTwo

Round the bit width up to the next power of two (e.g., 8, 16, 32).

This strategy can improve random access performance for some in-place operations, as they can be implemented more efficiently with bit-shift operations on aligned data.

Explicit(usize)

Use a specific number of bits.

This strategy enforces a user-defined bit width. If any value in the input data exceeds what can be stored in this many bits, the build process will fail.

Trait Implementations

impl Clone for BitWidth

fn clone(&self) -> BitWidth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitWidth

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

Formats the value using the given formatter.

impl Default for BitWidth

fn default() -> BitWidth

Returns the “default value” for a type.

impl PartialEq for BitWidth

fn eq(&self, other: &BitWidth) -> 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 Copy for BitWidth

impl Eq for BitWidth

impl StructuralPartialEq for BitWidth