README.md
1# Fractal sample
2This directory contains an example that finds all solutions to a Sudoku board.
3
4It uses a straightforward state-space search algorithm that exhibits OR-parallelism. It can be optionally run until it obtains just the first solution. The point of the example is to teach how to use the `task_group` interface.
5
6## Building the example
7```
8cmake <path_to_example>
9cmake --build .
10```
11
12## Running the sample
13### Predefined make targets
14* `make run_fractal` - executes the example with predefined parameters.
15* `make perf_run_fractal` - executes the example with suggested parameters to measure the oneTBB performance.
16* `make light_test_fractal` - executes the example with suggested parameters to reduce execution time.
17
18### Application parameters
19Usage:
20```
21sudoku [n-of-threads=value] [filename=value] [verbose] [silent] [find-one] [-h] [n-of-threads [filename]]
22```
23* `-h` - prints the help for command line options.
24* `n-of-threads` - the number of threads to use; a range of the form low\[:high\], where low and optional high are non-negative integers or `auto` for a platform-specific default number.
25* `filename` - the input filename.
26* `verbose` - prints the first solution.
27* `silent` - no output except elapsed time.
28* `find-one` - stops after finding first solution.
29
30The example's directory contains following files that may be used as an input file:
31`input1` - Sample input file with modest number of solutions.
32`input2` - Sample input file with small number of solutions.
33`input3` - Sample input file with larger number of solutions.
34`input4` - Sample input file with very large number of solutions.
35