Asynchronous Solving

Detailed Description

Solve in the background and notify about new models.

Clingo provides two additional ways to handle solving: Iterative Solving and Asynchronous Solving. With asynchronous solving, the solving process is executed in the background, and each newly found model is signalled via a model callback.

For an example, see solve-async.c.

Typedefs
typedef struct clingo_solve_async	clingo_solve_async_t
	Search handle to an asynchronous solve call. More...

Functions
CLINGO_VISIBILITY_DEFAULT bool	clingo_solve_async_get (clingo_solve_async_t *handle, clingo_solve_result_bitset_t *result)
	Get the solve result. More...
CLINGO_VISIBILITY_DEFAULT bool	clingo_solve_async_wait (clingo_solve_async_t *handle, double timeout, bool *result)
	Wait for the specified amount of time to check if the search has finished. More...
CLINGO_VISIBILITY_DEFAULT bool	clingo_solve_async_cancel (clingo_solve_async_t *handle)
	Stop the running search. More...

Typedef Documentation

typedef struct clingo_solve_async clingo_solve_async_t

Search handle to an asynchronous solve call.

See also

clingo_control_solve_async()

Function Documentation

CLINGO_VISIBILITY_DEFAULT bool clingo_solve_async_cancel

(

clingo_solve_async_t *

handle

)

Stop the running search.

Blocks until the search is stopped.

Parameters

[in]

handle

the target

Returns

whether the call was successful; might set one of the following error codes:

• clingo_error_bad_alloc
• clingo_error_runtime if solving fails

CLINGO_VISIBILITY_DEFAULT bool clingo_solve_async_get	(	clingo_solve_async_t *	handle,
		clingo_solve_result_bitset_t *	result
	)

Get the solve result.

Blocks until the search is completed.

Parameters

[in]	handle	the target
[out]	result	the solve result

Returns

whether the call was successful; might set one of the following error codes:

• clingo_error_bad_alloc
• clingo_error_runtime if solving fails

Examples:

solve-async.c.

CLINGO_VISIBILITY_DEFAULT bool clingo_solve_async_wait	(	clingo_solve_async_t *	handle,
		double	timeout,
		bool *	result
	)

Wait for the specified amount of time to check if the search has finished.

If the time is set to zero, this function can be used to poll if the search is still running.

Parameters

[in]	handle	the target
[in]	timeout	the maximum time to wait
[out]	result	whether the search is still running

Returns

whether the call was successful; might set one of the following error codes:

• clingo_error_bad_alloc
• clingo_error_runtime if solving fails