IAMINlp Class Reference

#include <IAMINlp.hpp>

Inheritance diagram for IAMINlp:

List of all members.

Public Member Functions
	IAMINlp (const IAData *data_ptr, const IPData *ip_data_ptr, IASolution *solution_ptr)
virtual	~IAMINlp ()
Number	eval_R_i (const Number &I_i, const Number &x_i)
Overloaded from TNLP
virtual bool	get_nlp_info (Index &n, Index &m, Index &nnz_jac_g, Index &nnz_h_lag, IndexStyleEnum &index_style)
virtual bool	get_bounds_info (Index n, Number *x_l, Number *x_u, Index m, Number *g_l, Number *g_u)
virtual bool	get_starting_point (Index n, bool init_x, Number *x_init, bool init_z, Number *z_L, Number *z_U, Index m, bool init_lambda, Number *lambda)
virtual bool	eval_f (Index n, const Number *x, bool new_x, Number &obj_value)
virtual bool	eval_grad_f (Index n, const Number *x, bool new_x, Number *grad_f)
virtual bool	eval_g (Index n, const Number *x, bool new_x, Index m, Number *g)
virtual bool	eval_jac_g (Index n, const Number *x, bool new_x, Index m, Index nele_jac, Index *iRow, Index *jCol, Number *values)
virtual bool	eval_h (Index n, const Number *x, bool new_x, Number obj_factor, Index m, const Number *lambda, bool new_lambda, Index nele_hess, Index *iRow, Index *jCol, Number *values)
Solution Methods
virtual void	finalize_solution (SolverReturn status, Index n, const Number *x, const Number *z_L, const Number *z_U, Index m, const Number *g, const Number *lambda, Number obj_value, const IpoptData *ip_data, IpoptCalculatedQuantities *ip_cq)
Private Member Functions
Number	eval_r_i (const Number &I_i, const Number &x_i)
Number	eval_grad_r_i (const Number &I_i, const Number &x_i)
Number	eval_hess_r_i (const Number &I_i, const Number &x_i)
Number	eval_s_i (const Number &I_i, const Number &x_i)
Number	eval_grad_s_i (const Number &I_i, const Number &x_i)
Number	eval_hess_s_i (const Number &I_i, const Number &x_i)
Number	eval_grad_R_i (const Number &I_i, const Number &x_i)
Number	eval_hess_R_i (const Number &I_i, const Number &x_i)
Number	eval_S_i (const Number &I_i, const Number &x_i)
Number	eval_grad_S_i (const Number &I_i, const Number &x_i)
Number	eval_hess_S_i (const Number &I_i, const Number &x_i)
	IAMINlp ()
	IAMINlp (const IAMINlp &)
IAMINlp &	operator= (const IAMINlp &)
Private Attributes
const IAData *	data
const IPData *	ip_data
IASolution *	solution
const bool	debugging
const bool	verbose

---

Detailed Description

Definition at line 24 of file IAMINlp.hpp.

---

Constructor & Destructor Documentation

IAMINlp	(	const IAData *	data_ptr,
		const IPData *	ip_data_ptr,
		IASolution *	solution_ptr
	)

default constructor

Definition at line 38 of file IAMINlp.cpp.

~IAMINlp

(

)

[virtual]

default destructor

Definition at line 61 of file IAMINlp.cpp.

IAMINlp

(

)

[private]

IAMINlp

(

const IAMINlp &

)

[private]

---

Member Function Documentation

bool eval_f	(	Index	n,
		const Number *	x,
		bool	new_x,
		Number &	obj_value
	)		[virtual]

Method to return the objective value

Definition at line 351 of file IAMINlp.cpp.

bool eval_g	(	Index	n,
		const Number *	x,
		bool	new_x,
		Index	m,
		Number *	g
	)		[virtual]

Method to return the constraint residuals

Definition at line 386 of file IAMINlp.cpp.

bool eval_grad_f	(	Index	n,
		const Number *	x,
		bool	new_x,
		Number *	grad_f
	)		[virtual]

Method to return the gradient of the objective

Definition at line 371 of file IAMINlp.cpp.

Number eval_grad_r_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 211 of file IAMINlp.cpp.

Number eval_grad_R_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 242 of file IAMINlp.cpp.

Number eval_grad_s_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 279 of file IAMINlp.cpp.

Number eval_grad_S_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 306 of file IAMINlp.cpp.

bool eval_h	(	Index	n,
		const Number *	x,
		bool	new_x,
		Number	obj_factor,
		Index	m,
		const Number *	lambda,
		bool	new_lambda,
		Index	nele_hess,
		Index *	iRow,
		Index *	jCol,
		Number *	values
	)		[virtual]

Method to return: 1) The structure of the hessian of the lagrangian (if "values" is NULL) 2) The values of the hessian of the lagrangian (if "values" is not NULL)

Definition at line 474 of file IAMINlp.cpp.

Number eval_hess_r_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 219 of file IAMINlp.cpp.

Number eval_hess_R_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 250 of file IAMINlp.cpp.

Number eval_hess_s_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 284 of file IAMINlp.cpp.

Number eval_hess_S_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 325 of file IAMINlp.cpp.

bool eval_jac_g	(	Index	n,
		const Number *	x,
		bool	new_x,
		Index	m,
		Index	nele_jac,
		Index *	iRow,
		Index *	jCol,
		Number *	values
	)		[virtual]

Method to return: 1) The structure of the jacobian (if "values" is NULL) 2) The values of the jacobian (if "values" is not NULL)

Definition at line 420 of file IAMINlp.cpp.

Number eval_r_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 203 of file IAMINlp.cpp.

Number eval_R_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline]

Definition at line 227 of file IAMINlp.cpp.

Number eval_s_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 274 of file IAMINlp.cpp.

Number eval_S_i	(	const Number &	I_i,
		const Number &	x_i
	)		[inline, private]

Definition at line 289 of file IAMINlp.cpp.

void finalize_solution	(	SolverReturn	status,
		Index	n,
		const Number *	x,
		const Number *	z_L,
		const Number *	z_U,
		Index	m,
		const Number *	g,
		const Number *	lambda,
		Number	obj_value,
		const IpoptData *	ip_data,
		IpoptCalculatedQuantities *	ip_cq
	)		[virtual]

This method is called when the algorithm is complete so the TNLP can store/write the solution

Definition at line 516 of file IAMINlp.cpp.

bool get_bounds_info	(	Index	n,
		Number *	x_l,
		Number *	x_u,
		Index	m,
		Number *	g_l,
		Number *	g_u
	)		[virtual]

Method to return the bounds for my problem

Definition at line 98 of file IAMINlp.cpp.

bool get_nlp_info	(	Index &	n,
		Index &	m,
		Index &	nnz_jac_g,
		Index &	nnz_h_lag,
		IndexStyleEnum &	index_style
	)		[virtual]

Method to return some info about the nlp

Definition at line 64 of file IAMINlp.cpp.

bool get_starting_point	(	Index	n,
		bool	init_x,
		Number *	x_init,
		bool	init_z,
		Number *	z_L,
		Number *	z_U,
		Index	m,
		bool	init_lambda,
		Number *	lambda
	)		[virtual]

Method to return the starting point for the algorithm

Definition at line 168 of file IAMINlp.cpp.

IAMINlp& operator=

(

const IAMINlp &

)

[private]

---

Member Data Documentation

const IAData* data [private]

Definition at line 99 of file IAMINlp.hpp.

const bool debugging [private]

Definition at line 104 of file IAMINlp.hpp.

const IPData* ip_data [private]

Definition at line 100 of file IAMINlp.hpp.

IASolution* solution [private]

Definition at line 102 of file IAMINlp.hpp.

const bool verbose [private]

Definition at line 105 of file IAMINlp.hpp.

---

The documentation for this class was generated from the following files:

• IAMINlp.hpp
• IAMINlp.cpp