codistributor2dbc — Create a two-dimensional block-cyclic distribution description.
codistributor2dbc describes a matrix distributed in blocks across a two-dimensional worker grid.
Syntax
codist = codistributor2dbc(worker_grid, block_size, orientation, global_size)Inputs
worker_grid- Type
Any- Required
- No
- Default
- —
- Description
- Optional two-element worker grid.
block_size- Type
IntegerScalar- Required
- No
- Default
- —
- Description
- Optional positive block size.
orientation- Type
StringScalar- Required
- No
- Default
row- Description
- Worker-grid rank orientation, row or col.
global_size- Type
Any- Required
- No
- Default
- —
- Description
- Optional complete matrix size.
Returns
result- Type
Any- Description
- Result produced by the parallel operation.
Errors
RunMat:parallel:LoweringRequired- When
- The operation is invoked without an active compiler-owned SPMD or distributed execution context.
- Message
parallel operation requires executor-aware lowering
Behavior
A codistributor is an immutable distribution description. A one-dimensional description records a distribution dimension, one partition length per worker, and an optional global size. A two-dimensional block-cyclic description records a worker grid, block size, row- or column-major grid orientation, and an optional global matrix size.
Constructors may leave properties unresolved. The distribution service resolves omitted values against the array shape and admitted worker count when a distributed value is created or redistributed. Declared partition lengths, grids, dimensions, and global sizes must agree at that boundary.
Codistributor objects contain exact integer structural values. They describe placement but do not own partition payloads, a pool generation, or accelerator buffers.
Execution placement
Constructing or inspecting a codistributor is local and does not launch workers. Distribution begins only when an operation such as codistributed or redistribute resolves the description against a pool.
Examples
Describe a complete block-cyclic matrix layout
codist = codistributor2dbc(uint32([2 2]), uint64(1), "col", uint64([4 4]))Expected output:
a 2-by-2 column-oriented worker grid with unit blocksUse row-oriented worker-grid numbering
codist = codistributor2dbc(uint32([1 2]), uint64(8))Expected output:
Orientation is rowUsing codistributor2dbc with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how codistributor2dbc changes the result.
Run a small codistributor2dbc example, explain the result, then change one input and compare the output.
FAQ
Does construction start a pool?⌄
No. A codistributor is a local immutable description; distribution resolves it against a pool later.
What makes a codistributor complete?⌄
Its GlobalSize property is present and valid. Other properties may still be resolved or validated when used.
Are dimensions and partitions stored as doubles?⌄
No. Structural properties use exact unsigned integer values.
Can a codistributor be reused?⌄
Yes when its declared shape and layout are valid for the target array and admitted worker count.
Related Parallel functions
codistributed · codistributed.build · codistributor · codistributor1d · distributed · fetchNext · fetchOutputs · gcat · gcp · getCodistributor · getCurrentJob · getCurrentTask · getCurrentWorker · getLocalPart · globalIndices · gop · gplus · iscodistributed · isComplete · labBarrier · labBroadcast · labindex · labProbe · labReceive · labSend · labSendReceive · numlabs · parfeval · parfevalOnAll · parpool · redistribute · spmdBarrier · spmdBroadcast · spmdCat · spmdIndex · spmdPlus · spmdProbe · spmdReceive · spmdReduce · spmdSend · spmdSendReceive · spmdSize
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how codistributor2dbc is executed, line by line, in Rust.
- View the source for codistributor2dbc 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.