toqito.matrices.standard_basis
==============================

.. py:module:: toqito.matrices.standard_basis

.. autoapi-nested-parse::

   Constructs the standard basis.





Module Contents
---------------

.. py:function:: standard_basis(dim, flatten = False)

   Create standard basis of dimension `dim`.

   Create a list containing the elements of the standard basis for the
   given dimension:

   \[
       |1> = (1, 0, 0, ..., 0)^T
       |2> = (0, 1, 0, ..., 0)^T
       .
       .
       .
       |n> = (0, 0, 0, ..., 1)^T
   \]

   This function was inspired by [@Seshadri_2021_Git, Seshadri_2021_Theory, Seshadri_2021_Versatile]

   .. rubric:: Examples

   ```python exec="1" source="above"
   from toqito.matrices import standard_basis

   print(standard_basis(2))
   ```

   :param dim: The dimension of the basis.
   :param flatten: If True, the basis is returned as a flattened list.

   :returns: A list of numpy.ndarray of shape (n, 1).