Expand description
Binary einsum contractions on strided views.
Modules§
- backend
- Backend abstraction for batched GEMM dispatch. Backend abstraction for batched GEMM dispatch.
- bgemm_
faer - Batched GEMM backend using the [
faer] library. faer-backed batched GEMM kernel on strided views. - bgemm_
naive - Batched GEMM fallback using explicit loops. Naive batched GEMM kernel on strided views.
- contiguous
- GEMM-ready operand types and preparation functions for contiguous data. GEMM-ready operand types and preparation functions for contiguous data.
- dot_
general - Axis-based general dot product API. Axis-based general dot product API.
- plan
- Contraction planning: axis classification and permutation computation. Einsum2 plan: axis classification and permutation computation.
- raw_
bgemm - Raw borrowed-layout batched GEMM entry points. Raw borrowed-layout batched GEMM entry points.
- trace
- Trace-axis reduction (summing axes that appear only in one operand). Trace-axis reduction for einsum operands.
- util
- Shared helpers (permutation inversion, multi-index iteration, dimension fusion). Shared helpers for strided-einsum2.
Structs§
- DotGeneral
Config - DotGeneral dimension configuration.
- Einsum2
Plan - Pre-computed execution plan for a binary einsum contraction.
- RawStrided
Mut - Borrowed raw strided output layout.
- RawStrided
Ref - Borrowed raw strided input layout.
- Strided
View - Dynamic-rank immutable strided view with lazy element operations.
- Strided
View Mut - Dynamic-rank mutable strided view.
Enums§
- Einsum
Error - Errors specific to einsum operations.
Traits§
- AxisId
- Trait alias for axis label types.
- Backend
- Trait for backends that can execute batched GEMM on contiguous operands.
- Scalar
- Trait alias for element types supported by the faer active backend.
- Scalar
Base - Shared trait bounds for all element types usable with einsum, independent of GEMM backend.
Functions§
- bgemm_
raw_ strided_ into - Batched strided GEMM on raw borrowed layout metadata using the active backend.
- bgemm_
raw_ ⚠strided_ into_ unchecked - Batched strided GEMM on raw borrowed layout metadata without validation.
- bgemm_
raw_ with_ backend_ into - Batched strided GEMM on raw borrowed metadata using an explicit backend.
- bgemm_
raw_ ⚠with_ backend_ into_ unchecked - Unchecked variant of
bgemm_raw_with_backend_into. - col_
major_ strides - Compute column-major strides (Julia default: first index varies fastest).
- dot_
general_ into - Compute
C = alpha * dot_general(A, B) + beta * Cwith the active backend. - dot_
general_ with_ backend_ into - Compute
C = alpha * dot_general(A, B) + beta * Cwith an explicit backend. - einsum2_
into - Binary einsum contraction:
C = alpha * contract(A, B) + beta * C. - einsum2_
into_ owned - Binary einsum accepting owned inputs for zero-copy optimization.
- einsum2_
naive_ into - Binary einsum for custom scalar types using naive GEMM.
- einsum2_
with_ backend_ into - Binary einsum with a pluggable GEMM backend.
Type Aliases§
- Result
- Convenience alias for
Result<T, EinsumError>.