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

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