`mustBeReal`

Verifica se um valor não tem parte imaginária.

Sintaxe

mustBeReal(A)

Verifica se A contém apenas valores reais. Não retorna nada se a verificação passa e lança um erro se não passa.

Descrição

mustBeReal é um validador: examina a entrada e retorna em silêncio ou lança um erro com o identificador MATLAB:validators:mustBeReal. 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.

Um array complexo cujas partes imaginárias são todas zero é armazenado como real pelas regras do MATLAB e, portanto, passa.

Argumentos de entrada

A: O valor a verificar. Qualquer array da classe que o validador aceita.

Exemplo

Entrada válida e inválida

mustBeReal([1 2 3]);
disp('passed')
try
    mustBeReal(1 + 2i)
catch err
    disp(err.message)
end

Saída

passed
Value must be real.

Veja também

isreal real imag mustBeNumeric