Difference between revisions of "Implemented Problem Format"

Latest revision as of 02:17, 8 January 2013

Overview

This document describes a standard for distributing and sharing problems for algorithmic programming contests. It is primarily designed for the ACM ICPC but is applicable also to other contests.

All problems must have a "short name" consisting solely of lower case letters a-z and digits 0-9. All files related to a given problem are provided in a directory named after the short name of the problem.

All source code file names must match the following regexp

[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9]

I.e., it must be of length at least 2, consist solely of lower or upper case letters a-z, A-Z, digits 0-9, period, dash or underscore, but must not begin or end with period, dash or underscore.

All text files for a problem should be UTF-8 encoded.

Problem Metadata

Metadata about the problem (e.g., source, license, limits) are provided in a UTF-8 encoded YAML file named <short-name>/problem.yaml.

The keys are defined as below. All keys are optional except rights_owner. Any unknown keys should be ignored.

limits

A map with the following keys:

validator

A space separated list from the following:

Problem Statements

The problem statement of the problem is provided in the directory <short_name>/problem_statement/.

This directory must contain one LaTeX file per language, named problem.<language>.tex, that contains the problem text itself, including input and output specifications, but not sample input and output. Language must be given as an ISO 639-1 alpha-2 language code. Optionally, the language code can be left out, the default is then English.

A template will be provided that \imports this file as well as the sample input and output. The format of the problem statement is described in Problem Statement Template. Files needed by this file must all be in <short_name>/problem_statement/ , problem.tex should reference auxiliary files as if the working directory is <short_name>/problem_statement/.

Test data

The test data are provided in subdirectories of <short_name>/data/. The sample data in <short_name>/data/sample/ and the secret data in <short_name>/data/secret/.

All input and answer files have the filename extension .in and .ans respectively. Optionally descriptions of a data set (a matching pair of .in and .ans files) may be provided, as follows:

1. A text file with filename extension .desc, which is only shown to judges of the judging system.
2. A text file with filename extension .hint, which is shown to all users.

The .desc file is meant to be privileged information, whereas the .hint file is meant to be given to anybody who needs it, i.e. fails to solve the problem. The hint file might not be used at all, depending on how the problem is used, e.g. when used in a programming contest.

Input, answer, and description files are matched by the base name.

Test files will be used in lexicographical order. If a specific order is needed a numbered prefix such as 00, 01, 02, 03, and so on, can be used.

Example Submissions

Correct and incorrect solutions to the problem are provided in a directory <short_name>/submissions/. The submissions/ directory has subdirectories corresponding to the judgement that the programs are supposed to receive:

1. submissions/accepted/: Solutions correctly solving the problem
2. submissions/wrong_answer/: Submissions producing incorrect answers
3. submissions/time_limit_exceeded/: Submissions that are supposed to be too slow
4. submissions/run_time_error/: Submissions that are supposed to crash

Every file or directory in these directories represents a separate solution. Same requirements as for submissions with regards to filenames. It is mandatory to provide at least one accepted solution. Everything else is optional, and empty subdirectories can be omitted.

Input/Output Methods

Submissions must operate in such a way that they receive problem input data on their standard input stream, and write to their standard output stream.

Included Code

Code that should be included with all submissions are provided in one directory per supported language, called <short_name>/include/<language>/.

The files should be copied from a language directory based on the language of the submission, to the submission files before compiling, overwriting files from the submission in the case of name collision. Language must be given as one of the language codes in the table below. If any of the included files are supposed to be the main file (i.e. a driver), that file must have the langage dependent name as given in the table below.

Validators

Input Format Validators

Input Format Validators, for verifying the correctness of the input files, are provided in <short_name>/input_format_validators/. They must adhere to the Input format validator standard.

Output Validators

Output Validators are used if the problem requires more complicated output validation than what is provided by the default diff variant described below. They are provided in <short_name>/output_validators/, and must adhere to the output validator standard.

File Conventions For Validators

A validator is either a file or a directory. A validator in the form of a directory may include two scripts "build" and "run". Either both or none of these scripts must be included. If the scripts are present, then:

• validator must be compiled by executing the build script.
• the validator must be run by executing the run script.

Otherwise, the validator will be compiled and run as if it was a submission (except that it is given the command-line arguments specified in problem.yaml, if there are any).

Default Validator Capabilities

The default validator is essentially a beefed-up diff. In its default mode, it tokenizes the files to compare and compares them token by token. It supports the following command-line arguments to control how tokens are compared.

When supplying both a relative and an absolute tolerance, the semantics are that a token is accepted if it is within either of the two tolerances. When a floating-point tolerance has been set, any valid formatting of floating point numbers is accepted for floating point tokens. So for instance if a token in the answer file says 0.0314, a token of 3.14000000e-2 in the output file would be accepted. If no floating point tolerance has been set, floating point tokens are treated just like any other token and has to match exactly.

Determination of Time Limit

The execution time limit for the problem is determined as follows. First, all the provided accepted/ solutions are run. Let t_max be the maximum running time of these solutions on any of the input files. The time limit is then set to be t_lim = ⌈t_max · M⌉ where M is the value of the time multiplier parameter from the limits configuration of problem.yaml.

Furthermore, it is required that all of the provided time limit exceeded submissions run for at least t_lim · S seconds, where S is the value of the time safety margin parameter from the limits configuration.

Verification

Solutions or validators in languages that are not supported by the CCS should be ignored and a warning to that effect shown.

Verification Checks (in order)

1. Check files (all files present as required + check problem.yaml)
2. Check compile (check that all programs compile)
3. Check input (run input validators)
4. Check solutions (run all solutions check that they get the expected verdicts)

Warn if:
      there are no *.in in data/sample/

Error if:
      there is no problem.yaml
      there is no problem statement (i.e., a problem*.tex file)
      any value in problem.yaml is invalid
      there are no *.in in data/secret/
      there are .in files without corresponding .ans files in data/*/
      there are .ans files without corresponding .in files in data/*/
      there are no solutions in submissions/accepted/
      there are no validators in input_format_validators/
      validator begins with "custom" and there are no validators in output_validators/
      there are validators in output_validators/ and validator does not begin with "custom"
      any validator (input format or output) does not compile

For each *.in in public_data and judge_data:
      For each validator in input_format_validators/:
              If the validator does not accept the input file: Error!

For each solution in test_submissions/accepted/:
      For each *.in in data/*/:
              Run the solution on the input
              For the built-in validator if corrector is "diff" or each validator in output_validators/:
                      If the validator does not accept the output of the solution: Error!
Let t be the longest time any of the solutions ran on any of the inputs.

For each solution in submissions/time_limit_exceeded/:
      For each *.in in data/*/:
              Run the solution on the input for at least t * time_limit_safety_margin seconds.
Let t_slow be the shortest time any of the solutions ran on any of the inputs.

If t_slow is less than t * time_limit_safety_margin: Error!

For each solution in submissions/wrong_answer/:
      For each *.in in data/*/:
              Run the solution on the input
              For the built-in validator if corrector = "diff" or each validator in output_validators/:
                      If the validator accepts the output of the solution: Error!

For each solution in submissions/run_time_error/:
      For each *.in in data/*/:
              Run the solution on the input
              If the solution is not judged Run-Time Error: Error!

Appendix

Configuration file format

problem.yaml is a UTF-8 encoded YAML file consisting of a mapping with the following keys:

limits

A sequence of mappings with the following keys:

Sample problem.yaml

Typical problem.yaml:

# Problem configuration
source: ICPC Mid-Atlantic Regional Contest
author: John von Judge 
rights_owner: ICPC

Maximal problem.yaml:

# Problem configuration
source: ICPC Mid-Atlantic Regional Contest
author: John von Judge 
license: cc by-sa  
rights_owner: ICPC

limits:
   time_multiplier: 5
   time_safety_margin: 2
   memory: 4096  
   output: 16 
   compilation_time: 240
   validation_time: 240
   validation_memory: 3072
   validation_output: 4

validator: space_change_sensitive float_absolute_tolerance 1e-6

Directory structure

<short_name>/
      problem.yaml - problem configuration file
      problem_statement/
              problem.tex - problem statement
              - any files that problem.tex needs to include, e.g. images
      data/
              sample/
                      *.in - sample input files
                      *.ans - sample answer files
              secret/
                      *.in - input files
                      *.ans - answer files
                      *.txt - optional data file description
      submissions/
              accepted/
                      - single file or directory per solution
              wrong_answer/
                      - single file or directory per solution
              time_limit_exceeded/
                      - single file or directory per solution
              run_time_error/
                      - single file or directory per solution
      input_format_validators/
              - single file or directory per validator
      output_validators/
              - single file or directory per validator

Sample Directory / Filenames

This is a sample list of directories/files for a problem named squares

squares/problem.yaml
squares/problem_statement/problem.en.tex
squares/problem_statement/problem.sv.tex
squares/problem_statement/square1.png
squares/problem_statement/square2.png
squares/data/sample/squares_sample1.in 
squares/data/sample/squares_sample1.ans
squares/data/sample/squares_sample2.in 
squares/data/sample/squares_sample2.ans
squares/data/secret/squares1.in 
squares/data/secret/squares1.ans
squares/data/secret/squares1.txt
squares/data/secret/squares2_cornercases.in 
squares/data/secret/squares2_cornercases.ans
squares/data/secret/squares3_bigcases.in
squares/data/secret/squares3_bigcases.ans
squares/submissions/accepted/squares.cpp
squares/submissions/accepted/Squares.java
squares/submissions/accepted/squares.c
squares/submissions/wrong_answer/wrong.cpp
squares/submissions/time_limit_exceeded/tle.c
squares/submissions/run_time_error/rte.c
squares/input_format_validators/squares_input_checker1.py
squares/input_format_validators/squares_input_checker2/check.c
squares/input_format_validators/squares_input_checker2/data.h
squares/output_validators/squares_validator/validator.f
squares/output_validators/squares_validator/build
squares/output_validators/squares_validator/run