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

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

: n = ndims (A) ¶

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

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

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

См. также: size.

: nc = columns (A) ¶

Возвращает количество столбцов объекта A.

Это эквивалентно size (A, 2).

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

: nr = rows (A) ¶

Возвращает количество строк объекта A.

Это эквивалентно size (A, 1).

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

: n = numel (A) ¶

: n = 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.

: n = length (A) ¶

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

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

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

: sz = size (A) ¶

: dim_sz = size (A, dim) ¶

: dim_sz = size (A, d1, d2, …) ¶

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

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

При задании второго аргумента, dim, возвращает размер соответствующего измерения. Если dim является вектором, возвращает каждый из соответствующих измерений. Несколько измерений также могут быть указаны как отдельные аргументы.

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

Пример 1: строка-вектор с единственным выводом

size ([1, 2; 3, 4; 5, 6])
   ⇒ [ 3, 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.

: tf = isempty (A) ¶

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

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

: tf = isnull (x) ¶

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

Индексированное присваивание с таким нулевым значением в правой части должно удалять элементы массива. Эта функция используется вместо 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.

: sz = sizeof (val) ¶

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

См. также: whos.

: TF = size_equal (A, B) ¶

: TF = size_equal (A, B, …) ¶

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

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

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

: B = squeeze (A) ¶

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

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

См. также: reshape.