HyperbolicTangentCoupling

HyperbolicTangentCoupling#

class brainmass.HyperbolicTangentCoupling(x, conn, k=0.5, scale=2.0)#

Hyperbolic-tangent coupling (TVB HyperbolicTangent, post-nonlinearity).

Applies a symmetric saturating nonlinearity after the network sum:

\[ c_i = k \, \tanh\!\left(\mathrm{scale} \sum_j g_{ij} x_{D_{ij}}\right) \]

where \(g_{ij}\) is the connection strength. k is the global coupling strength (TVB G; G ≡ k) and the output saturates to \(\pm k\).

Parameters:

  • x (PrefetchDelayAt | PrefetchDelay | Prefetch | Callable) – The (optionally delayed) source state, shaped (..., N_out, N_in).

  • conn (Callable | Array | ndarray | bool | number | bool | int | float | complex | Quantity | Param) – Connection matrix (N_out, N_in) or square-flattened (N_out * N_in,).

  • k (Callable | Array | ndarray | bool | number | bool | int | float | complex | Quantity | Param) – Global coupling strength (TVB G).

  • scale (Callable | Array | ndarray | bool | number | bool | int | float | complex | Quantity | Param) – Scaling of the network sum before the tanh.

Return type:

Any

See also

SigmoidalCoupling

asymmetric (logistic) post-nonlinearity.

__init__(x, conn, k=0.5, scale=2.0)[source]#
Parameters:
init_state(*args, **kwargs)[source]#

State initialization function.

update(*args, **kwargs)[source]#