Class implemented the NLP discretization of. More...

#include <RegisteredTNLP.hpp>

Inheritance diagram for RegisteredTNLP:

Public Member Functions
virtual bool	InitializeProblem (Index N)=0
	Initialize internal parameters, where N is a parameter determining the problme size. More...

Public Member Functions inherited from Ipopt::TNLP
	DECLARE_STD_EXCEPTION (INVALID_TNLP)

	TNLP ()

virtual	~TNLP ()
	Default destructor. More...

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)=0
	This method is called when the algorithm is complete so the TNLP can store/write the solution. More...

virtual void	finalize_metadata (Index n, const StringMetaDataMapType &var_string_md, const IntegerMetaDataMapType &var_integer_md, const NumericMetaDataMapType &var_numeric_md, Index m, const StringMetaDataMapType &con_string_md, const IntegerMetaDataMapType &con_integer_md, const NumericMetaDataMapType &con_numeric_md)
	This method is called just before finalize_solution. More...

virtual bool	intermediate_callback (AlgorithmMode mode, Index iter, 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, const IpoptData ip_data, IpoptCalculatedQuantities ip_cq)
	Intermediate Callback method for the user. More...

virtual Index	get_number_of_nonlinear_variables ()

virtual bool	get_list_of_nonlinear_variables (Index num_nonlin_vars, Index *pos_nonlin_vars)

virtual bool	get_nlp_info (Index &n, Index &m, Index &nnz_jac_g, Index &nnz_h_lag, IndexStyleEnum &index_style)=0

virtual bool	get_var_con_metadata (Index n, StringMetaDataMapType &var_string_md, IntegerMetaDataMapType &var_integer_md, NumericMetaDataMapType &var_numeric_md, Index m, StringMetaDataMapType &con_string_md, IntegerMetaDataMapType &con_integer_md, NumericMetaDataMapType &con_numeric_md)
	overload this method to return any meta data for the variables and the constraints More...

virtual bool	get_bounds_info (Index n, Number x_l, Number x_u, Index m, Number g_l, Number g_u)=0
	overload this method to return the information about the bound on the variables and constraints. More...

virtual bool	get_scaling_parameters (Number &obj_scaling, bool &use_x_scaling, Index n, Number x_scaling, bool &use_g_scaling, Index m, Number g_scaling)
	overload this method to return scaling parameters. More...

virtual bool	get_variables_linearity (Index n, LinearityType *var_types)
	overload this method to return the variables linearity (TNLP::LINEAR or TNLP::NON_LINEAR). More...

virtual bool	get_constraints_linearity (Index m, LinearityType *const_types)
	overload this method to return the constraint linearity. More...

virtual bool	get_starting_point (Index n, bool init_x, Number x, bool init_z, Number z_L, Number z_U, Index m, bool init_lambda, Number lambda)=0
	overload this method to return the starting point. More...

virtual bool	get_warm_start_iterate (IteratesVector &warm_start_iterate)
	overload this method to provide an Ipopt iterate (already in the form Ipopt requires it internally) for a warm start. More...

virtual bool	eval_f (Index n, const Number *x, bool new_x, Number &obj_value)=0
	overload this method to return the value of the objective function More...

virtual bool	eval_grad_f (Index n, const Number x, bool new_x, Number grad_f)=0
	overload this method to return the vector of the gradient of the objective w.r.t. More...

virtual bool	eval_g (Index n, const Number x, bool new_x, Index m, Number g)=0
	overload this method to return the vector of constraint values More...

virtual bool	eval_jac_g (Index n, const Number x, bool new_x, Index m, Index nele_jac, Index iRow, Index jCol, Number values)=0
	overload this method to return the jacobian of the constraints. More...

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)
	overload this method to return the hessian of the lagrangian. More...

Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()

virtual	~ReferencedObject ()

Index	ReferenceCount () const

void	AddRef (const Referencer *referencer) const

void	ReleaseRef (const Referencer *referencer) const

Additional Inherited Members
Public Types inherited from Ipopt::TNLP
enum	LinearityType { LINEAR, NON_LINEAR }
	Type of the constraints. More...

enum	IndexStyleEnum { C_STYLE =0, FORTRAN_STYLE =1 }
	overload this method to return the number of variables and constraints, and the number of non-zeros in the jacobian and the hessian. More...

typedef std::map< std::string, std::vector< std::string > >	StringMetaDataMapType

typedef std::map< std::string, std::vector< Index > >	IntegerMetaDataMapType

typedef std::map< std::string, std::vector< Number > >	NumericMetaDataMapType

Detailed Description

Class implemented the NLP discretization of.

Definition at line 20 of file RegisteredTNLP.hpp.

Member Function Documentation

virtual bool RegisteredTNLP::InitializeProblem ( Index N )

pure virtual

Initialize internal parameters, where N is a parameter determining the problme size.

This returns false, if N has an invalid value.

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

examples/ScalableProblems/RegisteredTNLP.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation