Валидаторы на testlib.h

Правка ru9, от KAN, 2022-07-07 18:43:02

Если вы написали несколько задач и подготовили для них тесты, вероятно, вы будете крайне неприятно себя чувствовать, если какие-то из тестов окажутся некорректными (в том смысле, что они не будут согласованы с условием задачи): значение какой-то величины будет больше допустимой верхней границы для нее, граф не будет удовлетворять требованиям связности или же не будет являться деревом... Это естественно, что вы будете себя так чувствовать. Даже опытные авторы задач не застрахованы от ошибок (это случается даже на самых престижных соревнованиях: пример тому — финал чемпионата мира ACM ICPC 2007 г.)

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

Написать валидатор с помощью testlib.h на самом деле очень легко.

Пример

Ниже приводится валидатор, который мог бы быть написан для задачи 100541A - Stock Market:

#include "testlib.h"

int main(int argc, char* argv[]) {
    registerValidation(argc, argv);
    int testCount = inf.readInt(1, 10, "testCount");
    inf.readEoln();
    
    for (int i = 0; i < testCount; i++) {
        setTestCase(i + 1);
        int n = inf.readInt(1, 100, "n");
        inf.readSpace();
        inf.readInt(1, 1'000'000, "w");
        inf.readEoln();

        inf.readInts(n, 1, 1000, "p");
        inf.readEoln();
    }

    inf.readEof();
}
Оригинальный валидатор, использующий более старые версии testlib.h

Самое замечательное в этом валидаторе то, что он очень простой, и в нем очень трудно написать что-то неправильно.

В репозитории Github можно найти другие примеры валидаторов.

Функции и методы

Первая строка вашего кода должна содержать вызов registerValidation(): немного магии, и вы можете использовать необходимые методы. Большинство методов для валидатора начинаются с префикса read и именно выполняют чтение: перемещают указатель во входном потоке на следующую позицию после прочтения чего-либо. В процессе чтения обнаруживаются нарушения (входные данные не соответствуют тому, что вы пытаетесь прочитать: например, вы предпринимаете попытку прочитать целое число, а во входных данных встречается строка) и выбрасывается ошибка.

Замечания:

  • Валидатор строг. Он проверяет корректное расположение пробелов. Например, последовательность вызовов вида прочесть число, прочесть пробел, прочесть число гарантирует наличие ровно одного пробела между числами; в противном случае валидатор сообщит об ошибке.
  • Некоторые методы частично поддерживают синтаксис регулярных выражений. Конечно, это не полноценные регулярные выражения, которые вы можете использовать во многих языках программирования. Это очень простая версия, в которой поддерживается следующее:
    • Множество символов: например, [a-z] — любые строчные латинские буквы, [^a-z] — любые символы за исключением строчных латинских букв.
    • Диапазон, например, шаблон [a-z]{1,5} описывает строки длиной от 1 до 5 символов, содержащие только строчные латинские буквы.
    • Оператор Или, например, шаблон mike|john — это или строка mike, или строка john.
    • Необязательные символы, например, шаблон -?[1-9][0-9]{0,3} допускает ненулевые целые числа от -9999 до 9999 (обратите внимание на необязательный знак "минус").
    • Повторения, например, шаблон [0-9]* допускает последовательности (как пустые, так и непустые) цифр, а шаблон [0-9]+ только непустые последовательности цифр.
  • Также заметим, что при распознавании регулярных выражений используется очень простой жадный алгоритм. Например, шаблон [0-9]?1 не допускает 1 в силу жадного поведения распознавателя.

Ниже представлен полный список функций и методов входного потока (inf.<method>).

Метод / функция Что делает
void registerValidation() Эта функция должна быть вызвана в начале вашего кода, чтобы использовать валидатор. После вызова этой функции вы получаете доступ к входному потоку посредством переменной inf.
char readChar() Этот метод возвращает текущий символ и перемещает указатель на один символ вперед.
char readChar(char c) Аналогичен readChar(), но обеспечивает проверку, что прочитанный символ именно c.
char readSpace() Аналогичен readChar(' ').
void unreadChar(char c) Возвращает символ c во входной поток.
string readToken(),
string readWord()
Читает и возвращает очередную лексему (токен).
string readToken(string regex),
string readWord(string regex)
Аналогичен readToken(), но выполняет проверку соответствия лексемы (токена) указанному регулярному выражению regex.
vector<string> readTokens(int n, string regex),
vector<string> readWords(int n, string regex)
Читают и возвращают n лексем (токенов) через пробел, каждый токен должен соответствовать регулярному выражению regex.
int readInt(),
int readInteger()
Читает и возвращает целое число (тип int как в Java, так и в C/C++)
int readInt(int L, int R),
int readInteger(L, R)
Аналогичны readInt(), но выполняет проверку, что значение находится в диапазоне [L, R] (включительно)
vector<int> readInts(int n, int L, int R),
vector<int> readIntegers(int n, int L, int R)
Читает n целых чисел (тип int как в Java, так и в C/C++) через пробел, выполняет проверку, что значения находятся в диапазоне [L,  R] (включительно) и возвращает vector
long long readLong() Читает и возвращает длинное целое (long long в C/C++ и long в Java)
long long readLong(long long L, long long R) Аналогичен readLong(), но выполняет проверку, что значение находится в диапазоне [L, R] (включительно)
vector<long long> readLongs(int n, long long L, long long R) Читает n длинных целых чисел (long long в C/C++ и long в Java) через пробел, выполняет проверку, что значения находятся в диапазоне [L,  R] (включительно) и возвращает vector
double readReal(),
double readDouble()
Читают и возвращают вещественное число (double).
double readReal(double L, double R),
double readDouble(double L, double R)
Аналогичны readReal(), readDouble(), но выполняют проверку, что значение находится в диапазоне [L, R].
double readStrictReal(double L, double R, int minPrecision, int maxPrecision),
double readStrictDouble(double L, double R, int minPrecision, int maxPrecision)
Аналогичны readReal(L, R), readDouble(L, R), но выполняют дополнительную проверку, что количество цифр после десятичной точки находится в диапазоне [minPrecision, maxPrecision]. Экспоненциальная запись числа или другие нестандартные формы записи не допускаются.
vector<double> readReals(int n, double L, double R),
vector<double> readDoubles(int n, double L, double R),
vector<double> readStrictReals(int n, double L, double R, int minPrecision, int maxPrecision),
vector<double> readStrictDoubles(int n, double L, double R, int minPrecision, int maxPrecision)
Читает n вещественных чисел с соответствующими ограничениями через пробел и возвращает vector
string readString(),
string readLine()
Прочитывают строку, начиная с текущей позиции до EOLN. Перемещают указатель во входном потоке на первый символ следующей строки (если она существует).
string readString(string regex),
string readLine(string regex)
Аналогичны readString() and readLine(), но выполняют проверку, что строка соответствует указанному регулярному выражению regex.
vector<string> readStrings(int n, string regex),
vector<string> readLines(int n, string regex)
Читают и возвращают n строк, соответствующие регулярному выражению regex.
void readEoln() Читает EOLN или завершает работу с ошибкой. Заметим, что этот метод чудесным образом работает как для Windows, так и для Linux. В Windows он прочитывает #13#10, а в Linux #10.
void readEof() Читает EOF или завершает работу с ошибкой.

Параметр variableName

Рекомендуется использовать последний строковый параметр variableName в методах readInt/readInteger/readLong/readDouble/readWord/readToken/readString/readLine, чтобы сделать сообщение об ошибке более удобным для чтения. Т.е. предпочтительнее использовать inf.readInt(1, 100, "n") вместо inf.readInt(1, 100). При возникновении ошибки в первом случае будет выводиться сообщение вида FAIL Integer parameter [name=n] equals to 0, violates the range [1, 100].

Использование ensure/ensuref

Чтобы проверить некоторые требования (например, то, что граф не содержит петель, т.е. что xi ≠ yi), используйте ensuref(x_i != y_i, "Graph can't contain loops"). Допускается использование спецификаторов формата языка C, подобных ensuref(s.length() % 2 == 0, "String 's' should have even length, but s.length()=%d", int(s.length())). Также вы можете использовать более простую форму ensure(x > y), в этом случае будет печататься нарушенное условие, если оно не выполняется: FAIL Condition failed: "x > y".

Ссылки: страница testlib.h на Github

Теги testlib, validator, validators, валидаторы, polygon, полигон

История

 
 
 
 
Правки
 
 
  Rev. Язык Кто Когда Δ Комментарий
ru11 Русский KAN 2022-07-07 20:21:26 2128
en24 Английский KAN 2022-07-07 20:16:48 4201 Tiny change: 'alidation()` which d' -> 'alidation(argc, argv)` which d'
ru10 Русский KAN 2022-07-07 19:00:36 2066 added global methods
ru9 Русский KAN 2022-07-07 18:43:02 2171 updated functions
ru8 Русский MikeMirzayanov 2018-12-29 14:28:59 20 Мелкая правка: ' readLong(int L, int R)|Аналог' -> ' readLong(long long L, long long R)|Аналог'
ru7 Русский arsijo 2018-11-02 01:08:48 527
en23 Английский arsijo 2018-11-02 01:01:28 400
ru6 Русский Zlobober 2016-10-01 20:36:24 32
en22 Английский Zlobober 2016-02-24 02:54:05 32
en21 Английский I_love_Hoang_Yen 2015-06-18 14:09:58 20 Tiny change: ' readLong(int L, int R)|Same a' -> ' readLong(long long L, long long R)|Same a'
ru5 Русский riadwaw 2015-06-10 22:35:00 20
en20 Английский I_love_Hoang_Yen 2015-06-10 21:00:28 20
ru4 Русский MikeMirzayanov 2015-06-10 12:29:16 118
en19 Английский MikeMirzayanov 2015-06-10 12:27:46 410
en18 Английский PrinceOfPersia 2015-06-10 08:57:32 218
ru3 Русский MikeMirzayanov 2015-06-10 02:25:07 67
en17 Английский MikeMirzayanov 2015-06-10 02:24:34 67
ru2 Русский MikeMirzayanov 2015-06-10 02:20:24 3
ru1 Русский elena 2015-06-10 02:18:13 7940 Первая редакция перевода на Русский
en16 Английский elena 2015-06-10 01:13:44 30 Tiny change: 'inus sign), note that it will match '-0'.\n - *' -> 'inus sign).\n - *'
en15 Английский MikeMirzayanov 2015-06-09 17:33:29 1546
en14 Английский PrinceOfPersia 2015-06-09 17:16:10 56
en13 Английский I_love_Hoang_Yen 2015-06-09 14:08:48 125
en12 Английский I_love_Hoang_Yen 2015-06-09 14:06:24 246 Tiny change: '| Same as readChar(' ').|\n|void ' -> '| Same as `readChar(' ')`.|\n|void '
en11 Английский I_love_Hoang_Yen 2015-06-09 13:56:28 86 Update styling
en10 Английский I_love_Hoang_Yen 2015-06-09 13:53:23 1840 (published)
en9 Английский I_love_Hoang_Yen 2015-06-09 13:38:13 291
en8 Английский I_love_Hoang_Yen 2015-06-09 13:34:33 28 Tiny change: ' C/C++)|\n\n|readInt' -
en7 Английский I_love_Hoang_Yen 2015-06-09 13:01:14 3 Tiny change: 'readInt(), readIntege' -> 'readInt(),\nreadIntege'
en6 Английский I_love_Hoang_Yen 2015-06-09 12:54:26 2 Tiny change: ' in range [L, R].|\n|readS' -> ' in range $[L, R]$.|\n|readS'
en5 Английский I_love_Hoang_Yen 2015-06-09 12:54:01 60
en4 Английский I_love_Hoang_Yen 2015-06-09 12:52:57 1888
en3 Английский I_love_Hoang_Yen 2015-06-09 12:34:31 206
en2 Английский I_love_Hoang_Yen 2015-06-09 12:04:31 331
en1 Английский I_love_Hoang_Yen 2015-06-09 12:01:01 1478 Initial revision (saved to drafts)