@reicek/neataptic-ts 0.1.24 → 0.1.26

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

@@ -13,80 +13,97 @@ constructor policy and the ongoing activation or training lifecycle.
 
 ## architecture/network/bootstrap/network.bootstrap.utils.ts
 
-### resolveTopologyIntent
+### applySeedOption
 
 ```ts
-resolveTopologyIntent(
+applySeedOption(
+  network: NetworkBootstrapInternals,
   options: NetworkConstructorOptions | undefined,
-): NetworkTopologyIntent
+): void
 ```
 
-Resolves the public topology intent for one constructor call.
-
-Prefer this semantic contract over the legacy low-level acyclic flag when
-both are available.
+Applies the optional deterministic seed from constructor options.
 
 Parameters:
+- `network` - Network instance being constructed.
 - `options` - Optional constructor options.
 
-Returns: Resolved topology intent.
+Returns: Nothing.
 
-### validateTopologyIntentConfiguration
+### bootstrapNetwork
 
 ```ts
-validateTopologyIntentConfiguration(
-  options: NetworkConstructorOptions | undefined,
+bootstrapNetwork(
+  network: NetworkBootstrapInternals,
+  bootstrapContext: NetworkBootstrapContext,
 ): void
 ```
 
-Validates that legacy acyclic flags do not contradict public topology intent.
+Performs one-time `Network` construction setup.
 
-This protects callers from creating a constructor packet that says
-"feed-forward" in one field and "cyclic is allowed" in another.
+This orchestration keeps the constructor readable by separating four concerns:
+public topology-policy resolution, runtime flag initialization, pooled memory
+warmup, and synthesis of the initial fully connected IO graph.
 
 Parameters:
-- `options` - Optional constructor options.
+- `network` - Network instance being constructed.
+- `bootstrapContext` - Constructor inputs and resolved topology policy.
 
 Returns: Nothing.
 
-### resolveAcyclicEnforcement
+### connectInitialInputToOutputGraph
 
 ```ts
-resolveAcyclicEnforcement(
-  options: NetworkConstructorOptions | undefined,
-  topologyIntent: NetworkTopologyIntent,
-): boolean
+connectInitialInputToOutputGraph(
+  network: NetworkBootstrapInternals,
+): void
 ```
 
-Resolves whether acyclic enforcement should be enabled for one constructor call.
+Connects every input node to every output node to form the starter graph.
 
-The semantic topology intent remains the source of truth unless the caller
-explicitly opted into the legacy boolean toggle.
+The initial weight scaling mirrors the existing Network constructor behavior
+so this split remains a pure structural refactor.
 
 Parameters:
-- `options` - Optional constructor options.
-- `topologyIntent` - Resolved public topology intent.
+- `network` - Network instance being constructed.
 
-Returns: True when acyclic enforcement should be enabled.
+Returns: Nothing.
 
-### bootstrapNetwork
+### ensureMinimumHiddenNodes
 
 ```ts
-bootstrapNetwork(
+ensureMinimumHiddenNodes(
   network: NetworkBootstrapInternals,
-  bootstrapContext: NetworkBootstrapContext,
+  minimumHiddenNodes: number,
 ): void
 ```
 
-Performs one-time `Network` construction setup.
+Ensures the network reaches the caller's requested minimum hidden width.
 
-This orchestration keeps the constructor readable by separating four concerns:
-public topology-policy resolution, runtime flag initialization, pooled memory
-warmup, and synthesis of the initial fully connected IO graph.
+This relies on the public node-split mutation flow so the constructor and the
+evolutionary runtime keep growing hidden structure the same way.
+
+Parameters:
+- `network` - Network instance being constructed.
+- `minimumHiddenNodes` - Requested minimum hidden-node count.
+
+Returns: Nothing.
+
+### initializeIONodes
+
+```ts
+initializeIONodes(
+  network: NetworkBootstrapInternals,
+): void
+```
+
+Creates the initial input and output nodes for a new network.
+
+When node pooling is enabled, each acquired node is reset before use so the
+freshly constructed graph still starts from deterministic runtime state.
 
 Parameters:
 - `network` - Network instance being constructed.
-- `bootstrapContext` - Constructor inputs and resolved topology policy.
 
 Returns: Nothing.
 
@@ -133,75 +150,58 @@ Parameters:
 
 Returns: Nothing.
 
-### applySeedOption
+### resolveAcyclicEnforcement
 
 ```ts
-applySeedOption(
-  network: NetworkBootstrapInternals,
+resolveAcyclicEnforcement(
   options: NetworkConstructorOptions | undefined,
-): void
-```
-
-Applies the optional deterministic seed from constructor options.
-
-Parameters:
-- `network` - Network instance being constructed.
-- `options` - Optional constructor options.
-
-Returns: Nothing.
-
-### initializeIONodes
-
-```ts
-initializeIONodes(
-  network: NetworkBootstrapInternals,
-): void
+  topologyIntent: NetworkTopologyIntent,
+): boolean
 ```
 
-Creates the initial input and output nodes for a new network.
+Resolves whether acyclic enforcement should be enabled for one constructor call.
 
-When node pooling is enabled, each acquired node is reset before use so the
-freshly constructed graph still starts from deterministic runtime state.
+The semantic topology intent remains the source of truth unless the caller
+explicitly opted into the legacy boolean toggle.
 
 Parameters:
-- `network` - Network instance being constructed.
+- `options` - Optional constructor options.
+- `topologyIntent` - Resolved public topology intent.
 
-Returns: Nothing.
+Returns: True when acyclic enforcement should be enabled.
 
-### connectInitialInputToOutputGraph
+### resolveTopologyIntent
 
 ```ts
-connectInitialInputToOutputGraph(
-  network: NetworkBootstrapInternals,
-): void
+resolveTopologyIntent(
+  options: NetworkConstructorOptions | undefined,
+): NetworkTopologyIntent
 ```
 
-Connects every input node to every output node to form the starter graph.
+Resolves the public topology intent for one constructor call.
 
-The initial weight scaling mirrors the existing Network constructor behavior
-so this split remains a pure structural refactor.
+Prefer this semantic contract over the legacy low-level acyclic flag when
+both are available.
 
 Parameters:
-- `network` - Network instance being constructed.
+- `options` - Optional constructor options.
 
-Returns: Nothing.
+Returns: Resolved topology intent.
 
-### ensureMinimumHiddenNodes
+### validateTopologyIntentConfiguration
 
 ```ts
-ensureMinimumHiddenNodes(
-  network: NetworkBootstrapInternals,
-  minimumHiddenNodes: number,
+validateTopologyIntentConfiguration(
+  options: NetworkConstructorOptions | undefined,
 ): void
 ```
 
-Ensures the network reaches the caller's requested minimum hidden width.
+Validates that legacy acyclic flags do not contradict public topology intent.
 
-This relies on the public node-split mutation flow so the constructor and the
-evolutionary runtime keep growing hidden structure the same way.
+This protects callers from creating a constructor packet that says
+"feed-forward" in one field and "cyclic is allowed" in another.
 
 Parameters:
-- `network` - Network instance being constructed.
-- `minimumHiddenNodes` - Requested minimum hidden-node count.
+- `options` - Optional constructor options.
 
 Returns: Nothing.

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

@@ -97,27 +97,6 @@ net.disconnect(nodeA, nodeB);
 
 ## architecture/network/connect/network.connect.create.utils.ts
 
-### shouldRejectConnectionForAcyclicMode
-
-```ts
-shouldRejectConnectionForAcyclicMode(
-  network: default,
-  internalState: ConnectNetworkInternals,
-  sourceNode: default,
-  targetNode: default,
-): boolean
-```
-
-Determine whether an edge must be rejected to preserve acyclic ordering.
-
-Parameters:
-- `network` - - Network instance owning node ordering.
-- `internalState` - - Runtime network internals used by connection pipeline.
-- `sourceNode` - - Candidate source node.
-- `targetNode` - - Candidate target node.
-
-Returns: True when edge should be rejected.
-
 ### createConnectionsFromSourceNode
 
 ```ts
@@ -137,43 +116,43 @@ Parameters:
 
 Returns: Created low-level connection objects.
 
-### registerCreatedConnections
+### markConnectionCachesDirtyWhenNeeded
 
 ```ts
-registerCreatedConnections(
-  network: default,
+markConnectionCachesDirtyWhenNeeded(
   internalState: ConnectNetworkInternals,
-  sourceNode: default,
-  targetNode: default,
-  createdConnections: default[],
+  createdConnectionCount: number,
 ): void
 ```
 
-Register created connections in either normal-connection or self-connection storage.
+Mark topology and slab caches dirty when connection creation occurred.
 
 Parameters:
-- `network` - - Network instance owning connection collections.
 - `internalState` - - Runtime network internals used by connection pipeline.
-- `sourceNode` - - Source node used during connection creation.
-- `targetNode` - - Target node used during connection creation.
-- `createdConnections` - - Created low-level connection objects.
+- `createdConnectionCount` - - Number of created low-level connections.
 
 Returns: Nothing.
 
-### markConnectionCachesDirtyWhenNeeded
+### registerCreatedConnections
 
 ```ts
-markConnectionCachesDirtyWhenNeeded(
+registerCreatedConnections(
+  network: default,
   internalState: ConnectNetworkInternals,
-  createdConnectionCount: number,
+  sourceNode: default,
+  targetNode: default,
+  createdConnections: default[],
 ): void
 ```
 
-Mark topology and slab caches dirty when connection creation occurred.
+Register created connections in either normal-connection or self-connection storage.
 
 Parameters:
+- `network` - - Network instance owning connection collections.
 - `internalState` - - Runtime network internals used by connection pipeline.
-- `createdConnectionCount` - - Number of created low-level connections.
+- `sourceNode` - - Source node used during connection creation.
+- `targetNode` - - Target node used during connection creation.
+- `createdConnections` - - Created low-level connection objects.
 
 Returns: Nothing.
 
@@ -198,64 +177,64 @@ Parameters:
 
 Returns: Nothing.
 
-## architecture/network/connect/network.connect.remove.utils.ts
-
-### selectConnectionCollection
+### shouldRejectConnectionForAcyclicMode
 
 ```ts
-selectConnectionCollection(
+shouldRejectConnectionForAcyclicMode(
   network: default,
+  internalState: ConnectNetworkInternals,
   sourceNode: default,
   targetNode: default,
-): default[]
+): boolean
 ```
 
-Select the relevant collection to search for the edge.
+Determine whether an edge must be rejected to preserve acyclic ordering.
 
 Parameters:
-- `network` - - Network instance owning connection collections.
-- `sourceNode` - - Source node.
-- `targetNode` - - Target node.
+- `network` - - Network instance owning node ordering.
+- `internalState` - - Runtime network internals used by connection pipeline.
+- `sourceNode` - - Candidate source node.
+- `targetNode` - - Candidate target node.
 
-Returns: Candidate connection collection.
+Returns: True when edge should be rejected.
 
-### removeFirstMatchingConnection
+## architecture/network/connect/network.connect.remove.utils.ts
+
+### disconnectNodes
 
 ```ts
-removeFirstMatchingConnection(
-  network: default,
-  candidateConnections: default[],
+disconnectNodes(
   sourceNode: default,
   targetNode: default,
 ): void
 ```
 
-Remove first connection that matches source and target nodes.
+Delegate per-node disconnect cleanup.
 
 Parameters:
-- `network` - - Network instance used for ungating.
-- `candidateConnections` - - Candidate collection to search.
 - `sourceNode` - - Source node.
 - `targetNode` - - Target node.
 
 Returns: Nothing.
 
-### disconnectNodes
+### findConnectionIndex
 
 ```ts
-disconnectNodes(
+findConnectionIndex(
+  candidateConnections: default[],
   sourceNode: default,
   targetNode: default,
-): void
+): number
 ```
 
-Delegate per-node disconnect cleanup.
+Find index of the first connection matching source and target nodes.
 
 Parameters:
+- `candidateConnections` - - Candidate collection to search.
 - `sourceNode` - - Source node.
 - `targetNode` - - Target node.
 
-Returns: Nothing.
+Returns: Matching index or -1 when no edge is found.
 
 ### markStructureCachesDirty
 
@@ -272,40 +251,61 @@ Parameters:
 
 Returns: Nothing.
 
-### findConnectionIndex
+### removeConnectionAtIndex
 
 ```ts
-findConnectionIndex(
+removeConnectionAtIndex(
+  network: default,
+  candidateConnections: default[],
+  targetConnectionIndex: number,
+): void
+```
+
+Remove one connection by index, ungating first if required.
+
+Parameters:
+- `network` - - Network instance used for ungating.
+- `candidateConnections` - - Candidate collection containing target index.
+- `targetConnectionIndex` - - Index to remove.
+
+Returns: Nothing.
+
+### removeFirstMatchingConnection
+
+```ts
+removeFirstMatchingConnection(
+  network: default,
   candidateConnections: default[],
   sourceNode: default,
   targetNode: default,
-): number
+): void
 ```
 
-Find index of the first connection matching source and target nodes.
+Remove first connection that matches source and target nodes.
 
 Parameters:
+- `network` - - Network instance used for ungating.
 - `candidateConnections` - - Candidate collection to search.
 - `sourceNode` - - Source node.
 - `targetNode` - - Target node.
 
-Returns: Matching index or -1 when no edge is found.
+Returns: Nothing.
 
-### removeConnectionAtIndex
+### selectConnectionCollection
 
 ```ts
-removeConnectionAtIndex(
+selectConnectionCollection(
   network: default,
-  candidateConnections: default[],
-  targetConnectionIndex: number,
-): void
+  sourceNode: default,
+  targetNode: default,
+): default[]
 ```
 
-Remove one connection by index, ungating first if required.
+Select the relevant collection to search for the edge.
 
 Parameters:
-- `network` - - Network instance used for ungating.
-- `candidateConnections` - - Candidate collection containing target index.
-- `targetConnectionIndex` - - Index to remove.
+- `network` - - Network instance owning connection collections.
+- `sourceNode` - - Source node.
+- `targetNode` - - Target node.
 
-Returns: Nothing.
+Returns: Candidate connection collection.