exponenta event banner

assumeEqual

Класс: matlab.unittest.qualifications. Assumable
Пакет: matlab.unittest.qualifications

Предположим, что значение равно указанному значению

Синтаксис

assumeEqual(assumable,actual,expected)
assumeEqual(___,Name,Value)
assumeEqual(___,diagnostic)

Описание

assumeEqual(assumable,actual,expected) предполагает, что actual строго равно expected. Если expected не является объектом MATLAB ® или Java ®,actual и expected должен иметь один и тот же класс, размер и значение для выполнения предположения. assumeEqual выдерживает сравнение actual и expected таким же образом, как IsEqualTo ограничение.

assumeEqual(___,Name,Value) предполагает равенство с дополнительными опциями, указанными одним или несколькими Name,Value аргументы пары.

assumeEqual(___,diagnostic) также связывает диагностическую информацию в diagnostic с квалификацией. В зависимости от конфигурации тестового питателя платформа тестирования может отображать диагностику при прохождении или сбое квалификации. По умолчанию инфраструктура отображает диагностику только при сбое квалификации. Поведение по умолчанию можно переопределить, настроив тестовый питатель. Например, используйте DiagnosticsOutputPlugin для отображения диагностики сбоев и прохождения событий.

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

assumable

matlab.unittest.TestCase экземпляр, который используется для того, чтобы сдать или не выполнить допущение в сочетании с тестовой исполняемой структурой.

actual

Тестируемое значение.

expected

Ожидаемое значение.

diagnostic

Диагностическая информация, относящаяся к квалификации, указана как одно из следующих:

  • строковый массив

  • символьный массив

  • дескриптор функции

  • matlab.unittest.diagnostics.Diagnostic объект

Диагностические значения могут быть нескалярными. Дополнительные сведения см. в разделе matlab.unittest.diagnostics.Diagnostic.

Аргументы пары «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

'AbsTol'

Абсолютный допуск, заданный как числовой массив. Допуск применяется только к значениям того же типа данных. Значение может быть скаляром или массивом того же размера, что и фактические и ожидаемые значения.

Чтобы абсолютная толерантность была удовлетворена, abs(expected-actual) <= absTol должно быть истинно.

'RelTol'

Относительный допуск, заданный как числовой массив. Допуск применяется только к значениям того же типа данных. Значение может быть скаляром или массивом того же размера, что и фактические и ожидаемые значения.

Для удовлетворения относительного допуска, abs(expected-actual) <= relTol.*abs(expected) должно быть истинно.

Примеры

развернуть все

Числовые значения равны, если они одного класса с эквивалентным размером, сложностью и разреженностью.

В командной строке создайте тестовый пример для интерактивного тестирования.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Предположим, что числовое значение равно самому себе.

assumeEqual(testCase,5,5)
An assumption was met.

Предположим, что фактические и ожидаемые значения имеют одинаковые размеры.

assumeEqual(testCase,[5 5],5)
An assumption was not met.
    ---------------------
    Framework Diagnostic:
    ---------------------
    assumeEqual failed.
    --> Sizes do not match.
        
        Actual size:
             1     2
        Expected size:
             1     1
    
    Actual Value:
         5     5
    Expected Value:
         5
Assumption failed.

Предположим, что int8 равно int16.

testCase = matlab.unittest.TestCase.forInteractiveUse;
assumeEqual(testCase,int8(5),int16(5))
An assumption was not met.
    ---------------------
    Framework Diagnostic:
    ---------------------
    assumeEqual failed.
    --> Classes do not match.
        
        Actual Class:
            int8
        Expected Class:
            int16
    
    Actual Value:
      int8
    
       5
    Expected Value:
      int16
    
       5
Assumption failed.

Элементы одинаковых массивов ячеек должны совпадать по классу, размеру и значению.

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

testCase = matlab.unittest.TestCase.forInteractiveUse;
assumeEqual(testCase,{'cell',struct,5},{'cell',struct,5})
An assumption was met.

Предположим, если 4.95 равно 5.

testCase = matlab.unittest.TestCase.forInteractiveUse;
assumeEqual(testCase,4.95,5)
An assumption was not met.
    ---------------------
    Framework Diagnostic:
    ---------------------
    assumeEqual failed.
    --> The numeric values are not equal using "isequaln".
    --> Failure table:
            Actual    Expected           Error              RelativeError    
            ______    ________    ___________________    ____________________
        
             4.95        5        -0.0499999999999998    -0.00999999999999996
    
    Actual Value:
       4.950000000000000
    Expected Value:
         5
Assumption failed.

Предположим, что разница между фактическим значением 1.5 и ожидаемое значение 2 находится в пределах 1.

assumeEqual(testCase,1.5,2,'AbsTol',1)
An assumption was met.

Предположим, что разница между фактическими и ожидаемыми значениями меньше 10%. Отображение диагностической информации при отказе.

assumeEqual(testCase,1.5,2,'RelTol',0.1,...
    'Difference between actual and expected exceeds relative tolerance')
An assumption was not met.
    ----------------
    Test Diagnostic:
    ----------------
    Difference between actual and expected exceeds relative tolerance
    ---------------------
    Framework Diagnostic:
    ---------------------
    assumeEqual failed.
    --> The numeric values are not equal using "isequaln".
    --> The error was not within relative tolerance.
    --> Failure table:
            Actual    Expected    Error    RelativeError    RelativeTolerance
            ______    ________    _____    _____________    _________________
        
             1.5         2        -0.5         -0.25               0.1       
    
    Actual Value:
       1.500000000000000
    Expected Value:
         2
Assumption failed.

Совет

  • Этот способ функционально эквивалентен любому из следующих способов:

    import matlab.unittest.constraints.IsEqualTo;
    assumable.assumeThat(actual, IsEqualTo(expected));
    import matlab.unittest.constraints.IsEqualTo;
    import matlab.unittest.constraints.AbsoluteTolerance;
    assumable.assumeThat(actual, IsEqualTo(expected, ...
        'Within', AbsoluteTolerance(abstol)));
    import matlab.unittest.constraints.IsEqualTo;
    import matlab.unittest.constraints.RelativeTolerance;
    assumable.assumeThat(actual, IsEqualTo(expected, ...
        'Within', RelativeTolerance(reltol)));
    import matlab.unittest.constraints.IsEqualTo;
    import matlab.unittest.constraints.AbsoluteTolerance;
    import matlab.unittest.constraints.RelativeTolerance;
    assumable.assumeThat(actual, IsEqualTo(expected, ...
        'Within', AbsoluteTolerance(abstol) | RelativeTolerance(reltol)));

    Существует больше функциональных возможностей при использовании IsEqualTo, AbsoluteTolerance, и RelativeTolerance ограничения непосредственно через assumeThat.

  • Для проверки соответствия среды тестирования предварительным условиям, которые в противном случае не приведут к сбою теста, используйте квалификационные требования. Предполагаемые отказы приводят к отфильтрованным тестам, и платформа тестирования помечает тесты как Incomplete. В качестве альтернативы,

    • Используйте условия проверки для создания и записи отказов без создания исключения. Так как проверки не вызывают исключений, все содержимое теста выполняется до завершения даже при возникновении ошибок проверки. Как правило, проверки являются основной квалификацией для единичного теста, поскольку они обычно не требуют раннего выхода из теста. Используйте другие типы квалификации для проверки на нарушение предварительных условий или неправильной настройки теста. Дополнительные сведения см. в разделе matlab.unittest.qualifications.Verifiable.

    • Используйте условия утверждения, когда условие отказа аннулирует остальную часть текущего содержимого теста, но не препятствует надлежащему выполнению последующих методов тестирования. Сбой в точке утверждения делает текущий метод тестирования неуспешным и неполным. Дополнительные сведения см. в разделе matlab.unittest.qualifications.Assertable.

    • Используйте условия неустранимого утверждения, чтобы прервать тестовый сеанс при сбое. Эти требования полезны, когда режим отказа настолько фундаментален, что нет смысла продолжать тестирование. Эти требования также полезны, когда отрыв приспособления не восстанавливает состояние MATLAB правильно, и предпочтительно прервать тестирование и начать новую сессию. Дополнительные сведения см. в разделе matlab.unittest.qualifications.FatalAssertable.

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