Problem Options Reference

This page is generated from Hull’s problem Nix module options during the documentation build.

The checker program, which compares a solution’s output with the correct answer.

Type: submodule

The programming language of the source file. It is automatically detected from the file extension.

Type: non-empty string (read only)

Default:

hull.language.matchBaseName (baseNameOf config.src) problem.languages

Controls the visibility of this program to participants.

no: Not visible.
src: Source code is visible.
wasm: Compiled WASM is visible.

Type: string matching the pattern no|src|wasm

Default:

"no"

Path to the source file of the program.

Type: path in the Nix store

The result of tests.

Type: attribute set of (submodule) (read only)

Default:

"Loaded from runtime analysis data."

Internal evaluator trace information from the checker.

Type: list of (attribute set)

Default:

[ ]

A message from the checker.

Type: string

Internal reader trace information from the checker.

Type: list of (attribute set)

Default:

[ ]

The score of the check, where the full score is 1.0.

Type: integer or floating point number between 0 and 1 (both inclusive)

The status of the check.

Type: string matching the pattern internal_error|accepted|wrong_answer|partially_correct

An attribute set of tests for the checker itself.

Type: attribute set of (submodule)

Default:

{ }

A list of string arguments to pass to the generator program.

Type: null or (list of string)

Default:

null

The name of the generator to use for creating the input file.

Type: null or non-empty string

Default:

null

A store path to a manually provided input file.

Type: null or path in the Nix store

Default:

null

The fully resolved input file used by this checker test.

Type: path in the Nix store (read only)

Default:

"Loaded from runtime analysis data."

The name of the test, derived from its attribute name in the tests set.

Type: string matching the pattern [a-zA-Z_][a-zA-Z0-9_\-]* (read only)

Default:

"‹name›"

A store path to a manually provided output file.

Type: null or path in the Nix store

Default:

null

The name of output file, used to select the output name when solution returns multiple outputs.

Type: string

Default:

"output"

The fully resolved output file when this checker test uses a static output file.

Type: null or path in the Nix store (read only)

Default:

null

The solution name used to generate the output file when outputFile is not provided.

Type: null or non-empty string (read only)

Default:

null

A function that takes the check report and returns true if the test passes.

Type: function that evaluates to a(n) boolean

Whether the prediction holds for this test case.

Type: boolean (read only)

Default:

"Whether the prediction holds for this test case."

The result of this test.

Type: submodule (read only)

Default:

"Loaded from runtime analysis data."

Internal evaluator trace information from the checker.

Type: list of (attribute set)

Default:

[ ]

A message from the checker.

Type: string

Internal reader trace information from the checker.

Type: list of (attribute set)

Default:

[ ]

The score of the check, where the full score is 1.0.

Type: integer or floating point number between 0 and 1 (both inclusive)

The status of the check.

Type: string matching the pattern internal_error|accepted|wrong_answer|partially_correct

The name of a solution (from problem.solutions) to run to get the output file.

Type: null or non-empty string

Default:

null

The compiled WASM artifact of the program.

Type: package (read only)

Default:

(problem.languages.${config.language}).compile.executable.drv { ... }

Display problem title for each language.

Type: attribute set of string

Default:

{ }

Example:

{
  en = "example problem";
  zh = "示例题目";
}

An attribute set of documents for the problem.

Type: attribute set of (submodule)

Default:

{ }

The display language of this document.

Type: string

Example:

"en"

The visibility of this document to participants.

Type: boolean

Default:

false

The path of this document.

Type: path in the Nix store

Extra special arguments passed in when evalProblem.

Type: raw value (read only)

Full score of this problem

Type: nonnegative integer or floating point number, meaning >=0 (read only)

Default:

"The sum of the full score of all subtasks."

An attribute set of generator programs used to create test case inputs.

Type: attribute set of (submodule)

Default:

{ }

The programming language of the source file. It is automatically detected from the file extension.

Type: non-empty string (read only)

Default:

hull.language.matchBaseName (baseNameOf config.src) problem.languages

Controls the visibility of this program to participants.

no: Not visible.
src: Source code is visible.
wasm: Compiled WASM is visible.

Type: string matching the pattern no|src|wasm

Default:

"no"

Path to the source file of the program.

Type: path in the Nix store

The compiled WASM artifact of the program.

Type: package (read only)

Default:

(problem.languages.${config.language}).compile.executable.drv { ... }

A list of paths to be added as include directories for compilation.

Type: list of path in the Nix store

Default:

[ ]

The judger implementation to use for evaluating solutions.

Type: hullJudger

Default:

hull.judger.batch config { }

The attribute set of available programming languages and their compilation logic.

Type: attribute set of (submodule)

Default:

hull.language.commons

Compile functions.

Type: submodule

The executable compilation interface.

Type: submodule

The function used to link a source file and object files into an executable derivation.

Type: function that evaluates to a(n) path in the Nix store

The function used to produce a shell script fragment that links a source file and object files into an executable.

Type: function that evaluates to a(n) strings concatenated with “\n”

The object compilation interface.

Type: submodule

The function used to compile a source file into a linkable object file derivation.

Type: function that evaluates to a(n) path in the Nix store

The function used to produce a shell script fragment that compiles a source file into a linkable object file.

Type: function that evaluates to a(n) strings concatenated with “\n”

The single solution marked with mainCorrectSolution = true. This is used to generate the official answer files for test cases.

Type: attribute set (read only)

Default:

"The solution in `config.solutions` for which `mainCorrectSolution` is set to `true`."

The default memory limit in bytes for solutions. Can be overridden per test case.

Type: unsigned integer, meaning >=0

Default:

null

The unique name of the problem, used in derivations and outputs.

Type: string matching the pattern [a-zA-Z_][a-zA-Z0-9_\-]*

Example:

"exampleProblem"

User problem configuration passed in when evalProblem.

Type: raw value (read only)

Aggregated runtime analysis data injected before packaging and reporting.

Type: attribute set

Default:

"Runtime analysis data loaded by the Hull CLI."

A list of test cases with sample or sampleLarge group.

Type: list of (attribute set) (read only)

Default:

"A filtered list of `problem.testCases` with `sample` or `sampleLarge` group."

An attribute set of solutions for the problem, including correct and incorrect ones.

Type: attribute set of (submodule)

Default:

{ }

Whether this solution is the main correct one, used to generate answer files. Exactly one solution must have this set to true.

Type: boolean

Default:

false

The name of the solution, derived from its attribute name in the solutions set.

Type: string matching the pattern [a-zA-Z_][a-zA-Z0-9_\-]* (read only)

Default:

"‹name›"

The visibility of this solution to participants.

Type: boolean

Default:

false

This final score of the entire problem for this solution.

Type: floating point number (read only)

Default:

"Loaded from runtime analysis data."

Path to the source file or directory of the solution.

Type: absolute path

A prediction for each subtask, expressed as a function that takes an attributes set of raw score (0.0-1.0) and statuses, and then returns true if the prediction is met.

Type: attribute set of function that evaluates to a(n) boolean

Default:

{ }

Example:

{
  "0" = { score, ... }: score >= 0.5;
  "1" = { statuses, ... }: builtins.all (s: s == "accepted" || s == "time_limit_exceeded") statuses;
}

The collected results of this solution against all subtasks.

Type: list of (submodule) (read only)

Default:

"Loaded from runtime analysis data."

The lowest score of all test cases in this subtask, with a maximum score of 1.

Type: integer or floating point number between 0 and 1 (both inclusive)

The lowest score of all test cases in this subtask, with a maximum score of fullScore defined in subtask options.

Type: floating point number

The result status of all test cases in this subtask. Already sorted and deduplicated.

Default:

[ ]

The results of test cases in this subtask.

Type: attribute set of (submodule)

The memory in bytes of judgement.

Type: unsigned integer, meaning >=0

The message of judgement.

Type: string

A nix store path. Each file in this directory is an output data file.

Type: path in the Nix store

The score of judgement, with a maximum score of 1.

Type: integer or floating point number between 0 and 1 (both inclusive)

The status of judgement.

The WASM tick of judgement.

Type: unsigned integer, meaning >=0

The collected results of running and checking this solution against all test cases.

Type: attribute set of (submodule) (read only)

Default:

"Loaded from runtime analysis data."

The memory in bytes of judgement.

Type: unsigned integer, meaning >=0

The message of judgement.

Type: string

A nix store path. Each file in this directory is an output data file.

Type: path in the Nix store

The score of judgement, with a maximum score of 1.

Type: integer or floating point number between 0 and 1 (both inclusive)

The status of judgement.

The WASM tick of judgement.

Type: unsigned integer, meaning >=0

A list of subtasks, where each subtask is defined by a set of required traits.

Type: list of (submodule)

Default:

[
  {
    fullScore = 1.0;
  }
]

The full score of this subtask.

Type: floating point number

Scoring method for this subtask.

Type: string matching the pattern min|sum

Default:

"min"

A list of test cases that match the traits defined for this subtask.

Type: list of (attribute set) (read only)

Default:

"A filtered list of `problem.testCases` matching the subtask's traits."

An attribute set of traits that a test case must have to belong to this subtask.

Type: attribute set of boolean

Default:

{ }

The final derivation outputs for each defined target.

Type: attribute set of package (read only)

Default:

builtins.mapAttrs (targetName: target: target config) config.targets

An attribute set of build targets for the problem, defining final package structures.

Type: attribute set of hullProblemTarget

Default:

{ }

An attribute set defining all test cases for the problem.

Type: attribute set of (submodule)

Default:

{ }

A list of string arguments to pass to the generator program.

Type: null or (list of string)

Default:

null

Read-only container for the test case’s input and output data paths.

Type: submodule (read only)

Default:

{ }

The store path to the input data file. It’s either taken from inputFile or generated by generator.

Type: path in the Nix store (read only)

Default:

"Loaded from runtime analysis data."

A nix store path generated by running mainCorrectSolution. Each file in this directory is a correct output data file.

Type: path in the Nix store (read only)

Default:

"Loaded from runtime analysis data."

The description of this test case for each display language, usually used for samples.

Type: attribute set of string

Default:

{ }

The name of the generator (from the top-level generators set) to use for creating the input file. If set, inputFile should be null.

Type: null or non-empty string

Default:

null

The groups to which this test case belongs.

Type: list of string matching the pattern [a-zA-Z_][a-zA-Z0-9_\-]*

Default:

[ ]

Example:

[
  "sample"
  "pretest"
]

A store path to a manually provided input file. If set, generator should be null.

Type: null or path in the Nix store

Default:

null

The result of running the validator on the test case’s input data.

Type: submodule (read only)

Default:

"Loaded from runtime analysis data."

A message from the validator.

Type: string

Internal trace information from the validator’s input readers.

Type: list of (attribute set)

Default:

[ ]

Internal trace tree from the validator.

Type: attribute set

Default:

{ }

The status of the validation: valid or invalid.

Type: string matching the pattern internal_error|valid|invalid

The set of traits automatically detected by the validator from the input data.

Type: attribute set of boolean

Default:

{ }

Memory limit in bytes for this specific test case.

Type: unsigned integer, meaning >=0

Default:

problem.memoryLimit

The name of the test case, derived from its attribute name in the testCases set.

Type: string matching the pattern [a-zA-Z_][a-zA-Z0-9_\-]* (read only)

Default:

"‹name›"

Execution time limit in ticks for this specific test case.

Type: unsigned integer, meaning >=0

Default:

problem.tickLimit

An attribute set of declared trait hints for this test case.

In normal workflows this is only a hint or a subset of the traits that will actually be observed by the validator at runtime. Unless a feature explicitly documents otherwise, scoring, subtask membership, and any other evaluation logic must use runtime validator traits instead of trusting this metadata field.

Type: attribute set of boolean

Default:

{ }

The default execution time limit in ticks for solutions. Can be overridden per test case.

Type: unsigned integer, meaning >=0

Default:

null

An attribute set of all possible traits that can be used to categorize test cases and define subtasks.

Type: attribute set of (submodule)

Default:

{ }

The description of this trait for each display language.

Type: attribute set of string

Default:

{ }

Example:

{
  en = "$a$ is a positive integer.";
  zh = "$a$ 为正整数";
}

The validator program, which verifies if a test case’s input data is valid.

Type: submodule

The programming language of the source file. It is automatically detected from the file extension.

Type: non-empty string (read only)

Default:

hull.language.matchBaseName (baseNameOf config.src) problem.languages

Controls the visibility of this program to participants.

no: Not visible.
src: Source code is visible.
wasm: Compiled WASM is visible.

Type: string matching the pattern no|src|wasm

Default:

"no"

Path to the source file of the program.

Type: path in the Nix store

The result of tests.

Type: attribute set of (submodule) (read only)

Default:

"Loaded from runtime analysis data."

A message from the validator.

Type: string

Internal trace information from the validator’s input readers.

Type: list of (attribute set)

Default:

[ ]

Internal trace tree from the validator.

Type: attribute set

Default:

{ }

The status of the validation: valid or invalid.

Type: string matching the pattern internal_error|valid|invalid

The set of traits automatically detected by the validator from the input data.

Type: attribute set of boolean

Default:

{ }

An attribute set of tests for the validator itself.

Type: attribute set of (submodule)

Default:

{ }

A list of string arguments to pass to the generator program.

Type: null or (list of string)

Default:

null

The name of the generator to use for creating the input file.

Type: null or non-empty string

Default:

null

A store path to a manually provided input file.

Type: null or path in the Nix store

Default:

null

The fully resolved input file used by this validator test.

Type: path in the Nix store (read only)

Default:

"Loaded from runtime analysis data."

The name of the test, derived from its attribute name in the tests set.

Type: string matching the pattern [a-zA-Z_][a-zA-Z0-9_\-]* (read only)

Default:

"‹name›"

A function that takes the validation report and returns true if the test passes.

Type: function that evaluates to a(n) boolean

Whether the prediction holds for this test case.

Type: boolean (read only)

Default:

"Whether the prediction holds for this test case."

The result of this test.

Type: submodule (read only)

Default:

"Loaded from runtime analysis data."

A message from the validator.

Type: string

Internal trace information from the validator’s input readers.

Type: list of (attribute set)

Default:

[ ]

Internal trace tree from the validator.

Type: attribute set

Default:

{ }

The status of the validation: valid or invalid.

Type: string matching the pattern internal_error|valid|invalid

The set of traits automatically detected by the validator from the input data.

Type: attribute set of boolean

Default:

{ }

The compiled WASM artifact of the program.

Type: package (read only)

Default:

(problem.languages.${config.language}).compile.executable.drv { ... }

Keyboard shortcuts

Hull Documentation

checker

checker.language

checker.participantVisibility

checker.src

checker.testResults

checker.testResults.<name>.evaluatorTraceStacks

checker.testResults.<name>.message

checker.testResults.<name>.readerTraceStacks

checker.testResults.<name>.score

checker.testResults.<name>.status

checker.tests

checker.tests.<name>.arguments

checker.tests.<name>.generator

checker.tests.<name>.inputFile

checker.tests.<name>.inputPath

checker.tests.<name>.name

checker.tests.<name>.outputFile

checker.tests.<name>.outputName

checker.tests.<name>.outputPath

checker.tests.<name>.outputSolution

checker.tests.<name>.prediction

checker.tests.<name>.predictionHolds

checker.tests.<name>.result

checker.tests.<name>.result.evaluatorTraceStacks

checker.tests.<name>.result.message

checker.tests.<name>.result.readerTraceStacks

checker.tests.<name>.result.score

checker.tests.<name>.result.status

checker.tests.<name>.solution

checker.wasm

displayName

documents

documents.<name>.displayLanguage

documents.<name>.participantVisibility

documents.<name>.path

extraSpecialArgs

fullScore

generators

generators.<name>.language

generators.<name>.participantVisibility

generators.<name>.src

generators.<name>.wasm

includes

judger

languages

languages.<name>.compile

languages.<name>.compile.executable

languages.<name>.compile.executable.drv

languages.<name>.compile.executable.script

languages.<name>.compile.object

languages.<name>.compile.object.drv

languages.<name>.compile.object.script

mainCorrectSolution

memoryLimit

name

problemAttrs

runtimeData

samples

solutions

solutions.<name>.mainCorrectSolution

solutions.<name>.name

solutions.<name>.participantVisibility

solutions.<name>.score

solutions.<name>.src

solutions.<name>.subtaskPredictions

solutions.<name>.subtaskResults

solutions.<name>.subtaskResults.*.rawScore

solutions.<name>.subtaskResults.*.scaledScore

solutions.<name>.subtaskResults.*.statuses

solutions.<name>.subtaskResults.*.testCases

solutions.<name>.subtaskResults.*.testCases.<name>.memory

solutions.<name>.subtaskResults.*.testCases.<name>.message

solutions.<name>.subtaskResults.*.testCases.<name>.outputs

solutions.<name>.subtaskResults.*.testCases.<name>.score

solutions.<name>.subtaskResults.*.testCases.<name>.status

solutions.<name>.subtaskResults.*.testCases.<name>.tick

solutions.<name>.testCaseResults