ibm_invalid_output: Detect invalid input to a mapper

In inlabru: Bayesian Latent Gaussian Modelling using INLA and Extensions

Detect invalid input to a mapper

Description

Implementations should return a logical vector of length ibm_n_output(mapper, input, state, ...) indicating which, if any, output elements of ibm_eval(mapper, input, state, ...) are known to be invalid. For for multi/collect mappers, a list, when given a multi=TRUE argument.

Usage

ibm_invalid_output(mapper, input, state, ...)

## Default S3 method:
ibm_invalid_output(mapper, input, state, ...)

## S3 method for class 'bm_index'
ibm_invalid_output(mapper, input, state, ...)

## S3 method for class 'bm_multi'
ibm_invalid_output(mapper, input, state, inla_f = FALSE, multi = FALSE, ...)

## S3 method for class 'bm_collect'
ibm_invalid_output(mapper, input, state, inla_f = FALSE, multi = FALSE, ...)

## S3 method for class 'bm_repeat'
ibm_invalid_output(mapper, input, state, ...)

## S3 method for class 'bm_sum'
ibm_invalid_output(mapper, input, state, multi = FALSE, ...)

Arguments

mapper	A mapper S3 object, inheriting from bru_mapper.
input	Data input for the mapper.
state	A vector of latent state values for the mapping, of length ibm_n(mapper, inla_f = FALSE)
...	Arguments passed on to other methods
inla_f	logical; when TRUE for ibm_n() and ibm_values(), the result must be compatible with the INLA::f(...) and corresponding INLA::inla.stack(...) constructions. For ⁠ibm_{eval,jacobian,linear}⁠, the input interpretation may be different. Implementations do not normally need to do anything different, except for mappers of the type needed for hidden multicomponent models such as "bym2", which can be handled by bm_collect.
multi	logical; If TRUE (or positive), recurse one level into sub-mappers

Value

A logical vector of length ibm_n_output(mapper, input, state, ...) indicating which, if any, output elements of ibm_eval(mapper, input, state, ...) are known to be invalid.

Methods (by class)

• ibm_invalid_output(default): Returns an all-FALSE logical vector.

• ibm_invalid_output(bm_index): Returns TRUE out-of-range input values. Returns FALSE for in-range and NA input values (to support NA giving zero effect).

• ibm_invalid_output(bm_multi): Accepts a list with named entries, or a list with unnamed but ordered elements. The names must match the sub-mappers, see ibm_names.bm_multi(). Each list element should take a format accepted by the corresponding sub-mapper. In case each element is a vector, the input can be given as a data.frame with named columns, a matrix with named columns, or a matrix with unnamed but ordered columns.

• ibm_invalid_output(bm_collect): Accepts a list with named entries, or a list with unnamed but ordered elements. The names must match the sub-mappers, see ibm_names.bm_collect(). Each list element should take a format accepted by the corresponding sub-mapper. In case each element is a vector, the input can be given as a data.frame with named columns, a matrix with named columns, or a matrix with unnamed but ordered columns.

• ibm_invalid_output(bm_repeat): Passes on the input to the corresponding method.

• ibm_invalid_output(bm_sum): Accepts a list with named entries, or a list with unnamed but ordered elements. The names must match the sub-mappers, see ibm_names.bm_sum(). Each list element should take a format accepted by the corresponding sub-mapper. In case each element is a vector, the input can be given as a data.frame with named columns, a matrix with named columns, or a matrix with unnamed but ordered columns.

See Also

Other mapper methods: bru_mapper_generics, ibm_as_taylor(), ibm_eval(), ibm_eval2(), ibm_inla_subset(), ibm_is_linear(), ibm_is_rowwise(), ibm_jacobian(), ibm_n(), ibm_n_output(), ibm_names(), ibm_simplify(), ibm_values()

Examples

m <- bm_collect(list(A = bm_linear(), B = bm_linear()), hidden = TRUE)
ibm_invalid_output(m, input = list(A = 1, B = 2), state = c(1, 2))

inlabru documentation built on July 28, 2026, 9:07 a.m.