ibm_n_output: Output size of a mapping

In inlabru: Bayesian Latent Gaussian Modelling using INLA and Extensions

Output size of a mapping

Description

Implementations must return an integer denoting the mapper output length. The default implementation returns NROW(input). Mappers such as bm_multi and bm_collect, that can accept list() inputs require their own method implementations.

Usage

ibm_n_output(mapper, input, state = NULL, inla_f = FALSE, ...)

## Default S3 method:
ibm_n_output(mapper, input, state = NULL, inla_f = FALSE, ...)

## S3 method for class 'bm_taylor'
ibm_n_output(mapper, input, ...)

## S3 method for class 'bm_shift'
ibm_n_output(mapper, input, state = NULL, ..., n_state = NULL)

## S3 method for class 'bm_scale'
ibm_n_output(mapper, input, state = NULL, ..., n_state = NULL)

## S3 method for class 'bm_aggregate'
ibm_n_output(mapper, input = NULL, ...)

## S3 method for class 'bm_marginal'
ibm_n_output(mapper, input, state = NULL, ..., n_state = NULL)

## S3 method for class 'bm_pipe'
ibm_n_output(mapper, input, state = NULL, ..., n_state = NULL)

## S3 method for class 'bm_multi'
ibm_n_output(mapper, input, ...)

## S3 method for class 'bm_reparam'
ibm_n_output(mapper, ...)

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

## S3 method for class 'bm_expr'
ibm_n_output(
  mapper,
  input,
  state = NULL,
  inla_f = FALSE,
  ...,
  derived = NULL,
  n_state = NULL,
  data = NULL
)

## S3 method for class 'bm_repeat'
ibm_n_output(mapper, ...)

## S3 method for class 'bm_sum'
ibm_n_output(mapper, input, state = NULL, ...)

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)
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.
...	Arguments passed on to other methods
n_state	integer giving the length of the state vector for mappers that have state dependent output size.
multi	logical; If TRUE (or positive), recurse one level into sub-mappers
derived	The state vectors of variables derived from the root variables. If NULL or missing, defaults to an empty list.
data	should be a list with data objects, with the main object called data; see bm_expr() for details.

Value

An integer denoting the mapper output length.

Methods (by class)

• ibm_n_output(default): Returns NROW(input)

See Also

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

Examples

m <- bm_linear()
ibm_n_output(m, input = c(1, 3, 4, 5, 2), state = 2)

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