asserts.ndims
Check the number of dimensions.
📝Syntax
asserts.ndims(value, n)
[res, msg] = asserts.ndims(value, n)
📥Input Arguments
Parameter Description
value Value to test.
n Expected nonnegative finite integer scalar dimension count.
📤Output Arguments
Parameter Description
res true if the assertion passes, false otherwise.
msg assertion failure message, empty on success.
📄Description

The assertion passes when ndims(value) equals n.

Invalid n raises an argument error immediately.

💡Examples
Two dimensions
asserts.ndims(ones(2, 3), 2);
Capture a dimension failure
[res, msg] = asserts.ndims(ones(2, 3, 2), 2);
🔗See Also
asserts.size
🕔Version History
Version Description
2.0.0 initial version
Edit this page on GitHub