year — Extract calendar year components from datetime values with MATLAB-compatible output shaping.
year(t) extracts year numbers from datetime values and retained legacy date inputs, returning double values with the input shape.
Syntax
X = year(t)
X = year(t, yearTypeOrFormat)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
value | Any | Yes | — | Datetime input. |
t | Any | Yes | — | Legacy serial date number or date text. |
F | StringScalar | Yes | — | Legacy datestr input format. |
Returns
| Name | Type | Description |
|---|---|---|
X | Any | Numeric scalar/tensor result. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:datetime:InvalidArgument | Arguments or option grammar do not match supported datetime forms. | datetime: invalid argument |
RunMat:datetime:InvalidInput | Input values cannot be parsed/converted/broadcast to a valid datetime result. | datetime: invalid input |
RunMat:datetime:Internal | Internal datetime state or indexing/evaluation failed unexpectedly. | datetime: internal operation failed |
How year works
year(t)accepts datetime scalars and arrays. The optional year type is'iso'or'gregorian'.- For compatibility with existing code, serial date numbers and text dates are also accepted; an optional date format can be supplied for legacy input.
- The output shape matches the input shape.
- The returned values are numeric doubles, even when the years are mathematically integers.
- RunMat mode additionally accepts single-precision and native integer legacy serial-date storage.
Does RunMat run year on the GPU?
year does not dispatch GPU kernels. If the datetime was produced from gathered numeric data, the result still remains a CPU numeric array.
GPU memory and residency
No. year reads datetime objects on the CPU and returns ordinary host-side numeric arrays.
Examples
Extract the year from a scalar datetime
t = datetime(2024, 4, 9, 13, 30, 0);
y = year(t)Expected output:
y = 2024Extract years from a datetime array
t = datetime([2024 2025], [1 6], [15 20]);
y = year(t)Expected output:
y =
2024 2025Using year with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how year changes the result.
Run a small year example, explain the result, then change one input and compare the output.
FAQ
Does year preserve the input shape?⌄
Yes. A scalar datetime returns a scalar double, and datetime arrays return numeric arrays of the same size.
Does year return integers?⌄
It returns MATLAB-style doubles whose values are whole-number years.
Does year run on the GPU?⌄
No. datetime values are host-side objects, so year executes on the CPU.
Related Datetime functions
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how year is executed, line by line, in Rust.
- View the source for year in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 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.