Documentation

ndims

Number of array dimensions

Syntax

N = ndims (A)

Description

example

N = ndims (A)returns the number of dimensions in the arrayA. The number of dimensions is always greater than or equal to2. The function ignores trailing singleton dimensions, for whichsize(A,dim) = 1.

Examples

collapse all

Create a row vector.

A = 1:5;

Find the number of dimensions in the vector.

ndims(A)
ans = 2

The result is2because the vector has a size of 1-by-5.

Create a cell array of character vectors.

A{1,1,1} ='cell_1'; A{1,1,2} ='cell_2'; A{1,1,3} ='cell_3'
A =1x1x3 cell arrayA(:,:,1) = {'cell_1'} A(:,:,2) = {'cell_2'} A(:,:,3) = {'cell_3'}

Find the number of dimensions of the cell array.

ndims(A)
ans = 3

The result is3because the cell array has a size of 1-by-1-by-3.

Input Arguments

collapse all

Input array, specified as a scalar, vector, matrix, multidimensional array, table, or timetable.

Data Types:double|single|int8|int16|int32|int64|uint8|uint16|uint32|uint64|logical|char|string|struct|cell|table|timetable|categorical|datetime|duration|calendarDuration

Algorithms

The number of dimensions in an array is the same as the length of the size vector of the array. In other words,ndims(A) = length(size(A)).

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

See Also

|

Introduced before R2006a

Was this topic helpful?