Struct ndarray_einsum_beta::contractors::pair_contractors::TensordotGeneral

pub struct TensordotGeneral {
    lhs_permutation: Permutation,
    rhs_permutation: Permutation,
    tensordot_fixed_position: TensordotFixedPosition,
    output_permutation: Permutation,
}

Computes the tensor dot product of two tensors, with individual permutations of the LHS and RHS performed as necessary, as well as a final permutation of the output.

Examples that qualify for TensordotGeneral but not TensordotFixedPosition:

1. jik,jkl->il LHS tensor needs to be permuted jik->ijk
2. ijk,klm->imlj Output tensor needs to be permuted ijlm->imlj

Fields

lhs_permutation: Permutation

rhs_permutation: Permutation

tensordot_fixed_position: TensordotFixedPosition

output_permutation: Permutation

Implementations

impl TensordotGeneral

pub fn new(sc: &SizedContraction) -> Self

fn from_shapes_and_indices(
    lhs_shape: &[usize],
    rhs_shape: &[usize],
    lhs_indices: &[char],
    rhs_indices: &[char],
    contracted_indices: &[char],
    output_indices: &[char]
) -> Self

pub fn from_shapes_and_axis_numbers(
    lhs_shape: &[usize],
    rhs_shape: &[usize],
    lhs_axes: &[usize],
    rhs_axes: &[usize],
    output_order: &[usize]
) -> Self

Produces a TensordotGeneral from the shapes and list of axes to be contracted.

Wrapped by the public tensordot function and used by TensordotGeneral::new(). lhs_axes lists the axes from the lhs tensor to contract and rhs_axes lists the axes from the rhs tensor to contract.

Trait Implementations

impl Clone for TensordotGeneral

fn clone(&self) -> TensordotGeneral

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TensordotGeneral

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

Formats the value using the given formatter.

impl<A> PairContractor<A> for TensordotGeneral

fn contract_pair<'a, 'b, 'c, 'd>(
    &self,
    lhs: &'b ArrayViewD<'a, A>,
    rhs: &'d ArrayViewD<'c, A>
) -> ArrayD<A> where
    'a: 'b,
    'c: 'd,
    A: Clone + LinalgScalar, 

fn contract_and_assign_pair<'a, 'b, 'c, 'd, 'e, 'f>(
    &self,
    lhs: &'b ArrayViewD<'a, A>,
    rhs: &'d ArrayViewD<'c, A>,
    out: &'f mut ArrayViewMutD<'e, A>
) where
    'a: 'b,
    'c: 'd,
    'e: 'f,
    A: Clone + LinalgScalar,