Struct StringArray

Source

pub struct StringArray<D: Dimension> { /* private fields */ }

Expand description

A specialized N-dimensional array of strings.

Unlike ferray_core::Array, this type does not require Element — it stores Vec<String> directly with shape metadata for indexing.

The data is stored in row-major (C) order.

Implementations§

Source §

impl<D: Dimension> StringArray<D>

Source

pub fn from_vec(dim: D, data: Vec<String>) -> FerrayResult<Self>

Create a new StringArray from a flat vector of strings and a shape.

§Errors

Returns FerrayError::ShapeMismatch if data.len() does not equal the product of the shape dimensions.

Source

pub fn empty(dim: D) -> FerrayResult<Self>

Create a StringArray filled with empty strings.

§Errors

This function is infallible for valid shapes but returns Result for API consistency.

Source

pub fn shape(&self) -> &[usize]

Return the shape as a slice.

Source

pub fn ndim(&self) -> usize

Return the number of dimensions.

Source

pub fn len(&self) -> usize

Return the total number of elements.

Source

pub fn is_empty(&self) -> bool

Return true if the array has no elements.

Source

pub const fn dim(&self) -> &D

Return a reference to the dimension descriptor.

Source

pub fn as_slice(&self) -> &[String]

Return a reference to the flat data.

Source

pub fn as_slice_mut(&mut self) -> &mut [String]

Return a mutable reference to the flat data.

Source

pub fn into_vec(self) -> Vec<String>

Consume self and return the underlying Vec<String>.

Source

pub fn map<F>(&self, f: F) -> FerrayResult<Self>
where F: Fn(&str) -> String,

Apply a function to each element, producing a new StringArray.

Source

pub fn map_to_vec<T, F>(&self, f: F) -> Vec<T>
where F: Fn(&str) -> T,

Apply a function to each element, producing a Vec<T>.

This is a lower-level helper used by search and boolean operations that need to produce typed arrays (e.g., Array<bool, D>).

Source

pub fn iter(&self) -> Iter<'_, String>

Iterate over all elements.

Source

pub fn reshape<D2: Dimension>( self, new_dim: D2, ) -> FerrayResult<StringArray<D2>>

Reshape this array to a new dimension type / shape. The total element count must be unchanged.

Since strings are cheap to move (they’re owned), reshape just rebuilds the array around the existing buffer. No data copy.

§Errors

Returns FerrayError::ShapeMismatch if the new shape’s element count does not match self.len().

Source

pub fn flatten(self) -> StringArray1

Flatten to a 1-D StringArray1 of length self.len(). The row-major traversal order is preserved.

This is the string analogue of ndarray::Array::flatten / NumPy’s arr.flatten().

Source

pub fn into_dyn(self) -> StringArray<IxDyn>

Convert to a dynamic-rank StringArray<IxDyn>. Useful when the rank isn’t known until runtime, or when interoperating with code that only accepts IxDyn.

Source

pub fn get(&self, idx: &[usize]) -> Option<&String>

Look up an element by multi-dimensional index. Returns None if the index is out of bounds.

Indexing is row-major (C-order): for a (rows, cols) array, index [r, c] maps to data[r * cols + c].

Source

pub fn at(&self, idx: usize) -> Option<&String>

Index by flat (row-major) offset (#519).

Equivalent to arr.iter().nth(idx) but O(1) — returns None when idx >= len(). Useful when the caller already has a linearised position.

Source

pub fn slice_axis( &self, axis: usize, range: Range<usize>, ) -> FerrayResult<StringArray<IxDyn>>

Take a contiguous range along axis and return a new StringArray<IxDyn> (#519).

axis must be a valid axis for this array; range is a half-open [start, end) window into that axis. The other axes are preserved at their full size.

§Errors

FerrayError::AxisOutOfBounds if axis >= ndim. FerrayError::InvalidValue if range exceeds the axis length or is empty in a way that produces a zero-sized non-existent shape.

Source

pub fn get_row(&self, idx: usize) -> FerrayResult<StringArray1>

Extract row idx from a 2-D StringArray as a 1-D StringArray (#519).

§Errors

FerrayError::ShapeMismatch if self is not 2-D, or FerrayError::IndexOutOfBounds if idx exceeds the row count.

Source §

impl StringArray<Ix1>

Source

pub fn from_slice(items: &[&str]) -> FerrayResult<Self>

Create a 1-D StringArray from a slice of string-like values.

§Examples

let a = StringArray1::from_slice(&["hello", "world"]).unwrap();

Source §

impl StringArray<Ix2>

Source

pub fn transpose(&self) -> FerrayResult<Self>

Transpose a 2-D StringArray: swap rows and columns.

Walks the elements into a new buffer — a (r, c) cell of the input becomes (c, r) of the output. Strings are cloned to avoid disturbing the original array.

Source