mustBeUnderlyingType

Verifica se um array tem a classe subjacente indicada.

Categoria: Programming > Functions

Sintaxe

mustBeUnderlyingType(A, typename)

Verifica se a classe subjacente de A é igual a typename. Não retorna nada se a verificação passa e lança um erro se não passa.

Descrição

mustBeUnderlyingType é um validador: examina a entrada e retorna em silêncio ou lança um erro com o identificador MATLAB:validators:mustBeUnderlyingType. A mensagem de erro informa o requisito violado, de modo que quem chama vê o que era esperado em vez de uma falha genérica.

Diferente de mustBeA, conta apenas a classe subjacente exata, sem considerar herança. Para arrays nativos comuns, a classe subjacente é simplesmente class(A).

Argumentos de entrada

A
O valor a verificar. Qualquer array da classe que o validador aceita.
typename
Nome da classe como texto. Vários nomes podem ser dados em um cell array.

Exemplo

Entrada válida e inválida

mustBeUnderlyingType(int8(1), 'int8');
disp('passed')
try
    mustBeUnderlyingType(int8(1), 'double')
catch err
    disp(err.message)
end
Saída
passed
Value must have underlying type 'double'.

Veja também

mustBeA class isa mustBeNumeric