diff options
Diffstat (limited to 'src/nissy.h')
| -rw-r--r-- | src/nissy.h | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/src/nissy.h b/src/nissy.h index b5abc15..c85072a 100644 --- a/src/nissy.h +++ b/src/nissy.h | |||
| @@ -304,7 +304,8 @@ Parameters: | |||
| 304 | data_size - The size of the data buffer. It is advised to use | 304 | data_size - The size of the data buffer. It is advised to use |
| 305 | nissy_solverinfo to check how much memory is needed. | 305 | nissy_solverinfo to check how much memory is needed. |
| 306 | data - The return parameter for the generated data. | 306 | data - The return parameter for the generated data. |
| 307 | This buffer must have 8-byte alignment. | 307 | This buffer must have 8-byte alignment. Some solvers (such as |
| 308 | h48) will perform better if the buffer is 64-byte aligned. | ||
| 308 | 309 | ||
| 309 | Return values: | 310 | Return values: |
| 310 | NISSY_ERROR_INVALID_SOLVER - The given solver is not known. | 311 | NISSY_ERROR_INVALID_SOLVER - The given solver is not known. |
| @@ -328,7 +329,10 @@ Parameters: | |||
| 328 | solver - The name of the solver. | 329 | solver - The name of the solver. |
| 329 | data_size - The size of the data buffer. | 330 | data_size - The size of the data buffer. |
| 330 | data - The data for the solver. Can be computed with gendata. | 331 | data - The data for the solver. Can be computed with gendata. |
| 331 | This buffer must have 8-byte alignment. | 332 | This buffer must have 8-byte alignment. Some solvers (such as |
| 333 | h48) will perform better if the buffer is 64-byte aligned, but | ||
| 334 | this is not relevant for the purpose of checking the integrity | ||
| 335 | of the data. | ||
| 332 | 336 | ||
| 333 | Return values: | 337 | Return values: |
| 334 | NISSY_OK - The data is valid. | 338 | NISSY_OK - The data is valid. |
| @@ -358,7 +362,9 @@ Parameters: | |||
| 358 | to 0, the default value THREADS will be used. | 362 | to 0, the default value THREADS will be used. |
| 359 | data_size - The size of the data buffer. | 363 | data_size - The size of the data buffer. |
| 360 | data - The data for the solver. Can be computed with gendata. | 364 | data - The data for the solver. Can be computed with gendata. |
| 361 | This buffer must have 8-byte alignment. | 365 | This buffer must have 8-byte alignment. Some solvers |
| 366 | (such as h48) will perform better if the buffer is | ||
| 367 | 64-byte aligned. | ||
| 362 | sols_size - The size of the solutions buffer. | 368 | sols_size - The size of the solutions buffer. |
| 363 | sols - The return parameter for the solutions. The solutions are | 369 | sols - The return parameter for the solutions. The solutions are |
| 364 | separated by a '\n' (newline) and a '\0' (NULL character) | 370 | separated by a '\n' (newline) and a '\0' (NULL character) |
