Skip to contents

Upper Triangular Matrix

Source: R/api.R
nv_triu.Rd

Returns the upper triangular part of a 2-D array, setting elements below the specified diagonal to zero.

Usage

nv_triu(x, diagonal = 0L)

Arguments

x

(arrayish)
One input, with exactly 2 axes. Can be any data type. An R value materializes at its default data type.

diagonal

(integer(1))
Diagonal offset: the kept region is col - row >= diagonal. 0 (default) keeps the main diagonal and everything above it, a negative value keeps that many diagonals below it as well, and a positive one drops the main diagonal and diagonal - 1 above it.

Value

(arrayish)
Has the same shape and data type as x.

See also

nv_tril(), nv_upper_tri()

Examples

# elements below the main diagonal become zero
x <- nv_fill(1, c(3, 3))
nv_triu(x)
#> AnvlArray
#>  1 1 1
#>  0 1 1
#>  0 0 1
#> [ CPUf32{3,3} ]