nimbleFunctionVirtual: create a virtual nimbleFunction, a base class for other...

View source: R/nimbleFunction_core.R

nimbleFunctionVirtualR Documentation

create a virtual nimbleFunction, a base class for other nimbleFunctions

Description

define argument types and returnType for the run function and any methods, to be used in the contains argument of nimbleFunction

Usage

nimbleFunctionVirtual(
  contains = NULL,
  run = function() { },
  methods = list(),
  name = NA
)

Arguments

contains

Not yet functional

run

A NIMBLE function that will only be used to inspect its argument types and returnType.

methods

An optional named list of NIMBLE functions that will also only be used for inspecting argument types and returnTypes.

name

An optional name used internally by the NIMBLE compiled. This is usually omitted and NIMBLE provides one.

Details

See the NIMBLE User Manual section on nimbleFunctionLists for explanation of how to use a virtual nimbleFunction.

Value

An object that can be passed as the contains argument to nimbleFunction or as the argument to nimbleFunctionList

Author(s)

NIMBLE development team

See Also

nimbleFunction


nimble documentation built on March 18, 2022, 8:03 p.m.