class.initial_reserve: Initial Reserve Function class

In Don-Li/CAB_original:

Description

Initial Reserve functions are implemented specially for Catania's Operant Reserve (Catania, 2005). Catania (2005) and Berg & McDowell (2011) used constants for the reserve depletion. However, we have generalised this to a function. The initial_reserve class is used to set up the Initial Reserve function, that is, the parameters are not set here. Instead, the initial_reserve will go into a initial_reserve_control object that contains both the initial_reserve as well as its associated parameters.

Usage

initial_reserve.show

remove.initial_reserve.show()

Format

The show method prints the function that is contained in the initial_reserve object as well as the type of object (i.e. "elemental") and the class (i.e. "initial_reserve" ).

Details

In the CAB package, objects from classes like initial_reserve are called 'elemental' objects That is, they comprise a particular element of the simulation without any specified parameter values. 'Control' objects are elemental objects with an associated list of parameter values. Refer to class.DOR for information for putting a initial_reserve in a model.

The show method for the initial_reserve class can be removed with the function remove.initial_reserve.show() and reinstated with initial_reserve.show.

Slots

initial_reserve

This will contain an Initial Reserve function. See examples.

name

The name of the initial_reserve object.

type

This will be elemental because the initial_reserve is an elemental object.

Built-in Initial Reserve functions

A list of the built-in Initial Reserve functions. The function definitions can be seen by calling the name of the function without brackets. These functions return a scalar that is the initial reserve value.

constant_initial_fx

An Initial Reserve function where the initial reserve level is a constant.

f(t = 0) = x

where x is the amount that the reserve will begin with at time = 0.

Make a initial_reserve object from an Initial Reserve function

Use the make.initial_reserve function to make a initial_reserve object.

Usage

make.initial_reserve( initial_reserve_fx, name )

Arguments

initial_reserve_fx

A function that represents the Initial Reserve level of interest

name

A character vector specifying the name of your initial_reserve object

Value

Returns a initial_reserve object.

References

Berg, J. P., & McDowell, J. J (2011). Quantitative, steady-state properties of Catania's computational model of the operant reserve. Behavioural Processes, 87(1), 71-83. https://doi.org/10.1016/j.beproc.2011.01.006

Catania, A. C. (2005). The operant reserve: A computer simulation in (accelerated) real time. Behavioural Processes, 69(2), 257-278. https://doi.org/10.1016/j.beproc.2005.02.009

See Also

make.control for making DOR_control objects.

set.custom_elemental for setting custom elemental classes.

make.custom_elemental for making custom elemental objects.

e_show for the function that is called by the show method.

class.elemental for the parent elemental class.

Examples

# Look at the definition of the "constant_initial_fx" Initial Reserve function.
constant_initial_fx
# Make an initial_reserve object out of the "constant_initial_fx" function.
initial_reserve = make.initial_reserve( initial_reserve_fx = constant_initial_fx, name = "initial_reserve" )

Don-Li/CAB_original documentation built on May 6, 2019, 2:53 p.m.