6.1.4 Обработка структур ¶

Ниже приведены другие функции, которые могут манипулировать полями структуры.

: n = numfields (s) ¶

Возвращает количество полей структуры s.

См. также: fieldnames.

: names = fieldnames (struct) ¶

: names = fieldnames (obj) ¶

: names = fieldnames (javaobj) ¶

: names = fieldnames ("javaclassname") ¶

Возвращает ячейковый массив строк с именами полей в указанном вводе.

Когда вводом является структура struct, names являются элементами структуры.

Когда вводом является объект Octave obj, names являются открытыми свойствами объекта.

Когда вводом является объект Java javaobj или строка, содержащая имя класса Java javaclassname, names являются открытыми полями (данными членами) объекта или класса.

См. также: numfields, isfield, orderfields, struct, свойства.

: tf = isfield (x, "name") ¶

: tf = isfield (x, name) ¶

Возвращает true, если x является структурой и содержит элемент с именем name.

Если name является ячейковым массивом строк, то возвращается логический массив с теми же размерами.

См. также: fieldnames.

: sout = setfield (s, field, val) ¶

: sout = setfield (s, sidx1, field1, fidx1, sidx2, field2, fidx2, …, val) ¶

Возвращает копию структуры s с членом поля field, установленным в значение val.

Например:

s = struct ();
s = setfield (s, "foo bar", 42);

Это эквивалентно

s.("foo bar") = 42;

Обратите внимание, что обычная синтаксическая запись структур s.foo bar = 42 здесь использовать нельзя, поскольку имя поля не является допустимым идентификатором Octave из-за пробела. Использование произвольных строк в качестве имён полей несовместимо с MATLAB, и при включенном идентификаторе предупреждения Octave:language-extension это использование вызовет предупреждение. См. warning_ids.

С помощью второй формы вызова установите поле массива структур. Входной параметр sidx выбирает элемент массива структур, field указывает имя поля выбранного элемента, а fidx выбирает элемент поля (в случае массива или ячейкового массива). Входные параметры sidx, field и fidx могут повторяться для адресации вложенных элементов массива структур. Индекс массива структур и индекс элемента поля должны быть ячейковыми массивами, а имя поля должно быть строкой.

Например:

s = struct ("baz", 42);
setfield (s, {1}, "foo", {1}, "bar", 54)
⇒
  ans =
    scalar structure containing the fields:
      baz =  42
      foo =
        scalar structure containing the fields:
          bar =  54

Пример начинается с обычной скалярной структуры, к которой добавляется вложенная скалярная структура. Во всех случаях, если индекс структуры sidx не указан, он по умолчанию равен 1 (скалярная структура). Таким образом, пример выше можно записать более кратко как setfield (s, "foo", "bar", 54)

Наконец, пример с вложенными массивами структур:

sa.foo = 1;
sa = setfield (sa, {2}, "bar", {3}, "baz", {1, 4}, 5);
sa(2).bar(3)
⇒
  ans =
    scalar structure containing the fields:
      baz =  0   0   0   5

Здесь sa является массивом структур, чьё поле в элементах 1 и 2, в свою очередь, является другим массивом структур, третий элемент которого — простая скалярная структура. В терминальной скалярной структуре есть поле, содержащее матричное значение.

Обратите внимание, что тот же результат, что и в примере выше, можно получить следующим образом:

sa.foo = 1;
sa(2).bar(3).baz(1,4) = 5

См. также: getfield, rmfield, orderfields, isfield, fieldnames, isstruct, struct.

: val = getfield (s, field) ¶

: val = getfield (s, sidx1, field1, fidx1, …) ¶

Получение значения поля с именем field из структуры или вложенной структуры s.

Если s является массивом структур, то sidx выбирает элемент массива структур, field указывает имя поля выбранного элемента, а fidx выбирает элемент поля (в случае массива или ячейкового массива). Более подробное описание синтаксиса см. в setfield.

См. также: setfield, rmfield, orderfields, isfield, fieldnames, isstruct, struct.

: sout = rmfield (s, "f") ¶

: sout = rmfield (s, f) ¶

Возвращает копию структуры (массива) s с удалённым полем f.

Если f является ячейковым массивом строк или символьной строкой, удаляются все указанные поля.

См. также: orderfields, fieldnames, isfield.

: sout = orderfields (s1) ¶

: sout = orderfields (s1, s2) ¶

: sout = orderfields (s1, {cellstr}) ¶

: sout = orderfields (s1, p) ¶

: [sout, p] = orderfields (…) ¶

Возвращает копию s1 с полями, упорядоченными по алфавиту или как указано во втором аргументе.

При одном входном аргументе структуры s1 имена полей упорядочиваются по алфавиту.

Если задан второй аргумент, то имена полей в s1 упорядочиваются так, как они появляются в s2. Второй аргумент также может указывать порядок в ячейном массиве строк cellstr. Второй аргумент также может быть вектором перестановок.

Необязательный второй выходной аргумент p — это вектор перестановок, преобразующий исходный порядок имен в новый.

Примеры:

s = struct ("d", 4, "b", 2, "a", 1, "c", 3);
t1 = orderfields (s)
  ⇒ t1 =
       scalar structure containing the fields:
         a =  1
         b =  2
         c =  3
         d =  4

t = struct ("d", {}, "c", {}, "b", {}, "a", {});
t2 = orderfields (s, t)
  ⇒ t2 =
       scalar structure containing the fields:
         d =  4
         c =  3
         b =  2
         a =  1

t3 = orderfields (s, [3, 2, 4, 1])
  ⇒ t3 =
       scalar structure containing the fields:
         a =  1
         b =  2
         c =  3
         d =  4

[t4, p] = orderfields (s, {"d", "c", "b", "a"})
  ⇒ t4 =
       scalar structure containing the fields:
         d =  4
         c =  3
         b =  2
         a =  1
     p =
        1
        4
        2
        3

См. также: fieldnames, getfield, setfield, rmfield, isfield, isstruct, struct.

: s = substruct (type, subs, …) ¶

Создает структуру индексации для использования с subsref или subsasgn.

Например:

idx = substruct ("()", {3, ":"})
  ⇒ idx =
       scalar structure containing the fields:
         type = ()
         subs =
         {
           [1,1] =  3
           [1,2] = :
         }
x = [1, 2, 3;
     4, 5, 6;
     7, 8, 9];
subsref (x, idx)
  ⇒   7   8   9

Примечание: ключевое слово end не может использоваться в subsref или subsasgn для операций присваивания индексов.

См. также: subsref, subsasgn.