12.2.1 Выдача предупреждений

Предупреждения можно выдать из любого кода, используя функцию warning. В самом простом виде функция warning принимает в качестве входного аргумента строку, описывающую предупреждение. Например, следующий код проверяет, является ли переменная «a» неотрицательной, и если нет, выдает предупреждение и устанавливает «a» в ноль.

a = -1;
if (a < 0)
  warning ("'a' must be non-negative.  Setting 'a' to zero.");
  a = 0;
endif
     -| 'a' must be non-negative.  Setting 'a' to zero.

Поскольку предупреждения не являются фатальными для работающей программы, невозможно перехватить предупреждение с помощью оператора try или аналогичного. Однако получить последнее предупреждение в виде строки можно с помощью функции lastwarn.

Также можно назначить идентификационную строку предупреждению. Если предупреждение имеет такой идентификатор, пользователь может включить или выключить это предупреждение, как будет описано в следующем разделе. Чтобы назначить идентификатор предупреждению, просто вызовите warning с двумя строковыми аргументами, где первый — идентификационная строка, а второй — само предупреждение. Обратите внимание, что идентификаторы предупреждений имеют формат "NAMESPACE:WARNING-NAME". Пространство имен "Octave" используется для собственных предупреждений Octave. Любая другая строка доступна в качестве пространства имен для собственных предупреждений пользователя.

: warning (шаблон, …) ¶

: warning (id, шаблон, …) ¶

: warning ("on", id) ¶

: warning ("off", id) ¶

: warning ("error", id) ¶

: warning ("query", id) ¶

: warning (состояние, id, "local") ¶

: warning (структура_предупреждения) ¶

: структура_предупреждения = warning (…) ¶

: warning (состояние, режим) ¶

Выводит сообщение о предупреждении или управляет поведением системы предупреждений Octave.

Первый вариант вызова использует шаблон шаблон и необязательные дополнительные аргументы для отображения сообщения в потоке stderr. Сообщение форматируется по тем же правилам, что и функции семейства printf (см. Форматированный вывод) и предваряется строкой «warning: ». Вы должны использовать эту функцию, когда хотите уведомить пользователя об необычном состоянии, но только в тех случаях, когда ваша программа может продолжить выполнение. Например:

warning ("foo: maybe something wrong here");

Если сообщение о предупреждении не заканчивается символом новой строки, Octave выведет трассировку всех вызовов функций, приведших к предупреждению. Если сообщение о предупреждении заканчивается символом новой строки, Octave подавит сообщения трассировки при возврате управления в верхний уровень. Для получения более подробной информации и примеров см. error.

Необязательный идентификатор предупреждения id позволяет пользователям включить или выключить предупреждения, помеченные этим идентификатором. Идентификатор сообщения — это строка в формате "NAMESPACE:WARNING-NAME". Собственные предупреждения Octave используют пространство имен "Octave" (см. warning_ids). Например:

warning ("MyNameSpace:check-something",
         "foo: maybe something wrong here");

Второй вариант вызова предназначен для изменения и/или запроса состояния предупреждений. Первый входной аргумент должен быть строкой состояние ("on", "off", "error", или "query") и необязательный идентификатор предупреждения id или "all" (по умолчанию).

Необязательный выходной аргумент структура_предупреждения представляет собой структуру или массив структур с полями "state" и "identifier". Аргумент состояние может иметь следующие значения:

"on"|"off":

Включить или выключить отображение предупреждений, идентифицированных id, и необязательно вернуть их предыдущее состояние stout.

"error":

Превратить предупреждения, идентифицированные id, в ошибки и необязательно вернуть их предыдущее состояние stout.

"query":

Возвращает текущее состояние предупреждений, идентифицированных id.

Структура или массив структур структура_предупреждения, с полями "state" и "identifier", может быть задан в качестве входного аргумента для достижения эквивалентных результатов. Следующий пример показывает, как временно отключить предупреждение, а затем восстановить его исходное состояние:

loglog (-1:10);
## Disable the previous warning and save its original state
[~, id] = lastwarn ();
warnstate = warning ("off", id);
loglog (-1:10);
## Restore its original state
warning (warnstate);

Если задан конечный аргумент "local", то состояние предупреждения будет установлено временно до конца текущей функции. Изменения состояния предупреждений, установленные локально, влияют на текущую функцию и все функции, вызываемые из текущей области видимости. Предыдущее состояние предупреждения восстанавливается при возврате из текущей функции. Опция "local" игнорируется, если используется в рабочем пространстве верхнего уровня.

Без входных аргументов warning () эквивалентно warning ("query", "all"), за исключением того, что в отсутствие выходного аргумента состояние предупреждений отображается в stderr.

Уровень подробности системы предупреждений также может контролироваться с помощью двух режимов режим:

"backtrace":

включить/выключить отображение трассировки стека после сообщения о предупреждении

"verbose":

включить/выключить отображение дополнительной информации после сообщения о предупреждении

В этом случае аргумент состояние может быть только "on" или "off".

Примечание об реализации: для совместимости с MATLAB, управляющие последовательности в шаблоне (например, "\n" => новая строка) обрабатываются независимо от того, определен ли шаблон с одинарными кавычками, если есть два или более входных аргумента. Чтобы отключить расширение управляющих последовательностей, используйте два обратных слеша перед последовательностью (например, "\\n") или используйте функцию regexptranslate.

См. также: warning_ids, lastwarn, error.

: [сообщение, идентификатор_сообщения] = lastwarn () ¶

: lastwarn (сообщение) ¶

: lastwarn (сообщение, идентификатор_сообщения) ¶

Запрос или установка последнего сообщения о предупреждении.

При вызове без входных аргументов возвращает последнее сообщение о предупреждении и идентификатор сообщения.

С одним аргументом устанавливает последнее сообщение о предупреждении на сообщение.

С двумя аргументами также устанавливает идентификатор последнего сообщения.

См. также: warning, lasterror, lasterr.

Функции, поставляемые с Octave, могут выдать одно из следующих предупреждений.

Octave:abbreviated-property-match

Если предупреждение Octave:abbreviated-property-match включено, выводится предупреждение, если для операции, задающей свойство объекта, используется неточная или неоднозначная совпадающая сопоставление. Например, для объекта графики fig со свойством 'displayname', get (fig, 'dis') выводит предупреждение, если предупреждение Octave:abbreviated-property-match включено. По умолчанию, предупреждение Octave:abbreviated-property-match включено.

Octave:addpath-pkg

Если предупреждение Octave:addpath-pkg включено, Octave выведет предупреждение, когда каталог пакета (т.е., +имя_пакета) добавляется в path. Обычно, в путь загрузки следует добавлять только родительский каталог, содержащий каталог пакета. По умолчанию, предупреждение Octave:addpath-pkg включено.

Octave:array-as-logical

Если предупреждение Octave:array-as-logical включено, Octave выдаст предупреждение, когда массив размером больше 1x1 используется в качестве значения истинности в операторах if, while или until. По умолчанию, предупреждение Octave:array-as-logical отключено.

Octave:array-to-scalar

Если предупреждение Octave:array-to-scalar включено, Octave выведет предупреждение при попытке неявного преобразования массива в скалярное значение. По умолчанию, предупреждение Octave:array-to-scalar отключено.

Octave:array-to-vector

Если предупреждение Octave:array-to-vector включено, Octave выведет предупреждение при попытке неявного преобразования массива в векторное значение. По умолчанию, предупреждение Octave:array-to-vector отключено.

Octave:assign-as-truth-value

Если предупреждение Octave:assign-as-truth-value включено, будет выдано предупреждение для операторов, подобных

if (s = t)
  …

поскольку такие операторы не являются распространёнными, и, вероятно, предполагалось написание

if (s == t)
  …

вместо этого.

Иногда полезно писать код, содержащий присваивания внутри условия оператора while или if . Например, операторы, такие как

while (c = getc ())
  …

являются распространёнными в программировании на языке C.

Можно избежать всех предупреждений об таких операторах, отключив предупреждение Octave:assign-as-truth-value, но это может также пропустить реальные ошибки, например,

if (x = 1)  # intended to test (x == 1)!
  …

.

В таких случаях можно подавить предупреждения для определённых операторов, записав их с дополнительной парой скобок. Например, записав предыдущий пример как

while ((c = getc ()))
  …

предотвратит вывод предупреждения для данного оператора, при этом позволяя Octave выводить предупреждения для других присваиваний, используемых в контексте условий.

По умолчанию, предупреждение Octave:assign-as-truth-value включено.

Octave:autoload-relative-file-name

Если предупреждение Octave:autoload-relative-file-name включено, Octave выведет предупреждение при обработке вызовов функций autoload() с относительными путями к файлам функций. Это обычно происходит при использовании вызовов autoload() в файлах PKG_ADD, когда файл PKG_ADD не находится в той же директории, что и файл .oct, на который ссылается команда autoload(). По умолчанию, предупреждение Octave:autoload-relative-file-name включено.

Octave:charmat-truncated

Если предупреждение Octave:charmat-truncated включено, при преобразовании матрицы символов с несколькими строками в строку выводится предупреждение. В этом случае интерпретатор Octave сохраняет только первую строку и отбрасывает остальные. По умолчанию, предупреждение Octave:charmat-truncated включено.

Octave:classdef-to-struct

Если предупреждение Octave:classdef-to-struct включено, выдаётся предупреждение, когда объект classdef принудительно преобразуется в структуру с struct (CLASSDEF_OBJ). Преобразование удаляет ограничения доступа к объекту и делает частные и защищённые свойства видимыми. По умолчанию, предупреждение Octave:classdef-to-struct включено.

Octave:colon-complex-argument

Если предупреждение Octave:colon-complex-argument включено, выдается предупреждение, когда один из трех аргументов оператора двоеточия (начало, приращение, предел) является комплексным значением. Например, 1:3*i вызовет вывод предупреждения. По умолчанию, предупреждение Octave:colon-complex-argument включено.

Octave:colon-nonscalar-argument

Если предупреждение Octave:colon-nonscalar-argument включено, выдается предупреждение, когда один из трех аргументов оператора двоеточия (начало, приращение, предел) не является скаляром. Например, 1:[3, 5] вызовет вывод предупреждения. По умолчанию, предупреждение Octave:colon-nonscalar-argument включено.

Octave:data-file-in-path

Если предупреждение Octave:data-file-in-path включено, выдается предупреждение, когда Octave не находит целевого файла при операциях с файлами, таких как load или fopen, но может найти файл в списке поиска Octave path для файлов. Предупреждение может указывать на использование целевого файла, отличного от предполагаемого программистом. По умолчанию, предупреждение Octave:data-file-in-path включено.

Octave:deprecated-function

Если предупреждение Octave:deprecated-function включено, Octave выведет предупреждение при обнаружении устаревшей функции, запланированной на удаление из Octave. По умолчанию, предупреждение Octave:deprecated-function включено.

Octave:deprecated-keyword

Если предупреждение Octave:deprecated-keyword включено, выдается предупреждение, когда Octave обнаруживает устаревший ключевой слово, запланированный на удаление из Octave. По умолчанию, предупреждение Octave:deprecated-keyword включено.

Octave:deprecated-option

Если предупреждение Octave:deprecated-option включено, выдаётся предупреждение при использовании устаревшего параметра или входных данных для функции. По умолчанию, предупреждение Octave:deprecated-option включено.

Octave:deprecated-property

Если предупреждение Octave:deprecated-property включено, выводится предупреждение при обнаружении устаревшего свойства графики, запланированного на удаление из Octave. По умолчанию, предупреждение Octave:deprecated-property включено.

Octave:eigs:UnconvergedEigenvalues

Если предупреждение Octave:eigs:UnconvergedEigenvalues включено, функция eigs выдаст предупреждение, если количество вычисленных собственных значений меньше, чем количество запрашиваемых собственных значений. По умолчанию, предупреждение Octave:eigs:UnconvergedEigenvalues включено.

Octave:empty-index

Если предупреждение Octave:empty-index включено, Octave выведет предупреждение при использовании операторов индексирования без индекса, например, x(). По умолчанию, предупреждение Octave:empty-index включено.

Octave:erase:chararray

Если предупреждение Octave:erase:chararray включено, функция erase выдаст предупреждение, если входной шаблон является матрицей символов, а не строкой или массивом ячеек строк. По умолчанию, предупреждение Octave:erase:chararray включено.

Octave:function-name-clash

Если предупреждение Octave:function-name-clash включено, выдается предупреждение, когда Octave обнаруживает, что имя функции, определенной в файле функции, отличается от имени файла. (Если имена не совпадают, имя, объявленное внутри файла, игнорируется.) По умолчанию, предупреждение Octave:function-name-clash включено.

Octave:future-time-stamp

Если предупреждение Octave:future-time-stamp включено, Octave выведет предупреждение, если обнаружит файл функции с отметкой времени, находящейся в будущем. По умолчанию, предупреждение Octave:future-time-stamp включено.

Octave:glyph-render

Если предупреждение Octave:glyph-render включено, Octave выведет предупреждение, если глиф для символа не может быть отображён текущим шрифтом. По умолчанию, предупреждение Octave:glyph-render включено.

Octave:imag-to-real

Если предупреждение Octave:imag-to-real включено, выводится предупреждение о неявных преобразованиях комплексных чисел в вещественные числа. По умолчанию, предупреждение Octave:imag-to-real отключено.

Octave:infinite-loop

Если предупреждение Octave:infinite-loop включено, выводится предупреждение при обнаружении бесконечного цикла, например, for i = 1:Inf или while (1). По умолчанию, предупреждение Octave:infinite-loop включено.

Octave:language-extension

Выводить предупреждения при использовании функций, уникальных для языка Octave, которые могут отсутствовать в MATLAB. По умолчанию, предупреждение Octave:language-extension отключено. Также могут быть полезны параметры запуска Octave --traditional или --braindead, см. Параметры командной строки.

Octave:legacy-function

Если предупреждение Octave:legacy-function включено, выдаётся предупреждение, когда Octave обнаруживает функцию, которую MATLAB предложил избегать. Функция может стать устаревшей в будущем и быть удалена, в этом случае предупреждение изменится на Octave:deprecated-function, и функция будет существовать ещё в течение двух последующих версий Octave, прежде чем быть удалена. По умолчанию, предупреждение Octave:legacy-function включено.

Octave:logical-conversion

Если предупреждение Octave:logical-conversion включено, выводится предупреждение, если происходит неявное преобразование массива из числового в булево, и какие-либо элементы массива не равны нулю или единице. По умолчанию, предупреждение Octave:logical-conversion включено.

Octave:lu:sparse_input

Если предупреждение Octave:lu:sparse_input включено, Octave выведет предупреждение при вызове функции lu с разреженным входом и менее четырьмя выходными аргументами. В этом случае сохраняющие разреженность перестановки столбцов не выполняются, и результат может быть неточным. По умолчанию, предупреждение Octave:lu:sparse_input включено.

Octave:missing-glyph

Если предупреждение Octave:glyph-render включено, Octave выведет предупреждение, если текущий шрифт не предоставляет глиф для используемого символа. По умолчанию, предупреждение Octave:missing-glyph включено.

Octave:missing-semicolon

Если предупреждение Octave:missing-semicolon включено, Octave выведет предупреждение, если операторы в определениях функций не заканчиваются точкой с запятой. По умолчанию, предупреждение Octave:missing-semicolon отключено.

Octave:mixed-string-concat

Если предупреждение Octave:mixed-string-concat включено, выводится предупреждение при конкатенации смешанных одинарных и двойных кавычек. По умолчанию, предупреждение Octave:mixed-string-concat отключено.

Octave:nearly-singular-matrix

Octave:singular-matrix

Эти предупреждения выводятся, если матрица (почти) вырожденная обращается. По умолчанию, предупреждения Octave:nearly-singular-matrix и Octave:singular-matrix включены.

Octave:neg-dim-as-zero

Если предупреждение Octave:neg-dim-as-zero включено, выводится предупреждение для выражений, таких как

eye (-1)

По умолчанию предупреждение Octave:neg-dim-as-zero отключено.

Octave:noninteger-range-as-index

Если предупреждение Octave:noninteger-range-as-index включено, выводится предупреждение, если массив индексируется диапазоном, содержащим нецелые значения. Например,

a = [1 2 3 4 5];
b = 2.2:4.2
⇒ 1.2  2.2  3.2
a(b)
⇒ 2 3 4

вызывает предупреждение, если включено предупреждение Octave:noninteger-range-as-index. По умолчанию предупреждение Octave:noninteger-range-as-index включено.

Octave:num-to-str

Если предупреждение Octave:num-to-str включено, выводится предупреждение при неявном преобразовании чисел в их эквиваленты UTF-8 кодированных символов, когда строки создаются с использованием смеси строк и чисел в матричной записи. Например,

[ "f", 111, 111 ]
⇒ "foo"

вызывает предупреждение, если включено предупреждение Octave:num-to-str. По умолчанию предупреждение Octave:num-to-str включено.

Octave:possible-matlab-short-circuit-operator

Если предупреждение Octave:possible-matlab-short-circuit-operator включено, Octave выведет предупреждение об использовании некраткозамкнутых операторов & и | внутри if или while условий. Обычно они никогда не кратко замыкаются, но они кратко замыкаются, когда используются в условии. По умолчанию предупреждение Octave:possible-matlab-short-circuit-operator включено.

Octave:recursive-path-search

Если предупреждение Octave:recursive-path-search включено, Octave выведет предупреждение, если addpath используется с двойными обратными слешами. По умолчанию предупреждение Octave:recursive-path-search включено.

Octave:remove-init-dir

Функция path изменяет путь поиска, который Octave использует для поиска функций. Можно установить путь к значению, которое исключает собственные встроенные функции Octave. Если предупреждение Octave:remove-init-dir включено, Octave выведет предупреждение, когда функция path была использована таким образом, что это может сделать Octave неработоспособным. По умолчанию предупреждение Octave:remove-init-dir включено.

Octave:reload-forces-clear

Если несколько функций были загружены из одного файла, Octave должен очистить все функции, прежде чем любая из них может быть перезагружена. Если предупреждение Octave:reload-forces-clear включено, Octave предупредит вас об этом и выведет список дополнительных функций, которые он вынужден очистить. По умолчанию предупреждение Octave:reload-forces-clear включено.

Octave:separator-insert

Выводить предупреждение, если запятые или точки с запятой могут быть автоматически вставлены в литеральные матрицы. По умолчанию предупреждение Octave:separator-insert отключено.

Octave:shadowed-function

Если предупреждение Octave:shadowed-function включено, Octave выведет предупреждение, если к пути поиска добавлен путь, содержащий функции, которые скрывают ядровые функции. По умолчанию предупреждение Octave:shadowed-function включено.

Octave:single-quote-string

Выводить предупреждение, если символ одиночной кавычки используется для ввода строковой константы. По умолчанию предупреждение Octave:single-quote-string отключено.

Octave:sqrtm:SingularMatrix

Если предупреждение Octave:sqrtm:SingularMatrix включено, выводится предупреждение, если функция квадратного корня матрицы sqrtm вызывается с матрицей ввода, которая является сингулярной. По умолчанию предупреждение Octave:sqrtm:SingularMatrix включено.

Octave:str-to-num

Если предупреждение Octave:str-to-num включено, выводится предупреждение при неявном преобразовании строк в их числовые последовательности байтов UTF-8. Например,

"abc" + 0
⇒ 97 98 99

вызывает предупреждение, если включено предупреждение Octave:str-to-num. По умолчанию предупреждение Octave:str-to-num отключено.

Octave:LaTeX:internal-error

Если предупреждение Octave:LaTeX:internal-error включено, выводится предупреждение всякий раз, когда рендерер LaTeX для текста на графиках сталкивается с проблемой. По умолчанию предупреждение Octave:LaTeX:internal-error включено.

Octave:unimplemented-matlab-functionality

Если предупреждение Octave:unimplemented-matlab-functionality включено, выводится предупреждение, когда используется конструкция кода MATLAB, которую интерпретатор Octave анализирует как корректную, но для которой Octave еще не реализовал функциональность. По умолчанию предупреждение Octave:unimplemented-matlab-functionality включено.

Octave:variable-switch-label

Если предупреждение Octave:variable-switch-label включено, Octave выведет предупреждение, если метка переключателя не является константой или выражением константы. По умолчанию предупреждение Octave:variable-switch-label отключено.