tril(m, k=0)

This docstring was copied from numpy.tril.

Some inconsistencies with the Dask version may exist.

Return a copy of an array with elements above the k-th diagonal zeroed. For arrays with ndim exceeding 2, tril will apply to the final two axes.

Parameters

m : array_like, shape (..., M, N)

Input array.

k : int, optional

Diagonal above which to zero elements. :None:None:`k = 0` (the default) is the main diagonal, :None:None:`k < 0` is below it and :None:None:`k > 0` is above.

Returns

tril : ndarray, shape (..., M, N)

Lower triangle of m, of same shape and data-type as m.

Lower triangle of an array.

See Also

triu

same thing, only for the upper triangle

Examples

This example is valid syntax, but we were not able to check execution

>>> np.tril([[1,2,3],[4,5,6],[7,8,9],[10,11,12]], -1)  # doctest: +SKIP
array([[ 0,  0,  0],
       [ 4,  0,  0],
       [ 7,  8,  0],
       [10, 11, 12]])

This example is valid syntax, but we were not able to check execution

>>> np.tril(np.arange(3*4*5).reshape(3, 4, 5))  # doctest: +SKIP
array([[[ 0,  0,  0,  0,  0],
        [ 5,  6,  0,  0,  0],
        [10, 11, 12,  0,  0],
        [15, 16, 17, 18,  0]],
       [[20,  0,  0,  0,  0],
        [25, 26,  0,  0,  0],
        [30, 31, 32,  0,  0],
        [35, 36, 37, 38,  0]],
       [[40,  0,  0,  0,  0],
        [45, 46,  0,  0,  0],
        [50, 51, 52,  0,  0],
        [55, 56, 57, 58,  0]]])

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

dask.array.routines.tril dask.array.routines.tril_indices_from dask.array.routines.triu_indices dask.array.routines.triu dask.array.routines.tril_indices dask.array.creation.diag

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /dask/array/routines.py#2425
type: <class 'function'>
Commit: