get.State — Read a network's recurrent state rows.
State is a Layer/Parameter/Value table. Recurrent HiddenState and CellState rows come from the network's canonical state store; stateless networks have an empty table.
Syntax
state = get.State(network)Inputs
network- Type
Any- Required
- Yes
- Default
- —
- Description
- A dlnetwork, SeriesNetwork, or DAGNetwork value object.
Returns
state- Type
Any- Description
- The network's validated recurrent State table.
Errors
RunMat:deepLearning:InvalidInput- When
- The State table does not match the network's recurrent state rows, class, or shape.
- Message
network State access received invalid input
Value ownership
Reading State leaves the value network unchanged. State values retain their numeric class and resident allocation; reading does not download GPU data.
RunMat exposes this table on SeriesNetwork and DAGNetwork values as an extension. State evolution by recurrent forward execution is documented with the recurrent execution support, not implied by this accessor alone.
Using get.State with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how get.State changes the result.
Run a small get.State example, explain the result, then change one input and compare the output.
Related Deep Learning functions
adamupdate · analyzeNetwork · bilstmLayer · classificationLayer · combvec · convolution1dLayer · crossentropy · dlarray · dlarray.minus · dlarray.mtimes · dlarray.plus · dlarray.rdivide · dlarray.sum · dlarray.times · dlfeval · dlgradient · dlnetwork · dlupdate · eluLayer · exportONNXNetwork · featureInputLayer · forward · fullyConnectedLayer · get.Learnables · globalAveragePooling1dLayer · layerGraph · layerNormalizationLayer · lstmLayer · padsequences · regressionLayer · reluLayer · sequenceInputLayer · set.Learnables · set.State · softmaxLayer · trainingOptions · trainnet · trainNetwork
Source you can read
Every RunMat function's source is public. Read exactly how get.State is executed, line by line, in Rust.
- View the source for get.State in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.