ndims

Number of array dimensions

Usage

ndims(A)

• A should be an array.
• It returns the number of dimensions of A.
• More specifically, it returns $\max(2, d)$, where $d$ is the highest non-singleton dimension of A.
• A dimension is called singleton if it has length equal to 1. Otherwise, it is called non-singleton.

Examples

• The last two dimensions of r are singleton. The highest non-singleton dimension is 4, hence ndims(r) is 4.

Input

r = ones(1,2,3,4,1,1);
ndims(r)

Output

ans = 
 4.0000

• The 3rd dimension has zero length and hence is non-singleton. As a result, ndims(A) is 3 in the following.

Input

ndims(rand(2,3,0,1))

Output

ans = 
 3.0000

• ndims(A) returns 2 when A is a scalar or a vector (row or column).

Input

ndims(1)
ndims(1:5)
ndims((1:5)')

Output

ans = 
 2.0000

ans = 
 2.0000

ans = 
 2.0000

ans = 
 2.0000