IARoundingFar3StepNlp Class Reference

#include <IARoundingFar3StepNlp.hpp>

Inheritance diagram for IARoundingFar3StepNlp:

List of all members.

Public Member Functions
	IARoundingFar3StepNlp (const IAData *data_ptr, const IPData *ip_data_ptr, IASolution *solution_ptr)
virtual	~IARoundingFar3StepNlp ()
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 Types
enum	HessOptions { ZERO, ROUNDED }
Private Member Functions
double	f_x_value (double I_i, double x_i) const
double	get_f_xl (int i) const
double	get_f_xh (int i) const
	IARoundingFar3StepNlp ()
	IARoundingFar3StepNlp (const IARoundingFar3StepNlp &)
IARoundingFar3StepNlp &	operator= (const IARoundingFar3StepNlp &)
Private Attributes
const IAData *	data
const IPData *	ipData
IAWeights	h0
IAWeights	hp
IAWeights	hm
const int	x01_start
const int	xp_start
const int	xm_start
const int	sum_even_start
const int	x_constraint_start
const int	problem_n
const int	problem_m
const int	base_n
const int	base_m
const HessOptions	hess_option
IASolution *	solution
IANlp	baseNlp
const bool	debugging
const bool	verbose

---

Detailed Description

Definition at line 20 of file IARoundingFar3StepNlp.hpp.

---

Member Enumeration Documentation

enum HessOptions [private]

Enumerator:

ZERO
ROUNDED

Definition at line 112 of file IARoundingFar3StepNlp.hpp.

---

Constructor & Destructor Documentation

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

default constructor

Definition at line 95 of file IARoundingFar3StepNlp.cpp.

~IARoundingFar3StepNlp

(

)

[virtual]

default destructor

Definition at line 87 of file IARoundingFar3StepNlp.cpp.

IARoundingFar3StepNlp

(

)

[private]

IARoundingFar3StepNlp

(

const IARoundingFar3StepNlp &

)

[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 352 of file IARoundingFar3StepNlp.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 437 of file IARoundingFar3StepNlp.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 403 of file IARoundingFar3StepNlp.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 509 of file IARoundingFar3StepNlp.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 458 of file IARoundingFar3StepNlp.cpp.

double f_x_value	(	double	I_i,
		double	x_i
	)		const [private]

Definition at line 78 of file IARoundingFar3StepNlp.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 582 of file IARoundingFar3StepNlp.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 276 of file IARoundingFar3StepNlp.cpp.

double get_f_xh

(

int

i

)

const [inline, private]

Definition at line 345 of file IARoundingFar3StepNlp.cpp.

double get_f_xl

(

int

i

)

const [inline, private]

Definition at line 339 of file IARoundingFar3StepNlp.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 253 of file IARoundingFar3StepNlp.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 314 of file IARoundingFar3StepNlp.cpp.

IARoundingFar3StepNlp& operator=

(

const IARoundingFar3StepNlp &

)

[private]

---

Member Data Documentation

const int base_m [private]

Definition at line 106 of file IARoundingFar3StepNlp.hpp.

const int base_n [private]

Definition at line 106 of file IARoundingFar3StepNlp.hpp.

IANlp baseNlp [private]

Definition at line 120 of file IARoundingFar3StepNlp.hpp.

const IAData* data [private]

Definition at line 95 of file IARoundingFar3StepNlp.hpp.

const bool debugging [private]

Definition at line 122 of file IARoundingFar3StepNlp.hpp.

IAWeights h0 [private]

Definition at line 97 of file IARoundingFar3StepNlp.hpp.

const HessOptions hess_option [private]

Definition at line 113 of file IARoundingFar3StepNlp.hpp.

IAWeights hm [private]

Definition at line 99 of file IARoundingFar3StepNlp.hpp.

IAWeights hp [private]

Definition at line 98 of file IARoundingFar3StepNlp.hpp.

const IPData* ipData [private]

Definition at line 96 of file IARoundingFar3StepNlp.hpp.

const int problem_m [private]

Definition at line 106 of file IARoundingFar3StepNlp.hpp.

const int problem_n [private]

Definition at line 106 of file IARoundingFar3StepNlp.hpp.

IASolution* solution [private]

Definition at line 116 of file IARoundingFar3StepNlp.hpp.

const int sum_even_start [private]

Definition at line 104 of file IARoundingFar3StepNlp.hpp.

const bool verbose [private]

Definition at line 123 of file IARoundingFar3StepNlp.hpp.

const int x01_start [private]

Definition at line 101 of file IARoundingFar3StepNlp.hpp.

const int x_constraint_start [private]

Definition at line 105 of file IARoundingFar3StepNlp.hpp.

const int xm_start [private]

Definition at line 103 of file IARoundingFar3StepNlp.hpp.

const int xp_start [private]

Definition at line 102 of file IARoundingFar3StepNlp.hpp.

---

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

• IARoundingFar3StepNlp.hpp
• IARoundingFar3StepNlp.cpp