Skip to contents

All Reduction

Source: R/api.R, R/api-generics.R
nv_reduce_all.Rd

Performs logical AND along the specified axes. Returns TRUE only if all elements are TRUE.

Usage

nv_reduce_all(x, axes = NULL, drop = TRUE)

Arguments

x

(arrayish)
One input. Must be a boolean or an R logical.

axes

(integer() | NULL)
Axes to reduce over. Negative values count from the end, i.e. -1 refers to the last axis. If NULL (default), reduces over all axes.

drop

(logical(1))
Whether to drop the reduced axes: removed from the output shape if TRUE, set to 1 if FALSE.

Value

(arrayish)
Has the boolean data type. The shape is the input's with the reduced axes removed (drop = TRUE) or set to 1 (drop = FALSE).

The all() generic

all() reduces over all axes and, like base::all(), takes several data arguments: all(x, y) asks about both arrays. It is logical, so – unlike base R – a non-boolean argument is an error rather than a comparison against zero. Beyond base R, named arguments are passed on, so all(x, axes = 1L) reduces a single axis – but only when x is the only data argument.

See also

prim_reduce_all() for the underlying primitive.

Examples

x <- nv_matrix(c(TRUE, FALSE, TRUE, TRUE), nrow = 2)
# no axes given: reduce over all of them
nv_reduce_all(x)
#> AnvlArray
#>  0
#> [ CPUbool{} ] 

# reducing axis 1 removes it, drop = FALSE keeps it at size 1
nv_reduce_all(x, axes = 1L)
#> AnvlArray
#>  0
#>  1
#> [ CPUbool{2} ] 
nv_reduce_all(x, axes = 1L, drop = FALSE)
#> AnvlArray
#>  0 1
#> [ CPUbool{1,2} ]