ergm_SAN_slave: Internal Function to Perform Simulated Annealing

View source: R/ergm.san.R

ergm_SAN_slaveR Documentation

Internal Function to Perform Simulated Annealing

Description

This is an internal function, not normally called directly by the user. The ergm_SAN_slave function samples networks and network statistics using a simulated annealing (SAN) algorithm via SAN_wrapper.

Usage

ergm_SAN_slave(
  state,
  tau,
  control,
  verbose,
  ...,
  nsteps = NULL,
  samplesize = NULL,
  statindices = NULL,
  offsetindices = NULL,
  offsets = NULL
)

Arguments

state

an ergm_state representing the sampler state, containing information about the network, the model, the proposal, and current statistics.

tau

a scalar; temperature to use; higher temperature means more proposals that "worsen" the statistics are accepted.

control

A list of control parameters for algorithm tuning, typically constructed with control.san(). Its documentation gives the the list of recognized control parameters and their meaning. The more generic utility snctrl() (StatNet ConTRoL) also provides argument completion for the available control functions and limited argument name checking.

verbose

A logical or an integer to control the amount of progress and diagnostic information to be printed. FALSE/0 produces minimal output, with higher values producing more detail. Note that very high values (5+) may significantly slow down processing.

...

additional arguments, currently unused.

nsteps

an integer; number of SAN proposals.

samplesize

an integer; number of network statistics to return.

statindices, offsetindices, offsets

specification for offset handling; see san.formula() implementation.


statnet/ergm documentation built on April 17, 2024, 12:21 p.m.