template.class_template.SymmetryOrbitEQN._populate_state

SymmetryOrbitEQN._populate_state(**kwargs)

Should only be accessed through Orbit.populate()

Parameters

kwargsdict

Takes the following keys by default, left general for subclass generalization

seed : int

The seed for the numpy random number generator

basis : str

One of the orbithunter.core.Orbit.bases_labels() or None if independent. Defines the basis that the state array is returned after calling this method.

Notes

Must populate and set attributes ‘state’, ‘discretization’ and ‘basis’. The state is required to be a numpy array, the discretization is required to be its shape (tuple) in the basis specified by self.bases_labels()[0]. Discretization is coupled to the state and its specific basis, hence why it is populated here.