Package org.flag4j.operations.dense.real

Class RealDenseTensorDot

java.lang.Object

org.flag4j.operations.dense.real.RealDenseTensorDot

public final class RealDenseTensorDot
extends Object

This class contains methods for computing a tensor dot product, i.e. tensor contraction, between two real dense tensors.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RealDenseTensorDot()

Method Summary

Modifier and Type	Method	Description
static Tensor	tensorDot(Tensor src1, Tensor src2)	Computes the tensor dot product along the first tensors last axis and the second tensors second-to-last axis.
static Tensor	tensorDot(Tensor src1, Tensor src2, int[] src1Axes, int[] src2Axes)	Computes the tensor contraction of this tensor with a specified tensor over the specified set of axes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RealDenseTensorDot

private RealDenseTensorDot()

Method Details

tensorDot

public static Tensor tensorDot(Tensor src1,
 Tensor src2)

Computes the tensor dot product along the first tensors last axis and the second tensors second-to-last axis. Or, if the second tensor has rank 1, the last axis of the second tensor.

Parameters:

src1 - First tensor in the tensor product.

src2 - Second tensor in the tensor product.

Returns:

The tensor dot product along the first tensors last axis and the second tensors second-to-last axis.

Throws:

IllegalArgumentException - If this tensors shape along the last axis does not match src2 shape along the second-to-last axis.

tensorDot

public static Tensor tensorDot(Tensor src1,
 Tensor src2,
 int[] src1Axes,
 int[] src2Axes)

Computes the tensor contraction of this tensor with a specified tensor over the specified set of axes. That is, computes the sum of products between the two tensors along the specified set of axes.

Parameters:

src1 - First tensor in the contraction.

src2 - Second tensor in the contraction.

src1Axes - Axes along which to compute products for src1 tensor.

src2Axes - Axes along which to compute products for src2 tensor.

Returns:

The tensor dot product over the specified axes.

Throws:

IllegalArgumentException - If the two tensors shapes do not match along the specified axes pairwise in aAxes and bAxes.

IllegalArgumentException - If aAxes and bAxes do not match in length, or if any of the axes are out of bounds for the corresponding tensor.