RSctr function

Control Object

Control Object

The object of class RSctr represents the control parameter specification for the sampling function rsampler. UTF-8

Returns

A legitimate RSctr object is a list with components - burn_in: the number of matrices to be sampled to come close to a stationary distribution.

  • n_eff: the number of effective matrices, i.e., the number of matrices to be generated by the sampling function rsampler.

  • step: controls the number number of void matrices generated in the the burn in process and when effective matrices are generated (see note in rsctrl).

  • seed: is the indicator for the seed of the random number generator. If the value of seed at equals zero, a seed is generated by the sampling function rsampler

  • tfixed: TRUE or FALSE. tfixed = TRUE has no effect if the input matrix is not quadratic, i.e., all matrix elements are considered free (unrestricted). If the input matrix is quadratic, and tfixed = TRUE, the main diagonal of the matrix is considered as fixed.

Generation

This object is returned from function rsctrl.

Methods

This class has a method for the generic summary

function.

See Also

rsctrl

  • Maintainer: Patrick Mair
  • License: GPL-3
  • Last published: 2025-03-25

Useful links