Exponenta Banner
exponenta event banner

mustBeUnderlyingType

Проверить, что значение имеет указанный базовый тип

свернуть все на странице

Синтаксис

mustBeTaxType (значение, имя типа)

Описание

пример

mustBeUnderlyingType(value,typename) выдает ошибку, если value не имеет базового типа данных typename. Эта функция не возвращает значение.

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

Поддержка классов: все классы MATLAB ®

Примеры

свернуть все

Использовать mustBeUnderlyingType для проверки того, что входные данные имеют базовый тип double.

Создать distributed массив (требуется Parallel Computing Toolbox™), а затем проверьте, что базовым типом данных является double.

x = distributed(single(1:10));
mustBeUnderlyingType(x,"double")
Starting parallel pool (parpool) using the 'local' profile ...
Connected to the parallel pool (number of workers: 6).
Value must have underlying type 'double'.

mustBeUnderlyingType выдает ошибку, поскольку базовым типом распределенного массива является single.

Использовать mustBeUnderlyingType для ограничения значений входных аргументов, принятых функцией. Для этого можно добавить arguments блок функции, проверяющей входные аргументы.

Эта функция объявляет один входной аргумент. В arguments блок, вход должен иметь базовый тип данных single.

function y = mbSingle(input)
    arguments
        input {mustBeUnderlyingType(input,"single")}
    end

    disp("Input is class " + class(input) + ...
        " with underlying type " + underlyingType(input) + ".")
end

Вызовите функцию с помощью distributed вектор (требуется панель инструментов параллельных вычислений), имеющий базовые данные типа single. Поскольку входные данные проходят проверку аргумента, mbSingle функция печатает информацию о классе и базовом типе.

x = distributed(single(1:10));
mbSingle(x)
Starting parallel pool (parpool) using the 'local' profile ...
Connected to the parallel pool (number of workers: 6).
Input is class distributed with underlying type single.

Входные аргументы

свернуть все

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

Пример: mustBeUnderlyingType(magic(4),"single")

Имя проверяемого типа данных, заданного как вектор символов или скаляр строки.

Пример: mustBeUnderlyingType(X,"double") выдает ошибку X не имеет базового типа double.

Типы данных: char | string

Совет

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

Расширенные возможности

См. также

| | |

Темы

Представлен в R2020b

Документация MATLAB

Поддержка