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.
 
   $Id: IpStdCInterface.h 2082 2012-02-16 03:00:34Z andreasw $
 
   Authors:  Carl Laird, Andreas Waechter     IBM    2004-09-02
 *************************************************************************/

#ifndef __IPSTDCINTERFACE_H__
#define __IPSTDCINTERFACE_H__

#ifndef IPOPT_EXPORT
#ifdef _MSC_VER
#ifdef IPOPT_DLL
#define IPOPT_EXPORT(type) __declspec(dllexport) type __cdecl
#else
#define IPOPT_EXPORT(type) type __cdecl
#endif
#else 
#define IPOPT_EXPORT(type) type
#endif
#endif

#ifdef __cplusplus
extern "C"
{
#endif

  typedef double Number;

  typedef int Index;

  typedef int Int;

  /* This includes the SolverReturn enum type */
#include "IpReturnCodes.h"

  struct IpoptProblemInfo;

  typedef struct IpoptProblemInfo* IpoptProblem;

  typedef int Bool;
#ifndef TRUE
# define TRUE (1)
#endif
#ifndef FALSE
# define FALSE (0)
#endif

  typedef void * UserDataPtr;

  typedef Bool (*Eval_F_CB)(Index n, Number* x, Bool new_x,
                            Number* obj_value, UserDataPtr user_data);

  typedef Bool (*Eval_Grad_F_CB)(Index n, Number* x, Bool new_x,
                                 Number* grad_f, UserDataPtr user_data);

  typedef Bool (*Eval_G_CB)(Index n, Number* x, Bool new_x,
                            Index m, Number* g, UserDataPtr user_data);

  typedef Bool (*Eval_Jac_G_CB)(Index n, Number *x, Bool new_x,
                                Index m, Index nele_jac,
                                Index *iRow, Index *jCol, Number *values,
                                UserDataPtr user_data);

  typedef Bool (*Eval_H_CB)(Index n, Number *x, Bool new_x, Number obj_factor,
                            Index m, Number *lambda, Bool new_lambda,
                            Index nele_hess, Index *iRow, Index *jCol,
                            Number *values, UserDataPtr user_data);

  typedef Bool (*Intermediate_CB)(Index alg_mod, /* 0 is regular, 1 is resto */
                  Index iter_count, Number obj_value,
                  Number inf_pr, Number inf_du,
                  Number mu, Number d_norm,
                  Number regularization_size,
                  Number alpha_du, Number alpha_pr,
                  Index ls_trials, UserDataPtr user_data);

  IPOPT_EXPORT(IpoptProblem) CreateIpoptProblem(
      Index n             
    , Number* x_L         
    , Number* x_U         
    , Index m             
    , Number* g_L         
    , Number* g_U         
    , Index nele_jac      
    , Index nele_hess     
    , Index 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    
  );

  IPOPT_EXPORT(void) FreeIpoptProblem(IpoptProblem ipopt_problem);


  IPOPT_EXPORT(Bool) AddIpoptStrOption(IpoptProblem ipopt_problem, char* keyword, char* val);

  IPOPT_EXPORT(Bool) AddIpoptNumOption(IpoptProblem ipopt_problem, char* keyword, Number val);

  IPOPT_EXPORT(Bool) AddIpoptIntOption(IpoptProblem ipopt_problem, char* keyword, Int val);

  IPOPT_EXPORT(Bool) OpenIpoptOutputFile(IpoptProblem ipopt_problem, char* file_name,
                           Int print_level);

  IPOPT_EXPORT(Bool) SetIpoptProblemScaling(IpoptProblem ipopt_problem,
                  Number obj_scaling,
                  Number* x_scaling,
                  Number* g_scaling);

  IPOPT_EXPORT(Bool) SetIntermediateCallback(IpoptProblem ipopt_problem,
                         Intermediate_CB intermediate_cb);

  IPOPT_EXPORT(enum ApplicationReturnStatus) IpoptSolve(
      IpoptProblem ipopt_problem
    , Number* x          
    , Number* g          
    , Number* obj_val    
    , Number* mult_g     
    , Number* mult_x_L   
    , Number* mult_x_U   
    , UserDataPtr user_data
  );

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif