aboutsummaryrefslogtreecommitdiff
path: root/src/nissy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/nissy.h')
-rw-r--r--src/nissy.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/nissy.h b/src/nissy.h
index 94c604c..6c5a3e6 100644
--- a/src/nissy.h
+++ b/src/nissy.h
@@ -216,11 +216,14 @@ Parameters:
216 data_size - The size of the data buffer. It is advised to use nissy_datasize 216 data_size - The size of the data buffer. It is advised to use nissy_datasize
217 to check how much memory is needed. 217 to check how much memory is needed.
218 data - The return parameter for the generated data. 218 data - The return parameter for the generated data.
219 This buffer must have 8-byte alignment.
219 220
220Return values: 221Return values:
221 NISSY_ERROR_INVALID_SOLVER - The given solver is not known. 222 NISSY_ERROR_INVALID_SOLVER - The given solver is not known.
222 NISSY_ERROR_NULL_POINTER - The 'solver' argument is null. 223 NISSY_ERROR_NULL_POINTER - The 'solver' argument is null.
223 NISSY_ERROR_UNKNOWN - An error occurred while generating the data. 224 NISSY_ERROR_UNKNOWN - An error occurred while generating the data.
225 NISSY_ERROR_DATA - The data buffer is invalid, for example because
226 it is not 8-byte aligned.
224 Any value >= 0 - The size of the data, in bytes. 227 Any value >= 0 - The size of the data, in bytes.
225*/ 228*/
226long long 229long long
@@ -236,6 +239,7 @@ Check that the data is a valid data table for a solver.
236Parameters: 239Parameters:
237 data_size - The size of the data buffer. 240 data_size - The size of the data buffer.
238 data - The data for the solver. Can be computed with gendata. 241 data - The data for the solver. Can be computed with gendata.
242 This buffer must have 8-byte alignment.
239 243
240Return values: 244Return values:
241 NISSY_OK - The data is valid. 245 NISSY_OK - The data is valid.
@@ -264,6 +268,7 @@ Parameters:
264 the default value THREADS will be used. 268 the default value THREADS will be used.
265 data_size - The size of the data buffer. 269 data_size - The size of the data buffer.
266 data - The data for the solver. Can be computed with gendata. 270 data - The data for the solver. Can be computed with gendata.
271 This buffer must have 8-byte alignment.
267 sols_size - The size of the solutions buffer. 272 sols_size - The size of the solutions buffer.
268 sols - The return parameter for the solutions. The solutions are 273 sols - The return parameter for the solutions. The solutions are
269 separated by a '\n' (newline) and a '\0' (NULL character) 274 separated by a '\n' (newline) and a '\0' (NULL character)
@@ -278,6 +283,7 @@ Return values:
278 NISSY_ERROR_OPTIONS - One or more of the given options are invalid. 283 NISSY_ERROR_OPTIONS - One or more of the given options are invalid.
279 NISSY_ERROR_INVALID_SOLVER - The given solver is not known. 284 NISSY_ERROR_INVALID_SOLVER - The given solver is not known.
280 NISSY_ERROR_NULL_POINTER - The 'solver' argument is null. 285 NISSY_ERROR_NULL_POINTER - The 'solver' argument is null.
286 NISSY_ERROR_DATA - The data buffer is invalid.
281 Any value >= 0 - The number of solutions found. 287 Any value >= 0 - The number of solutions found.
282*/ 288*/
283long long 289long long

Generated with cgit - Back to sebastiano.tronto.net