Skip to main content

DotGeneralConfig

Struct DotGeneralConfig 

Source
pub struct DotGeneralConfig {
    pub lhs_contracting_dims: SmallVec<[usize; 4]>,
    pub rhs_contracting_dims: SmallVec<[usize; 4]>,
    pub lhs_batch_dims: SmallVec<[usize; 4]>,
    pub rhs_batch_dims: SmallVec<[usize; 4]>,
}
Expand description

DotGeneral dimension configuration.

Each axis list stores up to four axes inline and spills to the heap for larger contractions; this is not a tensor-rank limit. Records only the dim-numbering roles (contracting / batch; free is derived). Rank info travels with the enclosing StdTensorOp::DotGeneral variant at the trace/StdTensorOp layer, and with ExecInstruction::output_shapes at the exec layer. This separation makes it structurally impossible for stored ranks to drift from actual tensor ranks (issue #664).

§Output layout

The output shape is [lhs_free..., rhs_free..., batch...] (col-major batch-trailing convention): batch axes come last, unlike PyTorch’s batch-leading bmm. Batch dims have the largest stride so that each batch slice occupies a contiguous block of memory. Free axes keep their input order. For attention scores, q[d, lq, b] against k[d, lk, b] with d contracted and b batched gives [lq, lk, b]; see the “Contraction Output Layout” section of the tensor-operations guide for a worked example. Transpose afterwards only where a consumer needs batch first.

§Examples

use tenferro_tensor::DotGeneralConfig;

let config = DotGeneralConfig {
    lhs_contracting_dims: [1].as_slice().into(),
    rhs_contracting_dims: [0].as_slice().into(),
    lhs_batch_dims: [].as_slice().into(),
    rhs_batch_dims: [].as_slice().into(),
};

Fields§

§lhs_contracting_dims: SmallVec<[usize; 4]>§rhs_contracting_dims: SmallVec<[usize; 4]>§lhs_batch_dims: SmallVec<[usize; 4]>§rhs_batch_dims: SmallVec<[usize; 4]>

Implementations§

Source§

impl DotGeneralConfig

Source

pub fn validate_dims_with_ranks( &self, lhs_rank: usize, rhs_rank: usize, ) -> Result<()>

Validate that all dimension indices are within range for the given explicit ranks and that no axis appears in multiple roles.

Call sites supply the actual operand ranks (from the tensor shapes they have in hand). The config itself carries only the dim-numbering roles.

§Examples
use tenferro_tensor::DotGeneralConfig;

let config = DotGeneralConfig {
    lhs_contracting_dims: [1].as_slice().into(),
    rhs_contracting_dims: [0].as_slice().into(),
    lhs_batch_dims: [].as_slice().into(),
    rhs_batch_dims: [].as_slice().into(),
};
config.validate_dims_with_ranks(2, 2).unwrap();
§Errors

Returns crate::Error::Validation with an axis, duplicate-axis, or configuration source when the dimension roles are invalid.

Trait Implementations§

Source§

impl Clone for DotGeneralConfig

Source§

fn clone(&self) -> DotGeneralConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DotGeneralConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DotGeneralConfig

Source§

impl Hash for DotGeneralConfig

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DotGeneralConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DotGeneralConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.