Exponenta Banner
exponenta event banner

mustBeReal

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

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

Синтаксис

mustBeReal (значение)

Описание

пример

mustBeReal(value) выдает ошибку, если value не является действительным числом. Эта функция не возвращает значение.

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

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

Эта функция игнорирует входные аргументы, которые являются пустыми значениями. Поэтому при пустом значении аргумента свойства или функции ошибка не возникает.

Примеры

свернуть все

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

Проверьте, что вычисление приводит к реальным числам.

x = -2:2;
z = x.^exp(-x.^2);
mustBeReal(z)
Error using mustBeReal (line 13)
values must be real.

Стоимость z является сложным.

Этот класс ограничивает значение Prop1 к реальным значениям.

classdef MyClass
   properties
      Prop1 {mustBeReal}
   end
end

Создайте объект и назначьте ему значение.

x = -2:0.1:2;
obj = MyClass;
obj.Prop1 = x.^exp(-x.^2);
Error setting 'Prop1' property of 'MyClass' class:
values must be real.

При назначении значения свойству вызов MATLAB mustBeReal со значением, назначенным свойству. mustBeReal выдает ошибку из-за значения, присвоенного Prop1 является сложным.

Эта функция ограничивает входной аргумент скалярным действительным значением.

function r = mbReal(z)
    arguments
        z (1,1) {mustBeReal}
    end
    r = randi(9,z);
end

Вызов этой функции со сложным значением приводит к возникновению ошибки mustBeReal.

x = -1;
z = x.^exp(-x.^2);
r = mbReal(z);
Error using mbReal
Invalid input argument at position 1. Value must be real.

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

свернуть все

Значение для проверки, указанное как скаляр или массив любого из следующих значений:

  • logical, char, или числовой класс

  • Классы MATLAB, реализующие isreal

Другие типы данных вызывают ошибку.

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char
Поддержка комплексного номера: Да

Совет

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

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

Создание кода C/C + +
Создайте код C и C++ с помощью MATLAB ® Coder™

.

См. также

| |

Темы

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

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

Поддержка