compress

Compression of a single MPS or MPO.

A thin wrapper around portc.stack.src for one-train stacks:

MPO randomized compression.
MPS randomized compression.

funccompress

(tensor, chi_out, *, cutoff=0.0, oversample=1.0, dtype=None, seed=None, device='cpu', resources=None, optimize=DEFAULT_OPTIMIZE) -> list[np.ndarray]

Applies the Successive Randomized Compression (SRC) algorithm.

Equivalent to src(tensor, ...); see portc.stack.src for the conventions. The train type is inferred from the rank of the first site tensor:

MPS: tensor is an MPS. Results in an MPS.
MPO: tensor is an MPO. Results in an MPO.

Raises

TypeError: If chi_out is not an integer, the input tensor type is unsupported, or optimize is neither a name nor a PathOptimizer.
ValueError: If chi_out is not positive, if cutoff is not in [0.0, 1.0), if oversample is not finite and at least 1.0, if the train is not open-boundary, if a sub-three-site train is not exactly two sites, if optimize names no opt_einsum path optimizer, or if device is not recognised.
ImportError: If device="gpu" but cupy is not installed.

paramtensorSequence[Site]

The site arrays of the tensor network to compress (MPS or MPO).

paramchi_outint | np.integer

The desired maximum bond dimension of the output tensor network.

paramcutofffloat

= 0.0

Relative singular-value cutoff for adaptive bond truncation. Discards singular values below cutoff * sigma_max; see portc.stack.src. Set to 0.0 (default) to disable cutoff trimming. Ignored for two sites.

paramoversamplefloat | None

= 1.0

Multiplicative sketch-size factor, finite and at least 1.0, or None for the paper's recommendation; see portc.stack.src. Defaults to 1.0, no oversampling.

paramdtypeDTypeLike | None

= None

Data type of the random sketches. Defaults to the promoted floating dtype of the inputs; an explicit dtype can promote the result.

paramseedint | None

= None

An optional seed for the random number generator.

paramdevicestr

= 'cpu'

"cpu" (default, numpy) or "gpu" (cupy). Requires the optional cupy dependency for GPU execution.

paramresourcesResources | None

= None

Memory budgets and scratch space; see portc.stack.src.

paramoptimizestr | PathOptimizer

= DEFAULT_OPTIMIZE

The opt_einsum path optimizer of the contractions, a name or a PathOptimizer; see portc.stack.src. Defaults to "dp".

Returns

list

The site arrays of the compressed tensor network (MPS or MPO), in right-canonical form, or left-canonical form when oversampling (three sites or more).