Literal Array Class

An AbstractArray where all elements have the same constant value. This either arises when using literals in traced code (e.g. x + 1) or when using nv_fill() to create a constant.

Usage

LiteralArray(data, shape, dtype = default_dtype(data), ambiguous)

Arguments

data

(double(1) | integer(1) | logical(1) | AnvlArray)
The scalar value or scalarish AnvlArray (contains 1 element).

shape

(stablehlo::Shape | integer())
The shape of the array.

dtype

(tengen::DataType)
The data type. Defaults to the current backend's default floating dtype, i32 for integer, and bool for logical.

ambiguous

(logical(1))
Whether the type is ambiguous. Ambiguous types usually arise from R literals (e.g., 1L, 1.0) and follow special promotion rules. See the vignette("type-promotion") for more details.

Type Ambiguity

When arising from R literals, the resulting LiteralArray is ambiguous because no type information was available. See the vignette("type-promotion") for more details.

Lowering

LiteralArrays become constants inlined into the stableHLO program. I.e., they lower to stablehlo::hlo_tensor().

Examples

x <- LiteralArray(1L, shape = integer(), ambiguous = TRUE)
x
#> LiteralArray(1, i32?, ()) 
ambiguous(x)
#> [1] TRUE
shape(x)
#> integer(0)
ndims(x)
#> [1] 0
dtype(x)
#> <i32>
# How it appears during tracing:
# 1. via R literals
graph <- trace_fn(function() 1, list())
graph
#> <AnvlGraph>
#>   Inputs: (none)
#>   Body: (empty)
#>   Outputs:
#>     1:f32? 
graph$outputs[[1]]$aval
#> LiteralArray(1, f32?, ()) 
# 2. via nv_fill()
graph <- trace_fn(function() nv_fill(2L, shape = c(2, 2)), list())
graph
#> <AnvlGraph>
#>   Inputs: (none)
#>   Body:
#>     %1: i32[2, 2] = fill [value = 2, dtype = i32, shape = c(2, 2), ambiguous = FALSE] ()
#>   Outputs:
#>     %1: i32[2, 2] 
graph$outputs[[1]]$aval
#> AbstractArray(dtype=i32, shape=2x2)