Skip to contents

Pad

Source: R/api.R
nv_pad.Rd

Pads an array with a given value at the edges and optionally between elements.

Usage

nv_pad(
  operand,
  padding_value,
  edge_padding_low,
  edge_padding_high,
  interior_padding = NULL
)

Arguments

operand

(arrayish)
Operand.

padding_value

(arrayish)
Scalar value to use for padding. Must have the same dtype as operand.

edge_padding_low

(integer())
Amount of padding to add at the start of each dimension.

edge_padding_high

(integer())
Amount of padding to add at the end of each dimension.

interior_padding

(integer() | NULL)
Amount of padding to add between elements in each dimension. If NULL (default), no interior padding is applied.

Value

arrayish
Has the same data type as operand.

See also

prim_pad() for the underlying primitive.

Examples

x <- nv_array(c(1, 2, 3))
nv_pad(x, nv_scalar(0), edge_padding_low = 2L, edge_padding_high = 1L)
#> AnvlArray
#>  0
#>  0
#>  1
#>  2
#>  3
#>  0
#> [ CPUf32{6} ]