bm_collect {inlabru} | R Documentation |
Mapper for concatenated variables
Description
Constructs a concatenated collection mapping
Usage
bm_collect(mappers, hidden = FALSE)
bru_mapper_collect(...)
## S3 method for class 'bm_collect'
ibm_n(mapper, inla_f = FALSE, multi = FALSE, ...)
## S3 method for class 'bm_collect'
ibm_n_output(mapper, input, state = NULL, inla_f = FALSE, multi = FALSE, ...)
## S3 method for class 'bm_collect'
ibm_values(mapper, inla_f = FALSE, multi = FALSE, ...)
## S3 method for class 'bm_collect'
ibm_is_linear(mapper, inla_f = FALSE, multi = FALSE, ...)
## S3 method for class 'bm_collect'
ibm_jacobian(
mapper,
input,
state = NULL,
inla_f = FALSE,
multi = FALSE,
...,
sub_lin = NULL
)
## S3 method for class 'bm_collect'
ibm_eval(
mapper,
input,
state,
inla_f = FALSE,
multi = FALSE,
...,
sub_lin = NULL
)
## S3 method for class 'bm_collect'
ibm_linear(mapper, input, state, inla_f = FALSE, ...)
## S3 method for class 'bm_collect'
ibm_invalid_output(mapper, input, state, inla_f = FALSE, multi = FALSE, ...)
## S3 method for class 'bm_collect'
x[i, drop = TRUE]
## S3 method for class 'bru_mapper_collect'
x[i, drop = TRUE]
## S3 method for class 'bm_collect'
ibm_names(mapper)
## S3 replacement method for class 'bm_collect'
ibm_names(mapper) <- value
## S3 replacement method for class 'bru_mapper_collect'
ibm_names(mapper) <- value
Arguments
mappers |
A list of |
| |
... |
Arguments passed on to other methods |
mapper |
A mapper S3 object, inheriting from |
inla_f |
logical; when |
multi |
logical;
If |
input |
Data input for the mapper. |
state |
A vector of latent state values for the mapping,
of length |
sub_lin |
Internal, optional pre-computed sub-mapper information |
x |
object from which to extract element(s) |
i |
indices specifying element(s) to extract |
drop |
logical;
For |
value |
a character vector of the same length as the number of sub-mappers in the mapper |
Value
-
[
-indexing abm_collect
extracts a subsetbm_collect
object (for dropFALSE
) or an individual sub-mapper (for dropTRUE
, andi
identifies a single element)
The
names()
method forbm_collect
returns the names from the sub-mappers list
Methods (by generic)
-
ibm_jacobian(bm_collect)
: Accepts a list with named entries, or a list with unnamed but ordered elements. The names must match the sub-mappers, seeibm_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. Wheninla_f=TRUE
andhidden=TRUE
in the mapper definition, the input format should instead match that of the first, non-hidden, sub-mapper. -
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, seeibm_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.
See Also
bru_mapper, bru_mapper_generics
Other mappers:
bm_aggregate()
,
bm_const()
,
bm_factor()
,
bm_fmesher()
,
bm_harmonics()
,
bm_index()
,
bm_linear()
,
bm_logsumexp()
,
bm_marginal()
,
bm_matrix()
,
bm_mesh_B()
,
bm_multi()
,
bm_pipe()
,
bm_repeat()
,
bm_scale()
,
bm_shift()
,
bm_sum()
,
bm_taylor()
,
bru_get_mapper()
,
bru_mapper()
,
bru_mapper.fm_mesh_1d()
,
bru_mapper.fm_mesh_2d()
,
bru_mapper_generics
Examples
(m <- bm_collect(list(
a = bm_index(2),
b = bm_index(3)
), hidden = FALSE))
ibm_eval2(m, list(a = c(1, 2), b = c(1, 3, 2)), 1:5)