Learn R Programming

ldmppr (version 1.1.2)

ldmppr_grids-class: Grid schedule object

Description

Objects of class ldmppr_grids define one or more grid "levels" used by estimate_process_parameters. Each level contains numeric vectors x, y, and t defining the approximation grid. Levels are typically ordered from coarse to fine.

Usage

# S3 method for ldmppr_grids
print(x, ...)

# S3 method for ldmppr_grids summary(object, ...)

# S3 method for summary.ldmppr_grids print(x, ...)

# S3 method for ldmppr_grids as.data.frame(x, ...)

# S3 method for ldmppr_grids length(x)

# S3 method for ldmppr_grids [(x, i, ...)

# S3 method for ldmppr_grids as.list(x, ...)

Value

print()

prints a brief description of bounds and grid levels.

summary()

returns a summary.ldmppr_grids.

as.data.frame()

returns one row per level with dimensions and ranges.

length()

returns the number of levels.

[ ]

subsets levels, preserving class.

as.list()

returns the underlying list structure.

Arguments

x

an object of class ldmppr_grids.

...

unused.

object

an object of class ldmppr_grids.

i

indices of levels to keep.

Functions

  • print(ldmppr_grids): Print a brief summary of a grid schedule.

  • summary(ldmppr_grids): Summarize a grid schedule.

  • print(summary.ldmppr_grids): Print a summary produced by summary.ldmppr_grids().

  • as.data.frame(ldmppr_grids): Convert a grid schedule to a data.frame.

  • length(ldmppr_grids): Number of levels in a grid schedule.

  • [: Subset grid levels.

  • as.list(ldmppr_grids): Extract the underlying list representation.

Details

A ldmppr_grids is a list with (at minimum):

  • levels: list of levels; each level is a list with x, y, t

  • upper_bounds: numeric c(b_t, b_x, b_y)

  • labels: optional labels used only for printing

  • include_endpoints: logical