parallelPipsNlp_C_Callback.h File Reference

#include "mpi.h"

Go to the source code of this file.

Classes
struct	CallBackData
struct	PipsNlpProblemStruct

Typedefs
typedef void *	UserDataPtr
typedef struct CallBackData	CallBackData
typedef CallBackData *	CallBackDataPtr
typedef int(*	str_init_x0_cb) (double *x0, CallBackDataPtr cbd)
typedef int(*	str_prob_info_cb) (int *n, double *col_lb, double *col_up, int *m, double *row_lb, double *row_up, CallBackDataPtr cbd)
typedef int(*	str_eval_f_cb) (double *x0, double *x1, double *obj, CallBackDataPtr cbd)
typedef int(*	str_eval_g_cb) (double *x0, double *x1, double *eq_g, double *inq_g, CallBackDataPtr cbd)
typedef int(*	str_eval_grad_f_cb) (double *x0, double *x1, double *vec_grad_f, CallBackDataPtr cbd)
typedef int(*	str_eval_jac_g_cb) (double *x0, double *x1, int *e_nz, double *e_elts, int *e_rowidx, int *e_colptr, int *i_nz, double *i_elts, int *i_rowidx, int *i_colptr, CallBackDataPtr cbd)
typedef int(*	str_eval_h_cb) (double *x0, double *x1, double *lamdba, int *nz, double *elts, int *rowidx, int *colptr, CallBackDataPtr cbd)
typedef int(*	str_write_solution_cb) (double *x, double *lam_eq, double *lam_ieq, CallBackDataPtr cbd)
typedef struct PipsNlpProblemStruct *	PipsNlpProblemStructPtr

Functions
PipsNlpProblemStructPtr	CreatePipsNlpProblemStruct (MPI_Comm comm, int nscen, str_init_x0_cb init_x0, str_prob_info_cb prob_info, str_eval_f_cb eval_f, str_eval_g_cb eval_g, str_eval_grad_f_cb eval_grad_f, str_eval_jac_g_cb eval_jac_g, str_eval_h_cb eval_h, str_write_solution_cb write_solution, UserDataPtr userdata)
void	FreePipsNlpProblemStruct (PipsNlpProblemStruct *prob)
int	PipsNlpSolveStruct (PipsNlpProblemStruct *prob)
int	get_x (CallBackDataPtr cbd, double *x, double *lam_eq, double *lam_ieq)
double	PipsNlpProblemStructGetObjective (PipsNlpProblemStruct *prob)
int	PipsNlpProblemStructGetTotalVars (PipsNlpProblemStruct *prob)
int	PipsNlpProblemStructGetTotalCons (PipsNlpProblemStruct *prob)

Typedef Documentation

typedef struct CallBackData CallBackData

typedef CallBackData* CallBackDataPtr

typedef struct PipsNlpProblemStruct* PipsNlpProblemStructPtr

typedef int(* str_eval_f_cb) (double *x0, double *x1, double *obj, CallBackDataPtr cbd)

typedef int(* str_eval_g_cb) (double *x0, double *x1, double *eq_g, double *inq_g, CallBackDataPtr cbd)

typedef int(* str_eval_grad_f_cb) (double *x0, double *x1, double *vec_grad_f, CallBackDataPtr cbd)

typedef int(* str_eval_h_cb) (double *x0, double *x1, double *lamdba, int *nz, double *elts, int *rowidx, int *colptr, CallBackDataPtr cbd)

typedef int(* str_eval_jac_g_cb) (double *x0, double *x1, int *e_nz, double *e_elts, int *e_rowidx, int *e_colptr, int *i_nz, double *i_elts, int *i_rowidx, int *i_colptr, CallBackDataPtr cbd)

typedef int(* str_init_x0_cb) (double *x0, CallBackDataPtr cbd)

typedef int(* str_prob_info_cb) (int *n, double *col_lb, double *col_up, int *m, double *row_lb, double *row_up, CallBackDataPtr cbd)

typedef int(* str_write_solution_cb) (double *x, double *lam_eq, double *lam_ieq, CallBackDataPtr cbd)

typedef void* UserDataPtr

Function Documentation

PipsNlpProblemStructPtr CreatePipsNlpProblemStruct	(	MPI_Comm	comm,
		int	nscen,
		str_init_x0_cb	init_x0,
		str_prob_info_cb	prob_info,
		str_eval_f_cb	eval_f,
		str_eval_g_cb	eval_g,
		str_eval_grad_f_cb	eval_grad_f,
		str_eval_jac_g_cb	eval_jac_g,
		str_eval_h_cb	eval_h,
		str_write_solution_cb	write_solution,
		UserDataPtr	userdata
	)

Pointer to a pips_nlp Problem.

Parameters

init_x0	number of scenarios *
eval_g	Callback function of objective function *
eval_grad_f	Callback function of constraint body *
eval_jac_g	Callback function of objective gradient *
eval_h	Callback function of constraint Jacobian *
write_solution	Callback function of Lagrangian Hessian *
userdata	Callback function to write back solution *

void FreePipsNlpProblemStruct

(

PipsNlpProblemStruct *

prob

)

shouldn't the signature be PipsNlpProblemStruct**

int get_x	(	CallBackDataPtr	cbd,
		double *	x,
		double *	lam_eq,
		double *	lam_ieq
	)

double PipsNlpProblemStructGetObjective

(

PipsNlpProblemStruct *

prob

)

int PipsNlpProblemStructGetTotalCons

(

PipsNlpProblemStruct *

prob

)

int PipsNlpProblemStructGetTotalVars

(

PipsNlpProblemStruct *

prob

)

int PipsNlpSolveStruct

(

PipsNlpProblemStruct *

prob

)