By I_love_Hoang_Yen, history, 3 years ago, In English,

If you have written some programming problems, and have prepared test cases, you will probably experience the terrible feeling that some test cases may be invalid (meaning it does not agree with the constraints in problem statement): upper bound can be violated, your graph not satisfied connectivity requirements or is not at tree... It is reasonable to feel that way. Even experienced problem setters make mistakes sometimes (for example, in the prestigious ACM ICPC World final 2007).

It is strictly recommended to write a special program (called validator) to formally check each test to satisfy all requirements from problem statements. Validators are strictly required for problems on Codeforces. Polygon has built-in support of validators.

It is really easy to write a validator using testlib.h.

Example

Following is the validator was written for the problem 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++) {
        int n = inf.readInt(1, 100, "n");
        inf.readSpace();
        inf.readInt(1, 1000000, "w");
        inf.readEoln();

        for(int i = 0; i < n; ++i) {
            inf.readInt(1, 1000, "p_i");
            if (i < n-1)
                inf.readSpace();
        }
        inf.readEoln();
    }

    inf.readEof();
}

The wonderful thing about this validator is that it is very simple and it is very difficult to write something incorrect.

More examples can be found at the Github repo

Available methods

The first line of your code should be registerValidation() which does some magic in the background, so that you can use the necessary methods. Most methods for validators start with prefix "read" and it does the same thing: moves input stream pointer to next suitable place after reading something. It also detect violations (input does not match what you are trying to read), and then throw error.

Notes:

  • Validator is strict. It cares about correct placing of spaces. For example, when you're trying to read an integer and the next character is a space (and then an integer), the validator will throw error.
  • Some method has "regex" feature. It is not a full-featured regex as you may have used in many programming languages. It is a very simple version, which supports the following:
    • Set of character, e.g: [a-z] is a lowercase latin letter, [^a-z] matches anything but a lowercase latin letter.
    • Range, e.g. [a-z]{1,5} is a string of length 1 to 5 consists of only lowercase latin letter.
    • Or operator, e.g. mike|john is either mike or john.
    • Optional character, e.g. -?[1-9][0-9]{0,3} will match non-zero integers from -9999 to 9999 (note the optional minus sign).
    • Repetition, e.g. [0-9]* will match sequences (empty or non-empty) of digits, and [0-9]+ will match non-empty sequences of digits.
  • Also regarding regex, very simple greedy algorithm is used. For example, pattern [0-9]?1 will not match 1, because of greedy nature of matching.

Following is full list of methods available:

Method What it does
void registerValidation() This method must be called at the beginning of your code in order to use validator.
After calling this method, you can access input stream by variable named inf.
char readChar() Returns current character and moves pointer one character forward.
char readChar(char c) Same as readChar() but ensures that the readCharacter is 'c'.
char readSpace() Same as readChar(' ').
void unreadChar(char c) Puts back character c to input stream.
string readToken() Reads a new token, i.e. a word that doesn't contain any whitespaces (like space, tab, EOLN and etc).
string readToken(string regex) Same as readToken() but ensures that it matches given regex.
string readWord() Same as readToken()
string readWord(string regex) Same as readToken(string regex)
long long readLong() Reads a long (long long in C/C++ and long in Java)
long long readLong(long long L, long long R) Same as readLong() but ensures that the value is in range [L, R] (inclusively)
int readInt(),
int readInteger()
Reads an integer (int type in both Java and C/C++)
int readInt(int L, int R),
int readInteger(L, R)
Same as readInt() but ensures that the value is in range [L, R] (inclusively)
double readReal(),
double readDouble()
Reads a double.
double readReal(double L, double R),
double readDouble(double L, double R)
Same as readReal(), readDouble() but ensures that the value is in range [L, R].
double readStrictReal(double L, double R, int minPrecision, int maxPrecision),
double readStrictDouble(double L, double R, int minPrecision, int maxPrecision)
Same as readReal(L, R), readDouble(L, R), but additionally ensures that the number of digits after decimal point is between [minPrecision, maxPrecision]. Doesn't allow exponential or any other non-standard form.
string readString(),
string readLine()
Reads a line from current position to EOLN. Moves input stream pointer to first character of new line (if exists).
string readString(string regex),
string readLine(string regex)
Same as readString() and readLine(), but ensures that the string matches given regex.
void readEoln() Reads EOLN or fails. Note that this method magically works on both Windows and Linux. On Windows it reads #13#10 and on Linux it reads #10.
void readEof() Reads EOF or fails.

Parameter variableName

It is recommended to insert last string parameter to readInt/readInteger/readLong/readDouble/readWord/readToken/readString/readLine called variableName to make error message be human-readable. So it is preffered to use inf.readInt(1, 100, n) instead of inf.readInt(1, 100). The first statement will fail with human-readable message like FAIL Integer parameter [name=n] equals to 0, violates the range [1, 100].

Using ensure/ensuref

To check a requirement (like a graph doesn't contain loops, i.e. xi ≠ yi) use ensuref(x_i != y_i, "Graph can't contain loops"). It is allowed to use C-language format specifiers like ensuref(s.length() % 2 == 0, "String 's' should have even length, but s.length()=%d", int(s.length())). Also you can use simple form like ensure(x > y), it will print failed condition if it doesn't hold in form FAIL Condition failed: "x > y".

Reference: Github page of testlib.h

 
 
 
 
  • Vote: I like it  
  • +182
  • Vote: I do not like it  

»
3 years ago, # |
  Vote: I like it +12 Vote: I do not like it

Auto comment: topic has been updated by I_love_Hoang_Yen (previous revision, new revision, compare).

»
3 years ago, # |
  Vote: I like it +7 Vote: I do not like it

Auto comment: topic has been updated by MikeMirzayanov (previous revision, new revision, compare).

»
3 years ago, # |
  Vote: I like it +26 Vote: I do not like it

Auto comment: topic has been updated by elena (previous revision, new revision, compare).

»
3 years ago, # |
  Vote: I like it +7 Vote: I do not like it

Thank for your testlib.h It is taught a lot of things

»
3 years ago, # |
  Vote: I like it -82 Vote: I do not like it

Auto comment: topic has been updated by aitzhan.askar (previous revision, new revision, compare)

»
3 years ago, # |
  Vote: I like it 0 Vote: I do not like it

Auto comment: topic has been updated by PrinceOfPersia (previous revision, new revision, compare).

»
3 years ago, # |
  Vote: I like it +5 Vote: I do not like it

What has happened during the ACM ICPC world finals 2007? Was there something wrong with the problem test cases?

»
3 years ago, # |
  Vote: I like it 0 Vote: I do not like it

You may want replace inf.readChar(' ') by inf.toSpace() in the example (which is more clear in my opinion)

»
3 years ago, # |
Rev. 2   Vote: I like it -8 Vote: I do not like it

Thank for your testlib.h.... it is very useful^_^

»
3 years ago, # |
  Vote: I like it 0 Vote: I do not like it

Thanks for this great tutorial and for this great tool.

Although there might be a typo in the list of methods available: I think it should be: long long readLong(long long L, long long R)

instead of: long long readLong(int L, int R)

I hope this in not a bug in testLib.h as well...

»
2 years ago, # |
  Vote: I like it +5 Vote: I do not like it

Auto comment: topic has been updated by Zlobober (previous revision, new revision, compare).