Statevector.equiv

Statevector.equiv(other, rtol=None, atol=None)[source]

Return True if statevectors are equivalent up to global phase.

Parameters

  • other (Statevector) – a statevector object.

  • rtol (float) – relative tolerance value for comparison.

  • atol (float) – absolute tolerance value for comparison.

Returns

True if statevectors are equivalent up to global phase.

Return type

bool