### Navigation

- index
- modules |
- modules |
- next |
- previous |
- SciPy v0.12 Reference Guide (DRAFT) »
- Sparse matrices (`scipy.sparse`) »

# scipy.sparse.eye

`scipy.sparse.``eye`(m, n=None, k=0, dtype=<type 'float'>, format=None)

  Sparse matrix with ones on diagonal

  Returns a sparse (m x n) matrix where the k-th diagonal is all ones and everything else is zeros.

  Parameters : | n : integer Number of rows in the matrix. m : integer, optional Number of columns. Default: n k : integer, optional Diagonal to place ones on. Default: 0 (main diagonal) dtype : : Data type of the matrix format : string Sparse format of the result, e.g. format=”csr”, etc.

  Examples

      >>> from scipy import sparse
      >>> sparse.eye(3).todense()
      matrix([[ 1.,  0.,  0.],
              [ 0.,  1.,  0.],
              [ 0.,  0.,  1.]])
      >>> sparse.eye(3, dtype=np.int8)
      <3x3 sparse matrix of type '<type 'numpy.int8'>'
          with 3 stored elements (1 diagonals) in DIAgonal format>

### Navigation

- index
- modules |
- modules |
- next |
- previous |
- SciPy v0.12 Reference Guide (DRAFT) »
- Sparse matrices (`scipy.sparse`) »