tril

Contents

tril#

class brainunit.math.tril(m, k=0, unit=Unit('1'))#

Return the lower triangle of an array.

Return a copy of a matrix with the elements above the k-th diagonal zeroed. For arrays with ndim > 2, tril applies to the final two axes.

Parameters:

  • m (saiunit.Quantity | Array | ndarray | number | bool) – Input array.

  • k (int) – Diagonal above which to zero elements. k = 0 is the main diagonal, k < 0 is below it, and k > 0 is above.

  • unit (saiunit.Unit) – Unit of the returned Quantity.

Returns:

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

Return type:

saiunit.Quantity | Array

Examples

>>> import saiunit as u
>>> import jax.numpy as jnp
>>> u.math.tril(jnp.ones((3, 3)))
Array([[1., 0., 0.],
       [1., 1., 0.],
       [1., 1., 1.]], dtype=float32)
Contents