Expand description
Cache-optimized kernels for strided multidimensional array operations.
This crate is a Rust port of Julia’s Strided.jl and StridedViews.jl libraries, providing efficient operations on strided multidimensional array views.
§Core Types
StridedView/StridedViewMut: Dynamic-rank strided views over existing dataStridedArray: Owned strided multidimensional arrayElementOptrait and implementations (Identity,Conj,Transpose,Adjoint): Type-level element operations applied lazily on accessExecutionPolicy/with_execution_policy: optional bounds on strided-owned CPU fanout without creating a Rayon pool
§Primary API (view-based, Julia-compatible)
§Map Operations
map_into: Apply a function element-wise from source to destinationzip_map2_into,zip_map3_into,zip_map4_into: Multi-array element-wise operations
§Reduce Operations
reduce: Full reduction with map functionreduce_axis: Reduce along a single axis
§Basic Operations
copy_into: Copy array contentsadd,mul: Element-wise arithmeticaxpy: y = alpha*x + y (array version)sum,dot: Reductionssymmetrize_into,symmetrize_conj_into: Matrix symmetrization
§Example
use strided_kernel::{StridedView, StridedViewMut, StridedArray, Identity, map_into};
// Create a column-major array (Julia default)
let src = StridedArray::<f64>::from_fn_col_major(&[2, 3], |idx| {
(idx[0] * 10 + idx[1]) as f64
});
let mut dest = StridedArray::<f64>::col_major(&[2, 3]);
// Map with view-based API
map_into(&mut dest.view_mut(), &src.view(), |x| x * 2.0).unwrap();
assert_eq!(dest.get(&[1, 2]), 24.0); // (1*10 + 2) * 2§Cache Optimization
The library uses Julia’s blocking strategy for cache efficiency:
- Dimensions are sorted by stride magnitude for optimal memory access
- Operations are blocked into tiles fitting L1 cache (
BLOCK_MEMORY_SIZE= 32KB) - Contiguous arrays use fast paths bypassing the blocking machinery
Modules§
- view
- Julia-like dynamic-rank strided view types.
Structs§
- Adjoint
- Adjoint operation: f(x) = adjoint(x) = conj(transpose(x)) For scalar numbers, this is conj.
- Concatenate
Plan - A compiled multi-input concatenate traversal.
- Conj
- Complex conjugate operation: f(x) = conj(x)
- Copy
Plan - A compiled copy traversal for one
(dims, dst_strides, src_strides)layout pair. - Dynamic
Slice Plan - A compiled fixed-window dynamic-slice traversal.
- Dynamic
Update Slice Plan - A compiled dynamic-update-slice traversal.
- Erased
Concatenate Plan - Dtype-erased concatenate wrapper.
- Erased
Copy Plan - Dtype-erased wrapper around
CopyPlan. - Erased
Dynamic Slice Plan - Dtype-erased fixed-window dynamic-slice wrapper.
- Erased
Dynamic Update Slice Plan - Dtype-erased dynamic-update-slice wrapper.
- Erased
Fused Plan - Dtype-erased single-output wrapper around
FusedPlan. - Erased
Gather Plan - Dtype-erased gather wrapper.
- Erased
PadPlan - Dtype-erased pad wrapper.
- Erased
RawStrided Mut - Borrowed dtype-erased raw strided output layout.
- Erased
RawStrided Ptr - Pointer-backed dtype-erased input used by one-shot write entry points.
- Erased
RawStrided Ref - Borrowed dtype-erased raw strided input layout.
- Erased
RawStrided Uninit Mut - Borrowed dtype-erased raw strided output whose reachable elements may be uninitialized.
- Erased
Reduce Plan - Dtype-erased reduction wrapper.
- Erased
Reverse Plan - Dtype-erased reverse wrapper.
- Erased
Scatter Plan - Dtype-erased additive scatter wrapper.
- Erased
Slice Plan - Dtype-erased static-slice wrapper.
- Exec
Context - Caller-selected execution policy for prepared kernel replay.
- Fused
Inst - One SSA instruction in a
FusedPlan. - Fused
Plan - Topologically ordered fused elementwise SSA DAG.
- Gather
Plan - A compiled gather traversal for one value layout, index layout, and output layout.
- Gather
Spec - Gather configuration shared by generic and erased replay.
- Identity
- Identity operation: f(x) = x
- PadPlan
- A compiled pad traversal.
- RawStrided
Mut - Borrowed raw strided output layout.
- RawStrided
Ref - Borrowed raw strided input layout.
- Reverse
Plan - A compiled reverse traversal over selected axes.
- Scatter
Plan - A compiled additive scatter traversal.
- Scatter
Spec - Scatter configuration shared by generic and erased replay.
- Slice
Plan - A compiled static-slice traversal.
- Strided
Array - Owned strided multidimensional array.
- Strided
View - Dynamic-rank immutable strided view with lazy element operations.
- Strided
View Mut - Dynamic-rank mutable strided view.
- Transpose
- Transpose operation: f(x) = transpose(x) For scalar numbers, this is identity. For matrix elements, this would transpose each element.
Enums§
- Compare
Op - Runtime comparison selected once before entering the element loop.
- Erased
MapOp - Runtime unary operation for
erased_map_into. - Erased
ZipOp - Runtime binary operation for
erased_zip_into. - Execution
Policy - Controls how a strided operation may use CPU threads.
- FusedOp
- Runtime scalar operation for a fused elementwise plan.
- KernelD
Type - Dtypes supported by dtype-erased kernel entry points.
- Reduce
Op - Runtime reduction operation for dtype-erased full reductions.
- Strided
Error - Errors that can occur during strided array operations.
Constants§
- BLOCK_
MEMORY_ SIZE - Block memory size for cache-optimized iteration (L1 cache target).
- CACHE_
LINE_ SIZE - Cache line size in bytes.
- RAW_
FUSED_ RANK_ LIMIT - Maximum rank fused on the stack before falling back to the view kernels.
Traits§
- Composable
Element Op - Trait for element operations that support type-level composition.
- Compose
- Helper trait for composing two ElementOp types.
- Element
Op - Trait for element-wise operations applied to strided views.
- Element
OpApply - Trait for types that support element operations (conj, transpose, adjoint).
- Fused
Scalar - Scalar types supported by
fused_elementwise_into. - Gather
Index - Index scalar types accepted by
GatherPlan. - Kernel
Storage Element - A scalar type that can safely witness storage for an erased kernel view.
- Maybe
Send - Equivalent to
Sendwhenparallelis enabled; blanket-impl otherwise. - Maybe
Send Sync - Equivalent to
Send+Syncwhenparallelis enabled; blanket-impl otherwise. - Maybe
Simd Ops - Trait for types that may have SIMD-accelerated sum/dot operations.
- Maybe
Sync - Equivalent to
Syncwhenparallelis enabled; blanket-impl otherwise.
Functions§
- add
- Element-wise addition:
dest[i] += src[i]. - axpy
- AXPY:
dest[i] = alpha * src[i] + dest[i]. - axpy_
conj_ raw dest = alpha * conj(src) + destover borrowed raw strided layouts.- axpy_
raw dest = alpha * src + destover borrowed raw strided layouts.- batched_
outer_ product_ into - Compute
dest[lhs_free..., rhs_free..., batch...] = lhs[lhs_free..., batch...] * rhs[rhs_free..., batch...]. - batched_
outer_ product_ into_ uninit - Compute a batched outer product into a fully overwritten uninitialized output.
- broadcast_
mul_ into - Broadcasted element-wise multiplication:
dest[i] = a[i] * b[i]. - broadcast_
mul_ into_ uninit - Broadcast and multiply into a fully overwritten uninitialized output.
- col_
major_ strides - Compute column-major strides (Julia default: first index varies fastest).
- compare_
into - Compare two ordered views elementwise into a Boolean destination.
- compare_
into_ uninit - Compare two views into a fully overwritten uninitialized Boolean output.
- copy_
conj - Copy with complex conjugation:
dest[i] = conj(src[i]). - copy_
into - Copy elements from source to destination:
dest[i] = src[i]. - copy_
into_ col_ major - Copy elements from
srctodst, optimized for col-major destination. - copy_
scale - Copy with scaling:
dest[i] = scale * src[i]. - copy_
scale_ conj_ raw dest = scale * conj(src)over borrowed raw strided layouts.- copy_
scale_ raw dest = scale * srcover borrowed raw strided layouts.- copy_
transpose_ scale_ into - Copy with transpose and scaling:
dest[j,i] = scale * src[i,j]. - dot
- Dot product:
sum(OpA::apply(a[i]) * OpB::apply(b[i])). - erased_
map_ into - Apply one runtime-selected unary operation without compiling a plan.
- erased_
zip_ into - Apply one runtime-selected binary operation without compiling a plan.
- fma
- Fused multiply-add:
dest[i] += OpA::apply(a[i]) * OpB::apply(b[i]). - fused_
elementwise_ into - Evaluate a runtime-DAG elementwise plan into one or more destinations.
- map_
into - Apply a function element-wise from source to destination.
- mul
- Element-wise multiplication:
dest[i] *= src[i]. - mul_
into - Element-wise multiplication:
dest[i] = a[i] * b[i]. - mul_
into_ uninit - Multiply two views into a fully overwritten uninitialized output.
- reduce
- Full reduction with map function:
reduce(init, op, map.(src)). - reduce_
axis - Reduce along a single axis, returning a new StridedArray.
- row_
major_ strides - Compute row-major strides (C default: last index varies fastest).
- sum
- Sum all elements:
sum(src). - symmetrize_
conj_ into - Conjugate-symmetrize a square matrix:
dest = (src + conj(src^T)) / 2. - symmetrize_
into - Symmetrize a square matrix:
dest = (src + src^T) / 2. - with_
execution_ policy - Execute
operationunder an explicit strided-kernel execution policy. - zip_
map2_ into - Binary element-wise operation:
dest[i] = f(a[i], b[i]). - zip_
map3_ into - Ternary element-wise operation:
dest[i] = f(a[i], b[i], c[i]). - zip_
map4_ into - Quaternary element-wise operation:
dest[i] = f(a[i], b[i], c[i], e[i]).
Type Aliases§
- Result
- Result type for strided array operations.