3.3 Размер объектов

Следующие функции позволяют определить размер переменной или выражения. Эти функции определены для всех объектов. Они возвращают -1, когда операция не имеет смысла. Например, тип данных структуры данных Octave не имеет строк или столбцов, поэтому функции rows и columns возвращают -1 для аргументов структуры.

ndims (a)

Возвращает число измерений объекта a.

Для любого массива результат всегда будет больше или равен 2. Конечные одиночные измерения не учитываются, т.е. конечные измерения d больше 2, для которых size (a, d) = 1.

ndims (ones (4, 1, 2, 1))
    ⇒ 3

См. также: size.

columns (a)

Возвращает число столбцов объекта a. Это эквивалентно size (a, 2).

См. также: rows, size, length, numel, isscalar, isvector, ismatrix.

rows (a)

Возвращает число строк объекта a. Это эквивалентно size (a, 1).

См. также: columns, size, length, numel, isscalar, isvector, ismatrix.

numel (a)

numel (a, idx1, idx2, …)

Возвращает число элементов в объекте a.

При необходимости, если указаны индексы idx1, idx2, …, возвращает число элементов, которые получились бы в результате индексирования.

a(idx1, idx2, …)

Обратите внимание, что индексы не обязательно должны быть скалярными числами. Например,

a = 1;
b = ones (2, 3);
numel (a, b)

вернёт 6, так как это количество способов индексирования с помощью b. Или индекс может быть строкой ":", которая представляет оператор двоеточия. Например,

a = ones (5, 3);
numel (a, 2, ":")

вернёт 3, так как вторая строка содержит три столбцовых элемента.

Этот метод также вызывается, когда объект появляется в качестве lvalue с индексированием cs-списка, т.е. object{…} или object(…).field.

См. также: size, length, ndims.

length (a)

Возвращает длину объекта a.

Длина равна 0 для пустых объектов, 1 для скаляров и числу элементов для векторов. Для матриц или N-мерных объектов длина равна числу элементов вдоль наибольшего измерения (эквивалентно max (size (a))).

См. также: numel, size.

sz = size (a)

dim_sz = size (a, dim)

[rows, cols, …, dim_N_sz] = size (…)

Возвращает строчный вектор с размером (числом элементов) каждого измерения объекта a.

При указании второго аргумента dim, возвращает размер соответствующего измерения.

С одним выходным аргументом, size возвращает строчный вектор. При вызове с несколькими выходными аргументами, size возвращает размер измерения N в N-м аргументе. Число строк, измерение 1, возвращается в первом аргументе, число столбцов, измерение 2, возвращается во втором аргументе и т.д. Если в a больше измерений, чем выходных аргументов, size возвращает общее число элементов в оставшихся измерениях в последнем выходном аргументе.

Пример 1: строчный вектор результата

size ([1, 2; 3, 4; 5, 6])
   ⇒ [ 3, 2 ]

Пример 2: число элементов во 2-м измерении (столбцах)

size ([1, 2; 3, 4; 5, 6], 2)
    ⇒ 2

Пример 3: число выходных аргументов == число измерений

[nr, nc] = size ([1, 2; 3, 4; 5, 6])
    ⇒ nr = 3
    ⇒ nc = 2

Пример 4: число выходных аргументов < число измерений

[nr, remainder] = size (ones (2, 3, 4, 5))
    ⇒ nr = 2
    ⇒ remainder = 60

См. также: numel, ndims, length, rows, columns, size_equal, common_size.

isempty (a)

Возвращает true, если a является пустой матрицей (любое из её измерений равно нулю).

См. также: isnull, isa.

isnull (x)

Возвращает true, если x является специальной нулевой матрицей, строкой или строкой в одинарных кавычках.

Индексированное присваивание со значением null в правой части должно удалять элементы массива. Эта функция используется вместо isempty при перегрузке метода индексированного присваивания (subsasgn) для пользовательских классов. isnull используется для различения этих двух случаев:

A(I) = []

и

X = []; A(I) = X

В первом присваивании правая часть - [], что является специальным нулевым значением. Пока индекс I не пустой, этот код должен удалять элементы из A, а не выполнять присваивание.

Во втором присваивании правая часть пуста (потому что X - []), но не является нулевой. Этот код должен присвоить пустое значение элементам в A.

Пример из встроенного класса char Octave демонстрирует поведение интерпретатора, когда isnull используется правильно.

str = "Hello World";
nm = "Wally";
str(7:end) = nm                # indexed assignment
  ⇒ str = Hello Wally
str(7:end) = ""                # indexed deletion
  ⇒ str = Hello

См. также: isempty, isindex.

sizeof (val)

Возвращает размер val в байтах.

См. также: whos.

size_equal (a, b, …)

Возвращает true, если размеры всех аргументов совпадают.

Конечные одиночные измерения игнорируются. При вызове с одним аргументом или без аргументов size_equal возвращает true.

См. также: size, numel, ndims, common_size.

squeeze (x)

Удаляет одиночные измерения из x и возвращает результат.

Обратите внимание, что для совместимости с MATLAB, все объекты имеют минимум два измерения, а строчные векторы остаются неизменными.

См. также: reshape.