mustBeVector

Проверьте, что значение является вектором

    Описание

    пример

    mustBeVector(value) выдает ошибку, если value не является вектором. Вектор имеет размерность 1-by- n или n-by-1. Эта функция не возвращает значение.

    mustBeVector(value,"allow-all-empties") выдает ошибку, если value не является вектором или не является пустым массивом.

    mustBeVector вызывает следующую функцию, чтобы определить, является ли вход вектором:

    Поддержка классов: Все числовые классы, logical, и MATLAB® классы, которые перегружают isvector.

    Примеры

    свернуть все

    Определите, является ли значение строки или вектора-столбца.

    a = rand(2);
    mustBeVector(a)
    Value must be a 1-by-n vector or an n-by-1 vector.

    mustBeVector выдает ошибку, поскольку вход представляет собой массив 2 на 2.

    Измените форму значения a на вектор-строку.

    b = reshape(a,[1,numel(a)])
    mustBeVector(b)

    mustBeVector выполняется без выдачи ошибки или возврата значения.

    Используйте блок аргументов, чтобы ограничить входной параметр функции числовым вектором, используя mustBeVector и mustBeNumeric. Разрешить пустое значение, используя mustBeVector allow-all-empties опция.

    WeeklyTotals функция суммирует элементы входного вектора. Если вход пуст ([]), сумма возвращается как нуль.

    function r = WeeklyTotals(DailyTotals)
        arguments
            DailyTotals {mustBeVector(DailyTotals,'allow-all-empties'), mustBeNumeric}
        end
        if isempty(DailyTotals)
            r = 0;
        else
            r = sum(DailyTotals);
        end
    end

    Передача пустого значения функции разрешена.

    r = WeeklyTotals([])
    r = 
        0

    Входные параметры

    свернуть все

    Значение для проверки, заданное как строка или вектор-столбец.

    Совет

    • mustBeVector предназначен для использования в валидацию аргументов свойства и функции.

    Введенный в R2020b