@reicek/neataptic-ts 0.1.25 → 0.1.26

package/src/architecture/network/gating/README.md

@@ -2,26 +2,26 @@
 
 ## architecture/network/gating/network.gating.utils.types.ts
 
-### NodeRemovalMutationConfig
-
-Normalized SUB_NODE mutation configuration used during node-removal rewiring.
-
-### PreservedGaters
+### BridgingConnectionList
 
-Mutable gater collection retained while removing a hidden node.
+Newly created connections that can be assigned preserved gaters.
 
 ### ConnectedNodeList
 
 Predecessor or successor node collection used during bridge construction.
 
-### BridgingConnectionList
-
-Newly created connections that can be assigned preserved gaters.
-
 ### MutableNetworkGatingProps
 
 Network shape extension used to flag node index cache invalidation.
 
+### NodeRemovalMutationConfig
+
+Normalized SUB_NODE mutation configuration used during node-removal rewiring.
+
+### PreservedGaters
+
+Mutable gater collection retained while removing a hidden node.
+
 ## architecture/network/gating/network.gating.utils.ts
 
 ### gate
@@ -47,26 +47,6 @@ Parameters:
 - `node` - - Candidate gater node (must belong to network).
 - `connection` - - Connection to gate.
 
-### ungate
-
-```ts
-ungate(
-  connection: default,
-): void
-```
-
-Remove gating from a connection, restoring its static weight contribution.
-
-Idempotent: If the connection is not currently gated, the call performs no structural changes
-(and optionally logs a warning). After ungating, the connection's weight will be used directly
-without modulation by a gater activation.
-
-Complexity: O(n) where n = number of gated connections (indexOf lookup) – typically small.
-
-Parameters:
-- `this` - - Bound Network instance.
-- `connection` - - Connection to ungate.
-
 ### removeNode
 
 ```ts
@@ -103,6 +83,26 @@ Parameters:
 - `this` - - Bound Network instance.
 - `node` - - Hidden node to remove.
 
+### ungate
+
+```ts
+ungate(
+  connection: default,
+): void
+```
+
+Remove gating from a connection, restoring its static weight contribution.
+
+Idempotent: If the connection is not currently gated, the call performs no structural changes
+(and optionally logs a warning). After ungating, the connection's weight will be used directly
+without modulation by a gater activation.
+
+Complexity: O(n) where n = number of gated connections (indexOf lookup) – typically small.
+
+Parameters:
+- `this` - - Bound Network instance.
+- `connection` - - Connection to ungate.
+
 ## architecture/network/gating/network.gating.gate.utils.ts
 
 ### assertGaterNodeBelongsToNetwork
@@ -122,47 +122,37 @@ Parameters:
 
 Returns: Nothing.
 
-### isConnectionAlreadyGated
+### attachGaterToConnection
 
 ```ts
-isConnectionAlreadyGated(
+attachGaterToConnection(
+  network: default,
+  node: default,
   connection: default,
-): boolean
+): void
 ```
 
-Determine whether a connection already has a gater node assigned.
+Attach a gater to a connection and track that connection in the network gate list.
 
 Parameters:
-- `connection` - - Connection candidate.
-
-Returns: True when a gater is already set; otherwise false.
-
-### warnConnectionAlreadyGated
-
-```ts
-warnConnectionAlreadyGated(): void
-```
-
-Emit a warning when a gate operation is skipped due to existing gating.
+- `network` - - Network being updated.
+- `node` - - Gater node to attach.
+- `connection` - - Connection to gate.
 
 Returns: Nothing.
 
-### attachGaterToConnection
+### detachConnectionFromGater
 
 ```ts
-attachGaterToConnection(
-  network: default,
-  node: default,
+detachConnectionFromGater(
   connection: default,
 ): void
 ```
 
-Attach a gater to a connection and track that connection in the network gate list.
+Remove reverse gater bookkeeping from a connection's gater node.
 
 Parameters:
-- `network` - - Network being updated.
-- `node` - - Gater node to attach.
-- `connection` - - Connection to gate.
+- `connection` - - Connection to detach from its gater.
 
 Returns: Nothing.
 
@@ -183,15 +173,20 @@ Parameters:
 
 Returns: Zero-based index in the gates list, or -1 when absent.
 
-### warnMissingGateConnection
+### isConnectionAlreadyGated
 
 ```ts
-warnMissingGateConnection(): void
+isConnectionAlreadyGated(
+  connection: default,
+): boolean
 ```
 
-Emit a warning when an ungate request targets a non-tracked connection.
+Determine whether a connection already has a gater node assigned.
 
-Returns: Nothing.
+Parameters:
+- `connection` - - Connection candidate.
+
+Returns: True when a gater is already set; otherwise false.
 
 ### removeGateAtIndex
 
@@ -210,18 +205,23 @@ Parameters:
 
 Returns: Nothing.
 
-### detachConnectionFromGater
+### warnConnectionAlreadyGated
 
 ```ts
-detachConnectionFromGater(
-  connection: default,
-): void
+warnConnectionAlreadyGated(): void
 ```
 
-Remove reverse gater bookkeeping from a connection's gater node.
+Emit a warning when a gate operation is skipped due to existing gating.
 
-Parameters:
-- `connection` - - Connection to detach from its gater.
+Returns: Nothing.
+
+### warnMissingGateConnection
+
+```ts
+warnMissingGateConnection(): void
+```
+
+Emit a warning when an ungate request targets a non-tracked connection.
 
 Returns: Nothing.
 
@@ -244,32 +244,24 @@ Parameters:
 
 Returns: Index of the node in the network node list.
 
-### resolveSubNodeMutationConfig
-
-```ts
-resolveSubNodeMutationConfig(): NodeRemovalMutationConfig
-```
-
-Resolve the active SUB_NODE mutation configuration shape.
-
-Returns: Normalized SUB_NODE config when available; otherwise undefined.
-
-### disconnectNodeSelfLoop
+### createBridgingConnections
 
 ```ts
-disconnectNodeSelfLoop(
+createBridgingConnections(
   network: default,
-  node: default,
-): void
+  predecessorNodes: ConnectedNodeList,
+  successorNodes: ConnectedNodeList,
+): BridgingConnectionList
 ```
 
-Disconnect a node self-loop before broader edge rewiring.
+Create bridging connections from each predecessor to each successor when valid.
 
 Parameters:
-- `network` - - Network being updated.
-- `node` - - Node whose self-loop should be removed.
+- `network` - - Network where bridge connections are created.
+- `predecessorNodes` - - Source nodes collected from inbound edges.
+- `successorNodes` - - Target nodes collected from outbound edges.
 
-Returns: Nothing.
+Returns: Newly created bridge connections.
 
 ### disconnectInboundConnections
 
@@ -292,6 +284,23 @@ Parameters:
 
 Returns: Predecessor nodes that previously projected into the removed node.
 
+### disconnectNodeSelfLoop
+
+```ts
+disconnectNodeSelfLoop(
+  network: default,
+  node: default,
+): void
+```
+
+Disconnect a node self-loop before broader edge rewiring.
+
+Parameters:
+- `network` - - Network being updated.
+- `node` - - Node whose self-loop should be removed.
+
+Returns: Nothing.
+
 ### disconnectOutboundConnections
 
 ```ts
@@ -313,24 +322,26 @@ Parameters:
 
 Returns: Successor nodes that were previously targeted by the removed node.
 
-### createBridgingConnections
+### preserveGaterForReassignment
 
 ```ts
-createBridgingConnections(
-  network: default,
-  predecessorNodes: ConnectedNodeList,
-  successorNodes: ConnectedNodeList,
-): BridgingConnectionList
+preserveGaterForReassignment(
+  connection: default,
+  removedNode: default,
+  preservedGaters: PreservedGaters,
+  subNodeConfig: NodeRemovalMutationConfig,
+): void
 ```
 
-Create bridging connections from each predecessor to each successor when valid.
+Preserve a gater for later reassignment when gate retention is enabled.
 
 Parameters:
-- `network` - - Network where bridge connections are created.
-- `predecessorNodes` - - Source nodes collected from inbound edges.
-- `successorNodes` - - Target nodes collected from outbound edges.
+- `connection` - - Connection being detached.
+- `removedNode` - - Node currently being removed.
+- `preservedGaters` - - Mutable list of gaters to keep.
+- `subNodeConfig` - - Current SUB_NODE mutation settings.
 
-Returns: Newly created bridge connections.
+Returns: Nothing.
 
 ### reassignPreservedGaters
 
@@ -351,23 +362,6 @@ Parameters:
 
 Returns: Nothing.
 
-### ungateConnectionsGatedByNode
-
-```ts
-ungateConnectionsGatedByNode(
-  network: default,
-  node: default,
-): void
-```
-
-Ungate all connections that are currently gated by the removed node.
-
-Parameters:
-- `network` - - Network performing ungate operations.
-- `node` - - Node whose gated connections should be released.
-
-Returns: Nothing.
-
 ### removeNodeAtIndex
 
 ```ts
@@ -385,26 +379,30 @@ Parameters:
 
 Returns: Nothing.
 
-### preserveGaterForReassignment
+### resolveSubNodeMutationConfig
 
 ```ts
-preserveGaterForReassignment(
-  connection: default,
-  removedNode: default,
-  preservedGaters: PreservedGaters,
-  subNodeConfig: NodeRemovalMutationConfig,
-): void
+resolveSubNodeMutationConfig(): NodeRemovalMutationConfig
 ```
 
-Preserve a gater for later reassignment when gate retention is enabled.
+Resolve the active SUB_NODE mutation configuration shape.
+
+Returns: Normalized SUB_NODE config when available; otherwise undefined.
+
+### selectRandomIndex
+
+```ts
+selectRandomIndex(
+  length: number,
+): number
+```
+
+Select a uniformly random integer index in the range [0, length).
 
 Parameters:
-- `connection` - - Connection being detached.
-- `removedNode` - - Node currently being removed.
-- `preservedGaters` - - Mutable list of gaters to keep.
-- `subNodeConfig` - - Current SUB_NODE mutation settings.
+- `length` - - Upper bound (exclusive).
 
-Returns: Nothing.
+Returns: Random zero-based index.
 
 ### shouldCreateBridgeConnection
 
@@ -423,17 +421,19 @@ Parameters:
 
 Returns: True when the pair is distinct and no projection already exists.
 
-### selectRandomIndex
+### ungateConnectionsGatedByNode
 
 ```ts
-selectRandomIndex(
-  length: number,
-): number
+ungateConnectionsGatedByNode(
+  network: default,
+  node: default,
+): void
 ```
 
-Select a uniformly random integer index in the range [0, length).
+Ungate all connections that are currently gated by the removed node.
 
 Parameters:
-- `length` - - Upper bound (exclusive).
+- `network` - - Network performing ungate operations.
+- `node` - - Node whose gated connections should be released.
 
-Returns: Random zero-based index.
+Returns: Nothing.