Проверяйте валидность массива
validateattributes(
подтверждает тот массив A
,classes
,attributes
)A
принадлежит по крайней мере одному из заданных классов (или его подкласс) и имеет все заданные атрибуты. Если A
не соответствует критериям, затем MATLAB® выдает ошибку и отображает отформатированное сообщение об ошибке. В противном случае, validateattributes
завершается, не отображая вывода.
validateattributes(
включает положение входа в вашем списке аргументов функции как часть любых сгенерированных сообщений об ошибке.A
,classes
,attributes
,argIndex
)
validateattributes(
включает заданное имя функции в сгенерированные ошибочные идентификаторы.A
,classes
,attributes
,funcName
)
validateattributes(
включает заданное имя переменной в сгенерированные сообщения об ошибке.A
,classes
,attributes
,funcName
,varName
)
classes = {'numeric'}; attributes = {'size',[4,6,2]}; A = rand(3,5,2); validateattributes(A,classes,attributes)
Expected input to be of size 4x6x2 when it is actually size 3x5x2.
Поскольку A
не совпадал с заданными атрибутами, MATLAB выдает сообщение об ошибке.
Определите, увеличивается ли массив или не уменьшается.
A = [1 5 8 2; 9 6 9 4] validateattributes(A, {'double'},{'nondecreasing'}) validateattributes(A, {'double'},{'increasing'})
A = 1 5 8 2 9 6 9 4
Начиная с A
и увеличивается и не уменьшается, validateattributes
не выдает ошибку ни для одной проверки атрибута.
Установка A(2,3)
равняйтесь A(1,3)
результаты в столбце, который строго больше не увеличивается, таким образом, validateattributes
выдает ошибку.
A(2,3) = 8 validateattributes(A, {'double'},{'increasing'})
A = 1 5 8 2 9 6 8 4 Expected input to be strictly increasing.
Однако столбцы остаются неуменьшающимися, поскольку каждый элемент столбца равен или больше, чем предыдущий элемент столбца. Следующий код не выдает ошибку.
validateattributes(A, {'double'},{'nondecreasing'})
Принятие, что a
второй входной параметр к функции, проверяйте, что это неотрицательно.
a = complex(1,1); validateattributes(a,{'numeric'},{'nonnegative'},2)
Expected input number 2 to be nonnegative.
Поскольку комплексные числа испытывают недостаток в четко определенном упорядоченном расположении в комплексной плоскости, validateattributes
не распознает их положительными или отрицательными.
Проверяйте, что значения в массиве являются 8-битными целыми числами от 0 до 10.
Примите, что этот код происходит в функции под названием Rankings
.
classes = {'uint8','int8'}; attributes = {'>',0,'<',10}; funcName = 'Rankings'; A = int8(magic(4)); validateattributes(A,classes,attributes,funcName)
Error using Rankings Expected input to be an array with all of the values < 10.
Проверка Параметров Входного параметра функции Используя inputParser
Создайте пользовательскую функцию, которая проверяет входные параметры с inputParser
, и используйте validateattributes
как проверка функционируют для addRequired
и addOptional
методы.
Задайте функцию.
function a = findArea(shape,dim1,varargin) p = inputParser; charchk = {'char'}; numchk = {'numeric'}; nempty = {'nonempty'}; addRequired(p,'shape',@(x)validateattributes(x,charchk,nempty)) addRequired(p,'dim1',@(x)validateattributes(x,numchk,nempty)) addOptional(p,'dim2',1,@(x)validateattributes(x,numchk,nempty)) parse(p,shape,dim1,varargin{:}) switch shape case 'circle' a = pi * dim1.^2; case 'rectangle' a = dim1 .* p.Results.dim2; end end
Вызовите функцию с нечисловым третьим входом.
myarea = findArea('rectangle',3,'x')
Error using findArea (line 10) The value of 'dim2' is invalid. Expected input to be one of these types: double, single, uint8, uint16, uint32, uint64, int8, int16, int32, int64
Проверяйте входные параметры функции и включайте информацию о входном имени и положении по сгенерированной ошибке.
Задайте функцию.
function v = findVolume(shape,ht,wd,ln) validateattributes(shape,{'char'},{'nonempty'},mfilename,'Shape',1) validateattributes(ht,{'numeric'},{'nonempty'},mfilename,'Height',2) validateattributes(wd,{'numeric'},{'nonempty'},mfilename,'Width',3) validateattributes(ln,{'numeric'},{'nonempty'},mfilename,'Length',4)
Вызовите функцию без shape
входной параметр.
vol = findVolume(10,7,4)
Error using findVolume Expected input number 1, Shape, to be one of these types: char Instead its type was double. Error in findVolume (line 2) validateattributes(shape,{'char'},{'nonempty'},mfilename,'Shape',1)
Имя функции становится частью ошибочного идентификатора.
MException.last.identifier
ans = MATLAB:findVolume:invalidType
A
входной параметрВведите в виде любого типа массива.
Типы данных: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| logical
| char
| string
| struct
| cell
| function_handle
Поддержка комплексного числа: Да
classes
— Допустимые типы данныхДопустимые типы данных в виде вектора символов, массива ячеек из символьных векторов или массива строк. Каждый элемент classes
может быть имя любого встроенного или пользовательского класса, включая:
'single' | Номер с одинарной точностью |
'double' | Номер с двойной точностью |
'int8' | 8-битное целое число со знаком |
'int16' | 16-битное целое число со знаком |
'int32' | 32-битное целое число со знаком |
'int64' | 64-битное целое число со знаком |
'uint8' | 8-битное целое число без знака |
'uint16' | 16-битное целое число без знака |
'uint32' | 32-битное целое число без знака |
'uint64' | 64-битное целое число без знака |
'logical' | Логический 1 TRUE ) или 0 ложь ) |
'char' | Символ |
'string' | Массив строк |
'struct' | Массив структур |
'cell' | CellArray |
'table' | Таблица |
'function_handle' | Указатель на функцию |
'numeric' | Любой тип данных, для который isa(A,'numeric') функция возвращается верный, включая int8 int16 int32 int64 uint8 uint16 uint32 uint64 единственный , или double |
'< | Любое другое имя класса |
Типы данных: cell
| string
attributes
— Допустимые атрибутыДопустимые атрибуты в виде массива ячеек или массива строк.
Некоторые атрибуты также требуют числовых значений, таких как атрибуты, которые задают размер или число элементов A
. Для этих атрибутов числовое значение или вектор должны сразу следовать за названием атрибута в массиве ячеек. Массив строк не может использоваться, чтобы представлять числовые значения в attributes
.
Эти атрибуты описывают размер и форму массива A
.
'2d' | Двумерный массив, включая скаляры, векторы, матрицы и пустые массивы |
'3d' | Массив с тремя или меньшим количеством размерностей |
'column' | Вектор-столбец, N - 1 |
'row' | Вектор-строка, 1 N |
'scalar' | Скалярное значение, 1 на 1 |
'scalartext' | Или строковый скаляр или вектор символов, включая входные параметры с нулевыми символами |
'vector' | Строка или вектор-столбец или скалярное значение |
'size', [d1,...,dN] | Массив с размерностями d1 -...-by- dN . Чтобы пропустить проверку конкретной размерности, задайте NaN для той размерности, такой как [3,4,NaN,2] . |
'numel', N | Массив с N элементы |
'ncols', N | Массив с N столбцы |
'nrows', N | Массив с N 'Строки' |
'ndims', N | N - размерный массив |
'square' | Квадратная матрица; другими словами, двумерный массив с равным количеством строк и столбцов |
'diag' | Диагональная матрица |
'nonempty' | Никакие размерности тот равный нуль |
'nonsparse' | Массив, который не разрежен |
Эти атрибуты указывают допустимые диапазоны для значений в A
.
'>', N | Все значения, больше, чем N |
'>=', N | Все значения, больше, чем или равный N |
'<', N | Все значения меньше, чем N |
'<=', N | Все значения, меньше чем или равные N |
'finite' | Все значения конечны |
'nonnan' | Никакими значениями не является NaN (Не Номер) |
Эти атрибуты проверяют типы значений в числовом или логическом массиве, A
.
'binary' | Массив единиц и нулей |
'even' | Массив даже целых чисел (включает нуль), |
'odd' | Массив нечетных целых чисел |
'integer' | Массив целочисленных значений |
'real' | Массив действительных значений |
'nonnegative' | Никакой элемент не меньше нуля |
'nonzero' | Никакой элемент не равен нулю |
'positive' | Никакой элемент не меньше чем или равен нулю |
'decreasing' | Каждый элемент столбца меньше предыдущего элемента, и никаким элементом не является NaN . |
'increasing' | Каждый элемент столбца больше предыдущего элемента, и никаким элементом не является NaN . |
'nondecreasing' | Каждый элемент столбца больше или равен предыдущему элементу, и никаким элементом не является NaN . |
'nonincreasing' | Каждый элемент столбца меньше чем или равен предыдущему элементу, и никаким элементом не является NaN . |
Типы данных: cell
funcName
— Имя функции для валидацииИмя функции для валидации в виде вектора символов или как строковый скаляр. Если вы задаете пустой символьный вектор, ''
, или <missing>
представьте в виде строки, затем validateattributes
функция игнорирует funcName
входной параметр.
Типы данных: char |
string
varName
— Имя входной переменнойИмя входной переменной в виде вектора символов или строкового скаляра. Если вы задаете пустой символьный вектор, ''
, или <missing>
представьте в виде строки, затем validateattributes
функция игнорирует varName
входной параметр.
Типы данных: char |
string
argIndex
— Положение входного параметраПоложение входного параметра в виде положительного целого числа.
Типы данных: double
Указания и ограничения по применению:
Некоторые сообщения об ошибке являются упрощенной версией сообщения об ошибке MATLAB.
classes
funcName
varName
, и argIndex
аргументы должны быть постоянными.
Названия атрибута должны быть постоянными.
В сгенерированном коде формат чисел в сообщении об ошибке может отличаться от формата в MATLAB. Например, вот сообщение об ошибке в MATLAB:
Expected input to be an array with all of the values > 3.
Вот сообщение об ошибке в сгенерированном коде:
Expected input to be an array with all of the values > 3.000000000000000e+00.
Эта функция полностью поддерживает массивы графического процессора. Для получения дополнительной информации смотрите функции MATLAB Запуска на графическом процессоре (Parallel Computing Toolbox).
Эта функция полностью поддерживает распределенные массивы. Для получения дополнительной информации смотрите функции MATLAB Запуска с Распределенными Массивами (Parallel Computing Toolbox).
arguments
| inputParser
| is*
| isa
| isnumeric
| validatestring
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.