The FullPureState class and supporting functionality.

Module Contents



A "fully parameterized" state vector where each element is an independent parameter.

class pygsti.modelmembers.states.fullpurestate.FullPureState(purevec, basis='pp', evotype='default', state_space=None)

Bases: pygsti.modelmembers.states.densestate.DensePureState

A “fully parameterized” state vector where each element is an independent parameter.


vecarray_like or State

a 1D numpy array representing the state operation. The shape of this array sets the dimension of the state op.

basisBasis or {‘pp’,’gm’,’std’}, optional

The basis used to construct the Hilbert-Schmidt space representation of this state as a super-ket.

evotypeEvotype or str, optional

The evolution type. The special value “default” is equivalent to specifying the value of pygsti.evotypes.Evotype.default_evotype.

state_spaceStateSpace, optional

The state space for this operation. If None a default state space with the appropriate number of qubits is used.

Initialize a new state Vector

property num_params

Get the number of independent parameters which specify this state vector.


the number of independent parameters.


Get the state vector parameters as an array of values.

numpy array

The parameters as a 1D array with length num_params().

from_vector(v, close=False, dirty_value=True)

Initialize the state vector using a 1D array of parameters.

vnumpy array

The 1D vector of state vector parameters. Length must == num_params()

closebool, optional

Whether v is close to this state vector’s current set of parameters. Under some circumstances, when this is true this call can be completed more quickly.

dirty_valuebool, optional

The value to set this object’s “dirty flag” to before exiting this call. This is passed as an argument so it can be updated recursively. Leave this set to True unless you know what you’re doing.




The element-wise derivative this state vector.

Construct a matrix whose columns are the derivatives of the state vector with respect to a single param. Thus, each column is of length dimension and there is one column per state vector parameter.

wrt_filterlist or numpy.ndarray

List of parameter indices to take derivative with respect to. (None means to use all the this operation’s parameters.)

numpy array

Array of derivatives, shape == (dimension, num_params)


Whether this state vector has a non-zero Hessian with respect to its parameters.