Exponenta Banner

print

Класс: matlab.unittest.plugins. OutputStream
Пакет: matlab.unittest.plugins

Напишите текст, сгенерированный TestRunnerPlugin образец в выходной поток

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

Синтаксис

print(stream,formatSpec,A1,...,An)

Описание

print(stream,formatSpec,A1,...,An) использует операторы форматирования formatSpec для форматирования данных, которые matlab.unittest.plugins.TestRunnerPlugin образец генерируется в массивах A1,...,An. Затем метод записывает результат в выход stream.

Для данных, которые не сгенерированы TestRunnerPlugin образец, использование fprintf чтобы записать данные в текстовый файл или экран, или использовать sprintf для форматирования данных в строковый или символьный вектор.

Входные параметры

расширить все

Расположение, куда плагин направляет вывод текста, заданное как OutputStream образец.

Формат выходных полей, заданный с помощью операторов форматирования. formatSpec также может включать обычный текст и специальные символы.

Если formatSpec включает буквенные тексты, представляющие побочные символы, такие как \n, затем print преобразует символы побега.

formatSpec может быть вектор символов в одинарных кавычках или, начиная с R2016b, строковым скаляром.

Оператор форматирования

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

Символ преобразования

В этой таблице показаны символы преобразования в форматирование числовых и символьных данных в виде текста.

Тип значенияПреобразованиеПодробнее

Целое число, со знаком

%d или %i

Основа 10

Целое число, без знака

%u

Основа 10

%o

База 8 (октальная)

%x

База 16 (шестнадцатеричная), строчные буквы a– f

%X

То же, что и %x, заглавные буквы A– F

Число с плавающей запятой

%f

Обозначение с фиксированной точкой (Используйте оператор точности, чтобы задать количество цифр после десятичной точки.)

%e

Экспоненциальное обозначение, такое как 3.141593e+00 (Используйте оператор точности, чтобы задать количество цифр после десятичной точки.)

%E

То же, что и %e, но в верхнем регистре, например 3.141593E+00 (Используйте оператор точности, чтобы задать количество цифр после десятичной точки.)

%g

Чем компактнее %e или %f, без конечных нулей (Используйте оператор точности, чтобы задать количество значащих цифр.)

%G

Чем компактнее %E или %f, без конечных нулей (Используйте оператор точности, чтобы задать количество значащих цифр.)

Символы или строки

%c

Один символ

%s

Вектор символов или строковые массивы. Тип выходного текста совпадает с типом formatSpec.

Необязательные операторы

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

  • Идентификатор

    Порядок обработки входных аргументов функции. Используйте синтаксис n$, где n представляет положения других входных параметров в вызове функции.

    Пример: ('%3$s %2$s %1$s %2$s','A','B','C') печатает входные параметры 'A', 'B', 'C' следующим образом: C B A B.

    Примечание.Если входной параметр является массивом, вы не можете использовать идентификаторы, чтобы задать конкретные элементы массива из этого входного параметра.

  • Флаги

    '–'

    Слева-оправдать.
    Пример: %-5.2f
    Пример: %-10s

    '+'

    Всегда печатайте символ (+ или -) для любого числового значения.
    Пример: %+5.2f
    Текст с выравниванием по правому краю.
    Пример: %+10s

    ' '

    Вставьте пространство перед значением.
    Пример: % 5.2f

    '0'

    Заполните до ширины поля нулями перед значением.
    Пример: %05.2f

    '#'

    Измените выбранные числовые преобразования:

    • Для %o, %x, или %X, печать 0, 0x, или 0X префикс.

    • Для %f, %e, или %E, напечатайте десятичную точку, даже если точность равна 0.

    • Для %g или %G, не удаляйте конечные нули или десятичную точку.

    Пример: %#5.0f

  • Ширина поля

    Минимальное количество символов для печати. Оператор ширины поля может быть числом или звездочкой (*) для ссылки на входной параметр.

    Когда вы задаете * как оператор ширины поля, другие входные параметры должны обеспечивать и ширину, и значение, которое должно быть напечатано. Ширина и значения могут быть парами аргументов или парами в числовом массиве. С * как оператор ширины поля, можно печатать различные значения с различными ширинами.

    Пример: Входные параметры ('%12d',intmax) эквивалентны ('%*d',12,intmax).

    Пример: Входные параметры ('%*d',[2 10 5 100]) возврат '10 100', с двумя пространствами, выделенными для 10 и пять пространств для 100. В качестве альтернативы можно также задать ширины и значения полей как несколько аргументов, как в ('%*d',2,10,5,100).

    Функция заполняет поле шириной пространств перед значением, если иное не задано флагами.

  • Точность

    Для %f, %e, или %E

    Количество цифр справа от десятичной точки
    Пример: '%.4f' печатает pi как '3.1416'

    Для %g или %G

    Количество значащих цифр
    Пример: '%.4g' печатает pi как '3.142'

    Оператор точности может быть числом или звездочкой (*) для ссылки на аргумент.

    Когда вы задаете * как оператор точности поля, другие входные параметры должны обеспечивать и точность, и значение, которое должно быть напечатано. Точности и значения могут быть парами аргументов или парами в числовом массиве. С * как оператор точности, вы можете печатать различные значения к различным точностям.

    Когда вы задаете *.* как ширина поля и операторы точности, необходимо задать ширины поля, точности и значения как триплеты.

    Пример: Входные параметры ('%.4f',pi) эквивалентны ('%.*f',4,pi).

    Пример: Входные параметры ('%6.4f',pi) эквивалентны ('%.*f',6,4,pi).

    Пример: Входные параметры ('%*.*f',6,4,pi,9,6,exp(1)) возврат '3.1416 2.718282', с 9 и 6 как ширина поля и точность для выхода exp(1).

    Примечание

    Если вы задаете оператор точности для значений с плавающей точкой, который превышает точность входного типа числовых данных, результаты могут не совпадать с заданной точностью. Результат зависит от оборудования компьютера и операционной системы.

  • Подтипы

    Можно использовать оператор подтипа, чтобы напечатать значение с плавающей точкой как его восьмеричное, десятичное или шестнадцатеричное значение. Оператор подтипа непосредственно предшествует символу преобразования. В этой таблице показаны преобразования, которые могут использовать подтипы.

    Вход значения

    Подтип и символ преобразования

    Выход значения

    Число с плавающей запятой

    %bx или %bX
    %bo
    %bu

    Шестнадцатеричное, восьмеричное или десятичное значение двойной точности
    Пример: %bx печатает pi как 400921fb54442d18

    %tx или %tX
    %to
    %tu

    Шестнадцатеричное, восьмеричное или десятичное значение с одной точностью
    Пример: %tx печатает pi как 40490fdb

Текст до или после операторов форматирования

formatSpec может также включать дополнительный текст перед знаком процента, %, или после символа преобразования. Текст может быть:

  • Обычный текст для печати.

  • Специальные символы, которые вы не можете ввести как обычный текст. В этой таблице показано, как представлять специальные символы в formatSpec.

    Специальный символ

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

    Одинарная кавычка

    ''

    Процент символа

    %%

    Обратная косая черта

    \\

    Тревога

    \a

    Клавиша Backspace

    \b

    Подача формы

    \f

    Новая линия

    \n

    Возврат каретки

    \r

    Горизонтальная вкладка

    \t

    Вертикальная вкладка

    \v

    Символ, чей Юникод® числовое значение может быть представлено шестнадцатеричным числом, N

    \xN

    Пример: sprintf('\x5A') возвращает 'Z'

    Символ, числовое значение в Юникоде которого может быть представлено восьмеричным числом N

    \N

    Пример: sprintf('\132') возвращает 'Z'

Заметное поведение преобразований с операторами форматирования

  • Числовые преобразования печатают только действительный компонент комплексных чисел.

  • Если вы задаете преобразование, которое не соответствует данным, такое как преобразование текста для числового значения, MATLAB® переопределяет заданное преобразование и использует %e.

    Пример: '%s' преобразует pi на 3.141593e+00.

  • Если вы применяете преобразование текста (либо %c или %s) в целочисленные значения, MATLAB преобразует значения, которые соответствуют допустимым символьным кодам, в символы.

    Пример: '%s' преобразует [65 66 67] на ABC.

Данные для отображения, заданные как число, символ или строковые массивы.

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string

Признаки

Abstracttrue

Чтобы узнать об атрибутах методов, см. «Атрибуты метода».

Примеры

расширить все

В файле в текущей папке создайте класс с именем ToFigure который перенаправляет выход плагина на рисунок и отображает его в списке внутри рисунка. Определите Figure и ListBox свойства для представления рисунка и указателя на поле списка, соответственно.

classdef ToFigure < matlab.unittest.plugins.OutputStream
    
    properties(SetAccess = private)
        Figure
    end
    properties(Access = private)
        ListBox
    end

Необходимо реализовать print метод для любого подкласса OutputStream. В этом примере метод создает новый рисунок (при необходимости), форматирует входящий текст, а затем добавляет его к выходу потоку.

    methods
        function print(stream,formatSpec,varargin)
            % Create the figure
            if isempty(stream.Figure) || ~ishghandle(stream.Figure)
                stream.createFigure
            end
            newStr = sprintf(formatSpec,varargin{:});
            oldStr = strjoin(stream.ListBox.String','\n');
            
            % Create the full message
            fullStr = strjoin([oldStr,newStr]);
            fullStrArray = strsplit(fullStr,'\n','CollapseDelimiters',false);
            
            % Set the string and selection
            stream.ListBox.String = fullStrArray';
            stream.ListBox.Value = numel(fullStrArray);
            drawnow
        end
    end

В methods блок с private доступ, реализуйте вспомогательный метод с именем createFigure который создает рисунок и поле списка, используемые плагином.

    methods(Access = private)
        function createFigure(stream)
            stream.Figure = figure(...
                'Name',         'Unit Test Output',...
                'WindowStyle',  'docked');
            
            stream.ListBox = uicontrol(...
                'Parent',       stream.Figure,...
                'Style',        'listbox',...
                'String',       {},...
                'Units',        'normalized',...
                'Position',     [.05 .05 .9 .9],...
                'Max',          2, ...
                'FontName',     'Monospaced',...
                'FontSize',     13);
        end
    end
end

Сохраните ToFigure класс. Теперь в текущей папке создайте файл с именем ExampleTest.m содержащий следующий тестовый класс. The verifyEqual проверка в testOne приводит к непройденному тесту. The верификации in testTwo проходит. Тест, соответствующий testThree проходит без получения выхода.

classdef ExampleTest < matlab.unittest.TestCase
    methods(Test)
        function testOne(testCase)  % Test fails
            testCase.verifyEqual(5,4,'Testing 5==4');
        end
        function testTwo(testCase)  % Test passes
            testCase.verifyEqual(5,5,'Testing 5==5');
        end
        function testThree(testCase)
            % test code
        end
    end
end

В командной строке создайте тестовый набор из ExampleTest класс.

import matlab.unittest.TestRunner
import matlab.unittest.plugins.DiagnosticsValidationPlugin

suite = testsuite('ExampleTest');

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

runner = TestRunner.withTextOutput;

Создайте DiagnosticsValidationPlugin образец, который явно задает, что его выход должен перейти к рисунку с помощью ToFigure выходной поток.

plugin = DiagnosticsValidationPlugin(ToFigure);

Добавьте плагин к питателю и запустите тесты.

runner.addPlugin(plugin)
result = runner.run(suite);
Running ExampleTest

================================================================================
Verification failed in ExampleTest/testOne.

    ----------------
    Test Diagnostic:
    ----------------
    Testing 5==4

    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyEqual failed.
    --> The values are not equal using "isequaln".
    --> Failure table:
                Actual    Expected    Error    RelativeError
                ______    ________    _____    _____________
            
                5         4           1        0.25         
    
    Actual Value:
             5
    Expected Value:
             4

    ------------------
    Stack Information:
    ------------------
    In C:\work\ExampleTest.m (ExampleTest.testOne) at 4
================================================================================
...
Done ExampleTest
__________

Failure Summary:

     Name                 Failed  Incomplete  Reason(s)
    ==================================================================
     ExampleTest/testOne    X                 Failed by verification.

Только непройденные тесты производят выход к экрану. По умолчанию TestRunner.withTextOutput использует DiagnosticsOutputPlugin для отображаемого вывода на экране.

В сложение к выводу текста по умолчанию, отображаемой на экране, DiagnosticsValidationPlugin выход направлен на закреплённый рисунок. Рисунок показывает этот текст.

------------------------------
Validation of Test Diagnostic:
------------------------------
Testing 5==4
------------------------------
Validation of Test Diagnostic:
------------------------------
Testing 5==5

The DiagnosticsValidationPlugin отображает диагностическую информацию независимо от того, сталкиваются ли тесты с условиями отказа.

См. также

|

Темы

Введенный в R2014a

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

Поддержка