doc: Add module-level comments for networks.

This commit is contained in:
Sergiu Ivanov 2020-11-29 22:01:18 +01:00
parent 96f8782d7b
commit d95891537b

View file

@ -1,12 +1,46 @@
#lang scribble/manual #lang scribble/manual
@(require (for-label racket graph)) @(require (for-label racket graph "../networks.rkt"))
@title[#:tag "networks"]{dds/networks: Formal Dynamical Networks} @title[#:tag "networks"]{dds/networks: Formal Dynamical Networks}
@racketblock[ @defmodule[dds/networks]
(define (nobody-understands-me what)
(list "When I think of all the" This module provides definitions for and analysing network models. A network
what is a set of variables which are updated according to their corresponding update
"I've tried so hard to explain!")) functions. The variables to be updated at each step are given by the mode.
(nobody-understands-me "glorble snop") This model can generalise Boolean networks, TBANs, multivalued networks, etc.
]
@section{Basic definitions}
@section{Syntactic description of networks}
@section{Inferring interaction graphs}
This section provides inference of both unsigned and signed interaction graphs.
Since the inference of signed interaction graphs is based on analysing the
dynamics of the networks, it may be quite resource-consuming, especially since
I allow any syntactic forms in the definitions of the functions.
Note the fine difference between @emph{syntactic} interaction graphs and
interaction graphs generated from the dynamics of the network.
Syntactic interaction graphs are based on the whether a variable appears or not
in the form of the function for another variable. On the other hand, the
normal, conventional interaction graph records the fact that one variable has
an impact on the dynamics of the other variable. Depending on the model, these
may or may not be the same.
@section{Dynamics of networks}
This section contains definitions for building and analysing the dynamics
of networks.
@section{Tabulating functions and networks}
@section{Constructing functions and networks}
@section{Random functions and networks}
@section{TBF/TBN and SBF/SBN}
This section defines threshold Boolean functions (TBF) and networks (TBN), as
well as sign Boolean functions (SBF) and networks (SBN).