IpStdCInterface.h

Go to the documentation of this file.

/* Copyright (C) 2004, 2010 International Business Machines and others.
 * All Rights Reserved.
 * This code is published under the Eclipse Public License.
 *
 * Authors:  Carl Laird, Andreas Waechter     IBM    2004-09-02
 */
 
#ifndef __IPSTDCINTERFACE_H__
#define __IPSTDCINTERFACE_H__
 
#include <stdbool.h>
 
#include "IpoptConfig.h"
#include "IpTypes.h"
#include "IpReturnCodes.h"
 
#ifndef IPOPT_EXPORT
#define IPOPT_EXPORT(type) type IPOPT_CALLCONV
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
IPOPT_DEPRECATED
typedef ipnumber Number;
 
IPOPT_DEPRECATED
typedef int Index;
 
IPOPT_DEPRECATED
typedef int Int;
 
struct IpoptProblemInfo;
 
typedef struct IpoptProblemInfo* IpoptProblem;
 
typedef bool Bool;
#ifndef TRUE
/* @deprecated Use true instead. */
# define TRUE (1)
#endif
/* @deprecated Use false instead. */
#ifndef FALSE
# define FALSE (0)
#endif
 
typedef void* UserDataPtr;
 
typedef bool (*Eval_F_CB)(
   ipindex     n,
   ipnumber*   x,
   bool        new_x,
   ipnumber*   obj_value,
   UserDataPtr user_data
);
 
typedef bool (*Eval_Grad_F_CB)(
   ipindex     n,
   ipnumber*   x,
   bool        new_x,
   ipnumber*   grad_f,
   UserDataPtr user_data
);
 
typedef bool (*Eval_G_CB)(
   ipindex     n,
   ipnumber*   x,
   bool        new_x,
   ipindex     m,
   ipnumber*   g,
   UserDataPtr user_data
);
 
typedef bool (*Eval_Jac_G_CB)(
   ipindex     n,
   ipnumber*   x,
   bool        new_x,
   ipindex     m,
   ipindex     nele_jac,
   ipindex*    iRow,
   ipindex*    jCol,
   ipnumber*   values,
   UserDataPtr user_data
);
 
typedef bool (*Eval_H_CB)(
   ipindex     n,
   ipnumber*   x,
   bool        new_x,
   ipnumber    obj_factor,
   ipindex     m,
   ipnumber*   lambda,
   bool        new_lambda,
   ipindex     nele_hess,
   ipindex*    iRow,
   ipindex*    jCol,
   ipnumber*   values,
   UserDataPtr user_data
);
 
typedef bool (*Intermediate_CB)(
   ipindex     alg_mod,   
   ipindex     iter_count,
   ipnumber    obj_value, 
   ipnumber    inf_pr,    
   ipnumber    inf_du,    
   ipnumber    mu,        
   ipnumber    d_norm,    
   ipnumber    regularization_size,  
   ipnumber    alpha_du,  
   ipnumber    alpha_pr,  
   ipindex     ls_trials, 
   UserDataPtr user_data  
);
 
IPOPTLIB_EXPORT IpoptProblem IPOPT_CALLCONV CreateIpoptProblem(
   ipindex       n,           
   ipnumber*     x_L,         
   ipnumber*      x_U,         
   ipindex        m,           
   ipnumber*      g_L,         
   ipnumber*      g_U,         
   ipindex        nele_jac,    
   ipindex        nele_hess,   
   ipindex        index_style, 
   Eval_F_CB      eval_f,      
   Eval_G_CB      eval_g,      
   Eval_Grad_F_CB eval_grad_f, 
   Eval_Jac_G_CB  eval_jac_g,  
   Eval_H_CB      eval_h       
);
 
IPOPTLIB_EXPORT void IPOPT_CALLCONV FreeIpoptProblem(
   IpoptProblem ipopt_problem
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV AddIpoptStrOption(
   IpoptProblem ipopt_problem,
   char*        keyword,
   char*        val
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV AddIpoptNumOption(
   IpoptProblem ipopt_problem,
   char*        keyword,
   ipnumber     val
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV AddIpoptIntOption(
   IpoptProblem ipopt_problem,
   char*        keyword,
   ipindex      val
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV OpenIpoptOutputFile(
   IpoptProblem ipopt_problem,
   char*        file_name,
   int          print_level
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV SetIpoptProblemScaling(
   IpoptProblem ipopt_problem,
   ipnumber     obj_scaling,
   ipnumber*    x_scaling,
   ipnumber*    g_scaling
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV SetIntermediateCallback(
   IpoptProblem    ipopt_problem,
   Intermediate_CB intermediate_cb
);
 
IPOPTLIB_EXPORT enum ApplicationReturnStatus IPOPT_CALLCONV IpoptSolve(
   IpoptProblem ipopt_problem, 
   ipnumber*    x,             
   ipnumber*    g,             
   ipnumber*    obj_val,       
   ipnumber*    mult_g,        
   ipnumber*    mult_x_L,      
   ipnumber*    mult_x_U,      
   UserDataPtr  user_data      
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV GetIpoptCurrentIterate(
   IpoptProblem    ipopt_problem,
   bool            scaled,
   ipindex         n,
   ipnumber*       x,
   ipnumber*       z_L,
   ipnumber*       z_U,
   ipindex         m,
   ipnumber*       g,
   ipnumber*       lambda
);
 
IPOPTLIB_EXPORT bool IPOPT_CALLCONV GetIpoptCurrentViolations(
   IpoptProblem  ipopt_problem,
   bool          scaled,
   ipindex       n,
   ipnumber*     x_L_violation,
   ipnumber*     x_U_violation,
   ipnumber*     compl_x_L,
   ipnumber*     compl_x_U,
   ipnumber*     grad_lag_x,
   ipindex       m,
   ipnumber*     nlp_constraint_violation,
   ipnumber*     compl_g
);
 
#ifdef __cplusplus
} /* extern "C" { */
#endif
 
#endif