Optim_Siman_Current_Solution_State_Get()
Abstract
Gets the state of the current solution in an optimization engine instance.
Syntax
Optim_Siman_Current_Solution_State_Get (optim_handle)
| Argument | Type | Description |
|---|---|---|
optim_handle |
OptimT_Siman_Handle |
The handle to the optimization engine instance whose current solution state should be obtained. |
Return Type
void*
Should actually be of the same type used to initialize the solution_state_ptr in Optim_Siman_Solver_Create().
Header
optim_siman.h
Details
This procedure is used to get the state of the solution that is current, according to the optimization engine.
The client should ensure that the engine is not actually running when this call is made, since the returned pointer could be freed unexpectedly if the engine is running. Therefore, the engine should be:
- Initialized with Optim_Siman_Solver_Create(), but not started with Optim_Siman_Solver_Execute()
- Paused with Optim_Siman_Pause()
- Stopped with Optim_Siman_Stop()
- Completed, meaning the engine’s finish_proc from Optim_Siman_Solver_Create() has been called, or
- Within a callback, and thus the engine is blocking and waiting for the callback to return.