pyhgf.typing.typing.AdjacencyLists#

class pyhgf.typing.typing.AdjacencyLists(node_type, value_parents, volatility_parents, value_children, volatility_children, coupling_fn)[source]#

Indexes to a node’s value and volatility parents.

The variable node_type encode the type of state node: * 0: input node. * 1: binary state node. * 2: continuous state node. * 3: exponential family state node - univariate Gaussian distribution with unknown

mean and unknown variance.

  • 4: Dirichlet Process state node.

The variable coupling_fn list the coupling functions between this nodes and the children nodes. If None is provided, a linear coupling is assumed.

Parameters:
  • node_type (int) – The type of the state node (see the codes listed above).

  • value_parents (tuple | None) – Indexes to the value parents of the node, or None when the node has no value parent.

  • volatility_parents (tuple | None) – Indexes to the volatility parents of the node, or None when the node has no volatility parent.

  • value_children (tuple | None) – Indexes to the value children of the node, or None when the node has no value child.

  • volatility_children (tuple | None) – Indexes to the volatility children of the node, or None when the node has no volatility child.

  • coupling_fn (tuple[Callable | None, ...]) – The coupling functions between the node and its children. If None is provided, a linear coupling is assumed.

__init__(*args, **kwargs)#

Methods

__init__(*args, **kwargs)

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

Attributes

coupling_fn

Alias for field number 5

node_type

Alias for field number 0

value_children

Alias for field number 3

value_parents

Alias for field number 1

volatility_children

Alias for field number 4

volatility_parents

Alias for field number 2