apollo::planning::CosThetaIpoptInterface Class Reference

#include <cos_theta_ipopt_interface.h>

Inheritance diagram for apollo::planning::CosThetaIpoptInterface:

Collaboration diagram for apollo::planning::CosThetaIpoptInterface:

Public Member Functions
	CosThetaIpoptInterface (std::vector< std::pair< double, double >> points, std::vector< double > bounds)
virtual	~CosThetaIpoptInterface ()=default
void	set_weight_cos_included_angle (const double weight_cos_included_angle)
void	set_weight_anchor_points (const double weight_anchor_points)
void	set_weight_length (const double weight_length)
void	set_automatic_differentiation_flag (const bool use_ad)
void	get_optimization_results (std::vector< double > *ptr_x, std::vector< double > *ptr_y) const
bool	get_nlp_info (int &n, int &m, int &nnz_jac_g, int &nnz_h_lag, IndexStyleEnum &index_style) override
bool	get_bounds_info (int n, double *x_l, double *x_u, int m, double *g_l, double *g_u) override
bool	get_starting_point (int n, bool init_x, double *x, bool init_z, double *z_L, double *z_U, int m, bool init_lambda, double *lambda) override
bool	eval_f (int n, const double *x, bool new_x, double &obj_value) override
bool	eval_grad_f (int n, const double *x, bool new_x, double *grad_f) override
bool	eval_g (int n, const double *x, bool new_x, int m, double *g) override
bool	eval_jac_g (int n, const double *x, bool new_x, int m, int nele_jac, int *iRow, int *jCol, double *values) override
bool	eval_h (int n, const double *x, bool new_x, double obj_factor, int m, const double *lambda, bool new_lambda, int nele_hess, int *iRow, int *jCol, double *values) override

Solution Methods
void	finalize_solution (Ipopt::SolverReturn status, int n, const double *x, const double *z_L, const double *z_U, int m, const double *g, const double *lambda, double obj_value, const Ipopt::IpoptData *ip_data, Ipopt::IpoptCalculatedQuantities *ip_cq) override
template<class T >
bool	eval_obj (int n, const T *x, T *obj_value)
template<class T >
bool	eval_constraints (int n, const T *x, int m, T *g)
virtual void	generate_tapes (int n, int m, int *nnz_jac_g, int *nnz_h_lag)

Constructor & Destructor Documentation

CosThetaIpoptInterface()

apollo::planning::CosThetaIpoptInterface::CosThetaIpoptInterface	(	std::vector< std::pair< double, double >>	points,
		std::vector< double >	bounds
	)

~CosThetaIpoptInterface()

virtual apollo::planning::CosThetaIpoptInterface::~CosThetaIpoptInterface ( )

virtualdefault

Member Function Documentation

eval_constraints()

template<class T >

bool apollo::planning::CosThetaIpoptInterface::eval_constraints	(	int	n,
		const T *	x,
		int	m,
		T *	g
	)

Template to compute contraints

eval_f()

bool apollo::planning::CosThetaIpoptInterface::eval_f ( int  n, const double *  x, bool  new_x, double &  obj_value  )

override

Method to return the objective value

eval_g()

bool apollo::planning::CosThetaIpoptInterface::eval_g ( int  n, const double *  x, bool  new_x, int  m, double *  g  )

override

Method to return the constraint residuals

eval_grad_f()

bool apollo::planning::CosThetaIpoptInterface::eval_grad_f ( int  n, const double *  x, bool  new_x, double *  grad_f  )

override

Method to return the gradient of the objective

eval_h()

bool apollo::planning::CosThetaIpoptInterface::eval_h ( int  n, const double *  x, bool  new_x, double  obj_factor, int  m, const double *  lambda, bool  new_lambda, int  nele_hess, int *  iRow, int *  jCol, double *  values  )

override

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

eval_jac_g()

bool apollo::planning::CosThetaIpoptInterface::eval_jac_g ( int  n, const double *  x, bool  new_x, int  m, int  nele_jac, int *  iRow, int *  jCol, double *  values  )

override

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

eval_obj()

template<class T >

bool apollo::planning::CosThetaIpoptInterface::eval_obj	(	int	n,
		const T *	x,
		T *	obj_value
	)

Template to return the objective value

finalize_solution()

void apollo::planning::CosThetaIpoptInterface::finalize_solution ( Ipopt::SolverReturn  status, int  n, const double *  x, const double *  z_L, const double *  z_U, int  m, const double *  g, const double *  lambda, double  obj_value, const Ipopt::IpoptData *  ip_data, Ipopt::IpoptCalculatedQuantities *  ip_cq  )

override

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

generate_tapes()

virtual void apollo::planning::CosThetaIpoptInterface::generate_tapes ( int  n, int  m, int *  nnz_jac_g, int *  nnz_h_lag  )

virtual

Method to generate the required tapes

get_bounds_info()

bool apollo::planning::CosThetaIpoptInterface::get_bounds_info ( int  n, double *  x_l, double *  x_u, int  m, double *  g_l, double *  g_u  )

override

Method to return the bounds for my problem

get_nlp_info()

bool apollo::planning::CosThetaIpoptInterface::get_nlp_info ( int &  n, int &  m, int &  nnz_jac_g, int &  nnz_h_lag, IndexStyleEnum &  index_style  )

override

Method to return some info about the nlp

get_optimization_results()

void apollo::planning::CosThetaIpoptInterface::get_optimization_results	(	std::vector< double > *	ptr_x,
		std::vector< double > *	ptr_y
	)		const

get_starting_point()

bool apollo::planning::CosThetaIpoptInterface::get_starting_point ( int  n, bool  init_x, double *  x, bool  init_z, double *  z_L, double *  z_U, int  m, bool  init_lambda, double *  lambda  )

override

Method to return the starting point for the algorithm

set_automatic_differentiation_flag()

void apollo::planning::CosThetaIpoptInterface::set_automatic_differentiation_flag

(

const bool

use_ad

)

set_weight_anchor_points()

void apollo::planning::CosThetaIpoptInterface::set_weight_anchor_points

(

const double

weight_anchor_points

)

set_weight_cos_included_angle()

void apollo::planning::CosThetaIpoptInterface::set_weight_cos_included_angle

(

const double

weight_cos_included_angle

)

set_weight_length()

void apollo::planning::CosThetaIpoptInterface::set_weight_length

(

const double

weight_length

)

---

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

• modules/planning/math/discretized_points_smoothing/cos_theta_ipopt_interface.h