StanArray: A Stan array

In jtimonen/odemodeling: Building, fitting, and validating Bayesian ODE models in 'Stan'

A Stan array

Description

A Stan array

A Stan array

Super class

odemodeling::StanDeclaration -> StanArray

Public fields

dims

list of array dimensions

type

base type of the array

Methods

Public methods

• StanArray$new()

• StanArray$declaration()

• StanArray$signature()

• StanArray$can_be_made_parameter()

• StanArray$get_dims()

• StanArray$clone()

Inherited methods

• odemodeling::StanDeclaration$print()

---

Method new()

Create a StanArray object.

Usage

StanArray$new(name, dims, type = "real", lower = NULL, upper = NULL)

Arguments

name

name of the array

dims

list of array dimensions, must be a list of StanDimension objects

type

base type of the array

lower

lower bound

upper

upper bound

---

Method declaration()

Create a declaration for the array

Usage

StanArray$declaration()

Returns

a string

---

Method signature()

The variable when used in function signature

Usage

StanArray$signature()

---

Method can_be_made_parameter()

Can the object be made into a parameter?

Usage

StanArray$can_be_made_parameter()

---

Method get_dims()

Get all declared dimensions related to the object.

Usage

StanArray$get_dims()

Returns

A list.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StanArray$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

jtimonen/odemodeling documentation built on Sept. 15, 2024, 4:29 a.m.