.. highlightlang:: us

.. _eye:

eye
===

.. index:: eye

.. us.tag  eye NOTREADYENGLISH math-create-mat

:ref:`eye` returns an identity matrix.

.. function::  rmDiag = eye(n)

.. us.return

**Return Value**

*rmDiag* is a matrix with ones on the diagonal and 0 elsewhere.

.. us.params

**Parameters**

.. uparam:: n

   *n* is the number of rows and columns.

.. us.example

**Example**

::

   * eye(3)
       1.0000     0.0000     0.0000
       0.0000     1.0000     0.0000
       0.0000     0.0000     1.0000

.. seealso::
   :ref:`overview-mathematic`,
   :ref:`diag`,
   :ref:`ones`

:sub:`id-2003046`