rand.random_state_vector

Generates a random state vector.

Functions

random_state_vector(dim[, is_real, k_param, seed])

Generate a random pure state vector.

Module Contents

rand.random_state_vector.random_state_vector(dim, is_real=False, k_param=0, seed=None)

Generate a random pure state vector.

Examples

We may generate a random state vector. For instance, here is an example where we can generate a \(2\)-dimensional random state vector.

from toqito.rand import random_state_vector

vec = random_state_vector(2)

vec

array([[0.60864935+0.54040016j],
       [0.09241054+0.57356249j]])

We can verify that this is in fact a valid state vector by computing the corresponding density matrix of the vector and checking if the density matrix is pure.

from toqito.state_props import is_pure

dm = vec.conj().T @ vec

is_pure(dm)

True

It is also possible to pass a seed for reproducibility.

from toqito.rand import random_state_vector

vec = random_state_vector(2, seed=42)

vec

array([[0.54521054+0.60483621j],
       [0.30916633+0.49125839j]])

We can once again verify that this is in fact a valid state vector by computing the corresponding density matrix of the vector and checking if the density matrix is pure.

from toqito.state_props import is_pure

dm = vec.conj().T @ vec

is_pure(dm)

True
Parameters:

  • dim (list[int] | int) – The number of rows (and columns) of the unitary matrix.

  • is_real (bool) – Boolean denoting whether the returned matrix has real entries or not. Default is False.

  • k_param (int) – Default 0.

  • seed (int | None) – A seed used to instantiate numpy’s random number generator.

Returns:

A dim-by-dim random unitary matrix.

Return type:

numpy.ndarray