Skip to main contentIBM Quantum Documentation
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

MPOState

class MPOState(sites, Ws, bc='finite', IdL=None, IdR=None, max_range=None, explicit_plus_hc=False)

GitHub

Bases: MPO, State

A mediator class to make TeNPy’s MPO match the State interface.

This class simply ensures that a tenpy.networks.mpo.MPO object can work as a State instance.


Methods

initialize_from_lattice

classmethod initialize_from_lattice(lat, *, conserve=True)

GitHub

Construct an identity MPOState instance matching the provided lattice shape.

Given a lattice, this method constructs a new MPO identity matching the shape of the lattice.

Parameters

  • lat (Lattice) – the lattice describing the MPO sites.
  • conserve (bool) – whether to conserve Sz. This is a simplified version of the more elaborate conserve property of SpinHalfSite. The boolean value simply indicates Sz (True) or None conservation (False)

Returns

An identity MPO.

Return type

MPOState

overlap

overlap(initial_state)

GitHub

Compute the overlap of this state with the provided initial state.

Warning

This implementation only supports instances of tenpy.networks.mps.MPS for initial_state.

Parameters

initial_state (Any) – the initial state with which to compute the overlap.

Raises

TypeError – if the provided initial state has an incompatible type.

Returns

The overlap of this state with the provided one.

Return type

complex

Was this page helpful?
Report a bug or request content on GitHub.