to_ergm_Cdouble: Methods to serialize objects into numeric vectors for passing...

View source: R/to_ergm_Cdouble.R

to_ergm_Cdouble.networkR Documentation

Methods to serialize objects into numeric vectors for passing to the C side.

Description

These methods return a vector of doubles. For edge lists, this usually takes the form of a 2 e + 1- or 3 e + 1-vector, containing the number of edges followed a column-major serialization of the edgelist matrix.

Usage

## S3 method for class 'network'
to_ergm_Cdouble(x, attrname = NULL, ...)

## S3 method for class 'ergm_state'
to_ergm_Cdouble(x, attrname = NULL, ...)

## S3 method for class 'matrix'
to_ergm_Cdouble(x, prototype = NULL, ...)

## S3 method for class 'rlebdm'
to_ergm_Cdouble(x, ...)

to_ergm_Cdouble(x, ...)

Arguments

x

object to be serialized.

attrname

name of an edge attribute.

...

arguments for methods.

prototype

A network whose relevant attributes (size, directedness, bipartitedness, and presence of loops) are imposed on the output edgelist if x is already an edgelist. (For example, if the prototype is undirected, to_ergm_Cdouble will ensure that t < h.)

Value

The rlebdm method returns a vector with the following:

  • number of nonzero dyads,

  • number of runs of nonzeros,

  • starting positions of the runs, and

  • cumulative lengths of the runs, prepended with 0.

Methods (by class)

  • to_ergm_Cdouble(network): Method for network objects.

  • to_ergm_Cdouble(ergm_state): Method for ergm_state objects, extracting their edgelists.

  • to_ergm_Cdouble(matrix): Method for matrix objects, assumed to be edgelists.

  • to_ergm_Cdouble(rlebdm): Method for rlebdm objects.


ergm documentation built on Oct. 7, 2024, 5:08 p.m.