[−][src]Crate ipopt_sys
Structs
| CNLP_Problem | Structure collecting all information about the problem definition and solve statistics etc. This is defined in the source file. |
| CNLP_SolveResult | The result of one solve including solution and end state |
| CNLP_SolverData | Solution data for one solve. |
Constants
Functions
| cnlp_add_int_option⚠ | Function for adding a CNLP_Int option. Returns 0 if the option could not be set (e.g., if the keyword is unknown) |
| cnlp_add_num_option⚠ | Function for adding a CNLP_Number option. Returns 0 if the option could not be set (e.g., if the keyword is unknown) |
| cnlp_add_str_option⚠ | Function for adding a string option. Returns 0 if the option could not be set (e.g., if the keyword is unknown) |
| cnlp_create_problem⚠ | Function for creating a new CNLP_Problem object. This function returns an object that can be passed to the cnlp_solve call. It contains the basic definition of the optimization problem via various callbacks. |
| cnlp_free_problem⚠ | Method for freeing a previously created CNLP_Problem. After freeing an CNLP_Problem, it cannot be used anymore. |
| cnlp_get_solver_data⚠ | Retrieve solver data for review without having to keep the result of cnlp_solve around. |
| cnlp_init_solution⚠ | Initialize the solution vectors in the nlp. Calling this is required before calling cnlp_get_solver_data. This function will call the necessary initialization callbacks provided by the user. |
| cnlp_open_output_file⚠ | Function for opening an output file for a given name with given printlevel. Returns 0 if there was a problem opening the file. |
| cnlp_set_intermediate_callback⚠ | Setting a callback function for the "intermediate callback" method in the TNLP. This gives control back to the user once per iteration. If set, it provides the user with some information on the state of the optimization. This can be used to print some user-defined output. It also gives the user a way to terminate the optimization prematurely. If the callback method returns 0, Ipopt will terminate the optimization. Calling this set method to set the CB pointer to NULL disables the intermediate callback functionality. |
| cnlp_solve⚠ | Function calling the Ipopt optimization algorithm for a problem previously defined with cnlp_create_problem. The return specified outcome of the optimization procedure (e.g., success, failure etc). |
Type Definitions
| CNLP_AlgorithmMode | An internal state of the Ipopt algorithm. This is reported in intermediate callbacks. |
| CNLP_ApplicationReturnStatus | Return codes for the Optimize call for an application |
| CNLP_Bool | Define a boolean type for C |
| CNLP_Bounds_CB | Type defining the callback function for specifying variable and constraint lower and upper bounds. |
| CNLP_CreateProblemStatus | Enum reporting the status of problem creation |
| CNLP_Eval_F_CB | Type defining the callback function for evaluating the value of the objective function. Return value should be set to 0 if there was a problem doing the evaluation. |
| CNLP_Eval_G_CB | Type defining the callback function for evaluating the value of the constraint functions. Return value should be set to 0 if there was a problem doing the evaluation. |
| CNLP_Eval_Grad_F_CB | Type defining the callback function for evaluating the gradient of the objective function. Return value should be set to 0 if there was a problem doing the evaluation. |
| CNLP_Eval_H_CB | Type defining the callback function for evaluating the Hessian of the Lagrangian function. Return value should be set to 0 if there was a problem doing the evaluation. |
| CNLP_Eval_Jac_G_CB | Type defining the callback function for evaluating the Jacobian of the constrant functions. Return value should be set to 0 if there was a problem doing the evaluation. |
| CNLP_Index | |
| CNLP_Init_CB | Type defining the callback function for initializing variables and multipliers. |
| CNLP_Int | |
| CNLP_Intermediate_CB | Type defining the callback function for giving intermediate execution control to the user. If set, it is called once per iteration, providing the user with some information on the state of the optimization. This can be used to print some user-defined output. It also gives the user a way to terminate the optimization prematurely. If this method returns false, Ipopt will terminate the optimization. |
| CNLP_Number | |
| CNLP_ProblemPtr | Pointer to a CNLP_Problem |
| CNLP_ScalingParams_CB | Type defining the callback function for setting scaling parameters. This method is called if "nlp_scaling_method" is set to "user-scaling". This function is optional. |
| CNLP_Sizes_CB | Type defining the callback function for setting sizes for arrays that will store variables, constraint values and derivatives. |
| CNLP_UserDataPtr | A pointer for anything that is to be passed between the called and individual callback function. |