Output size of a mapping

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_collect'
ibm_n_output(mapper, input, state = NULL, inla_f = FALSE, multi = FALSE, ...)

# 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

Methods (by class)

• ibm_n_output(default): Returns NROW(input)

See also

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

Other specific bm_taylor method implementations: bm_taylor(), ibm_eval(), ibm_jacobian(), ibm_n(), ibm_values()

Other specific bm_shift method implementations: bm_shift(), ibm_eval(), ibm_jacobian(), ibm_n(), ibm_values()

Other specific bm_scale method implementations: bm_scale(), ibm_eval(), ibm_jacobian(), ibm_n(), ibm_values()

Other specific bm_aggregate method implementations: bm_aggregate(), ibm_eval(), ibm_jacobian(), ibm_n(), ibm_values()

Other specific bm_marginal method implementations: bm_marginal(), ibm_eval(), ibm_jacobian(), ibm_n(), ibm_values()

Other specific bm_pipe method implementations: bm_pipe(), ibm_eval(), ibm_eval2(), ibm_jacobian(), ibm_n(), ibm_simplify(), ibm_values()

Other specific bm_multi method implementations: bm_multi(), ibm_eval(), ibm_invalid_output(), ibm_is_linear(), ibm_jacobian(), ibm_linear(), ibm_n(), ibm_names(), ibm_values()

Other specific bm_collect method implementations: bm_collect(), ibm_eval(), ibm_invalid_output(), ibm_is_linear(), ibm_jacobian(), ibm_linear(), ibm_n(), ibm_names(), ibm_values()

Other specific bm_repeat method implementations: bm_repeat(), ibm_eval(), ibm_invalid_output(), ibm_jacobian(), ibm_linear(), ibm_n(), ibm_values()

Other specific bm_sum method implementations: bm_sum(), ibm_eval(), ibm_invalid_output(), ibm_is_linear(), ibm_jacobian(), ibm_linear(), ibm_n(), ibm_names(), ibm_values()