bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / ma / core / identity
function
numpy.ma.core:identity
source: build-install/usr/lib/python3.14/site-packages/numpy/ma/core.py :8749
Signature
def identity ( n , dtype = None , * , like = None , fill_value = None , hardmask = False ) Summary
Return the identity array.
Extended Summary
The identity array is a square array with ones on the main diagonal.
Parameters
n: intNumber of rows (and columns) in
nxnoutput.dtype: data-type, optionalData-type of the output. Defaults to
float.like: array_like, optionalReference object to allow the creation of arrays which are not NumPy arrays. If an array-like passed in as
likesupports the__array_function__protocol, the result will be defined by it. In this case, it ensures the creation of an array object compatible with that passed in via this argument.
Returns
out: MaskedArraynxnarray with its main diagonal set to one, and all other elements 0.
Examples
import numpy as np np.identity(3)
Aliases
-
numpy.ma.identity