toeplitz_tensor

# Import statement

from hottbox.utils.generation import toeplitz_tensor

toeplitz_tensor(shape, modes=None, matC=None, random=False, lh=(None, None))

Function to generate a Toeplitz tensor. Every slice along modes will be a Toeplitz matrix.

Parameters

shapetuple(int)

Shape of output. If matC is not None, they must match.

modesint or list(int)

The mode by which the tensor is expected to be circulant

matClist(np.ndarray) or list(float)

(optional) if None, random is set to True. Two input options.

randombool

(optional) if true, input matC is ignored

lhtuple(float, float)

(optional) used with random to define min and max values