Skip to main content
`Ctrl`+`K`
scipy.sparse.

# eye

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

  Sparse matrix of chosen shape with ones on the kth diagonal and zeros elsewhere.

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

  Warning

  This function returns a sparse matrix – not a sparse array. You are encouraged to use `eye_array` to take advantage of the sparse array functionality.

  Parameters:
    m int

      Number of rows in the matrix.

    n int, optional

      Number of columns. Default: m.

    k int, optional

      Diagonal to place ones on. Default: 0 (main diagonal).

    dtype dtype, optional

      Data type of the matrix.

    format str, optional

      Sparse format of the result, e.g., format=”csr”, etc.

  Returns:
    new_matrix sparse matrix

      Sparse matrix of chosen shape with ones on the kth diagonaland zeros elsewhere.

  See also

  `eye_array`

    Sparse array of chosen shape with ones on a specified diagonal.

  Examples

      >>> import numpy as np
      >>> import scipy as sp
      >>> sp.sparse.eye(3).toarray()
      array([[ 1.,  0.,  0.],
             [ 0.,  1.,  0.],
             [ 0.,  0.,  1.]])
      >>> sp.sparse.eye(3, dtype=np.int8)
      <DIAgonal sparse matrix of dtype 'int8'
          with 3 stored elements (1 diagonals) and shape (3, 3)>