isreal — Determine whether a value uses storage without an imaginary component.
isreal returns one logical scalar based on the input's class and real or complex storage kind.
Syntax
tf = isreal(A)Inputs
A- Type
Any- Required
- Yes
- Description
- Value whose real or complex storage kind is queried.
Returns
tf- Type
LogicalArray- Description
- Logical scalar that is true when the input does not use complex storage.
Errors
RunMat:isreal:InternalError- When
- Internal value or resident-handle metadata is contradictory.
- Message
isreal: internal error
RunMat:isreal:TooManyOutputs- When
- More than one output is requested.
- Message
isreal: too many output arguments
Storage complexity
isreal(A) reports whether the value uses storage without an imaginary component. It returns one logical scalar rather than an elementwise mask.
Real numeric, integer, logical, character, and supported duration values return true. Complex storage returns false even when every stored imaginary component is zero. Strings, cells, structs, tables, datetime values, callables, and other objects return false.
Sparse and resident values
Real and logical sparse matrices return true; complex sparse matrices return false. Resident values are classified from coherent exact-owner storage metadata without downloading their payload.
Examples
Check a real matrix
A = [7 3 2; 2 1 12];
tf = isreal(A)Expected output:
tf = trueDetect complex storage
B = [1 3+4i 2; 2i 1 12];
tf = isreal(B)Expected output:
tf = falseDistinguish complex storage from component values
C = complex(12);
tf = isreal(C)Expected output:
tf = falseCheck logical and character storage
tf_mask = isreal(logical([1 0 1]));
tf_chars = isreal(['R' 'u' 'n'])Expected output:
Both results are trueCheck text and containers
tf_text = isreal("RunMat");
tf_cell = isreal({1, 2});
tf_struct = isreal(struct("value", 1))Expected output:
All results are falseInspect resident storage complexity
G = gpuArray(single([1 2 3]));
Z = complex(G, zeros(size(G), 'like', G));
tf_real = isreal(G);
tf_complex = isreal(Z)Expected output:
tf_real = true and tf_complex = falseUsing isreal with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how isreal changes the result.
Run a small isreal example, explain the result, then change one input and compare the output.
FAQ
Does isreal inspect each element?⌄
No. It reports the value's storage complexity. Use an imaginary-part comparison for an elementwise test.
Why is complex(5) not real?⌄
It uses complex storage even though its imaginary component is zero.
What about logical, duration, or character data?⌄
Those supported classes do not carry an imaginary component and return true.
Why do strings and containers return false?⌄
Their classes are outside the numeric storage-complexity predicate.
Does a resident query launch a kernel or gather?⌄
No. RunMat validates and inspects storage metadata.
Related Logical functions
Source you can read
Every RunMat function's source is public. Read exactly how isreal is executed, line by line, in Rust.
- View the source for isreal 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.