IANlp Class Reference

#include <IANlp.hpp>

Inheritance diagram for IANlp:

List of all members.

Public Member Functions
	IANlp (const IAData *data_ptr, IASolution *solution_ptr, const bool set_silent=true)
virtual	~IANlp ()
int	get_neleJac () const
double	eval_even_sum (const int i, const Number *x) const
double	eval_equal_sum (const int i, const Number *x) const
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)
Static Public Member Functions
static Number	eval_R_i (const Number &I_i, const Number &x_i)
Private Member Functions
	IANlp ()
	IANlp (const IANlp &)
IANlp &	operator= (const IANlp &)
Static Private Member Functions
static Number	eval_r_i (const Number &I_i, const Number &x_i)
static Number	eval_grad_r_i (const Number &I_i, const Number &x_i)
static Number	eval_hess_r_i (const Number &I_i, const Number &x_i)
static Number	eval_s_i (const Number &I_i, const Number &x_i)
static Number	eval_grad_s_i (const Number &I_i, const Number &x_i)
static Number	eval_hess_s_i (const Number &I_i, const Number &x_i)
static Number	eval_grad_R_i (const Number &I_i, const Number &x_i)
static Number	eval_hess_R_i (const Number &I_i, const Number &x_i)
static Number	eval_S_i (const Number &I_i, const Number &x_i)
static Number	eval_grad_S_i (const Number &I_i, const Number &x_i)
static Number	eval_hess_S_i (const Number &I_i, const Number &x_i)
Private Attributes
const IAData *	data
IASolution *	solution
int	neleJac
const bool	silent
const bool	debugging
const bool	verbose
Static Private Attributes
static const int	p_norm = 3

---

Detailed Description

Definition at line 64 of file IANlp.hpp.

---

Constructor & Destructor Documentation

IANlp	(	const IAData *	data_ptr,
		IASolution *	solution_ptr,
		const bool	set_silent = true
	)

default constructor

Definition at line 35 of file IANlp.cpp.

~IANlp

(

)

[virtual]

default destructor

Definition at line 63 of file IANlp.cpp.

IANlp

(

)

[private]

IANlp

(

const IANlp &

)

[private]

---

Member Function Documentation

double eval_equal_sum	(	const int	i,
		const Number *	x
	)		const

Definition at line 498 of file IANlp.cpp.

double eval_even_sum	(	const int	i,
		const Number *	x
	)		const

Definition at line 471 of file IANlp.cpp.

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

Method to return the objective value

Definition at line 314 of file IANlp.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 349 of file IANlp.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 334 of file IANlp.cpp.

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

Definition at line 174 of file IANlp.cpp.

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

Definition at line 205 of file IANlp.cpp.

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

Definition at line 242 of file IANlp.cpp.

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

Definition at line 269 of file IANlp.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 429 of file IANlp.cpp.

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

Definition at line 182 of file IANlp.cpp.

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

Definition at line 213 of file IANlp.cpp.

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

Definition at line 247 of file IANlp.cpp.

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

Definition at line 288 of file IANlp.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 373 of file IANlp.cpp.

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

Definition at line 166 of file IANlp.cpp.

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

Definition at line 190 of file IANlp.cpp.

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

Definition at line 237 of file IANlp.cpp.

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

Definition at line 252 of file IANlp.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 511 of file IANlp.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 100 of file IANlp.cpp.

int get_neleJac

(

)

const [inline]

Definition at line 129 of file IANlp.hpp.

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 66 of file IANlp.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 140 of file IANlp.cpp.

IANlp& operator=

(

const IANlp &

)

[private]

---

Member Data Documentation

const IAData* data [private]

Definition at line 147 of file IANlp.hpp.

const bool debugging [private]

Definition at line 154 of file IANlp.hpp.

int neleJac [private]

Definition at line 151 of file IANlp.hpp.

const int p_norm = 3 [static, private]

Definition at line 148 of file IANlp.hpp.

const bool silent [private]

Definition at line 153 of file IANlp.hpp.

IASolution* solution [private]

Definition at line 150 of file IANlp.hpp.

const bool verbose [private]

Definition at line 155 of file IANlp.hpp.

---

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

• IANlp.hpp
• IANlp.cpp