Ipopt::TSymDependencyDetector Class Reference

Base class for all derived algorithms for detecting linearly dependent rows in the constraint Jacobian. More...

#include <IpTSymDependencyDetector.hpp>

Inheritance diagram for Ipopt::TSymDependencyDetector:

[legend]

Collaboration diagram for Ipopt::TSymDependencyDetector:

[legend]

List of all members.

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	Has to be called to initialize and reset these objects.
virtual bool	DetermineDependentRows (Index n_rows, Index n_cols, Index n_jac_nz, Number jac_c_vals, Index jac_c_iRow, Index *jac_c_jCol, std::list< Index > &c_deps)
	Method determining the number of linearly dependent rows in the matrix and the indices of those rows.
Constructor/Destructor

	TSymDependencyDetector (TSymLinearSolver &tsym_linear_solver)
virtual	~TSymDependencyDetector ()
Static Public Member Functions
static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
	This must be called to make the options for this class known.
Private Member Functions
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	TSymDependencyDetector ()
	Default Constructor.
	TSymDependencyDetector (const TSymDependencyDetector &)
	Copy Constructor.
void	operator= (const TSymDependencyDetector &)
	Overloaded Equals Operator.
Private Attributes
SmartPtr< const Journalist >	jnlst_
SmartPtr< TSymLinearSolver >	tsym_linear_solver_

Detailed Description

Base class for all derived algorithms for detecting linearly dependent rows in the constraint Jacobian.

Definition at line 20 of file IpTSymDependencyDetector.hpp.

Constructor & Destructor Documentation

Ipopt::TSymDependencyDetector::TSymDependencyDetector ( TSymLinearSolver & tsym_linear_solver )

virtual Ipopt::TSymDependencyDetector::~TSymDependencyDetector ( ) [inline, virtual]

Definition at line 27 of file IpTSymDependencyDetector.hpp.

Ipopt::TSymDependencyDetector::TSymDependencyDetector ( ) [private]

Default Constructor.

Ipopt::TSymDependencyDetector::TSymDependencyDetector ( const TSymDependencyDetector & ) [private]

Copy Constructor.

Member Function Documentation

virtual bool Ipopt::TSymDependencyDetector::InitializeImpl	(	const OptionsList &	options,
		const std::string &	prefix
	)			`[virtual]`

Has to be called to initialize and reset these objects.

Implements Ipopt::TDependencyDetector.

virtual bool Ipopt::TSymDependencyDetector::DetermineDependentRows	(	Index	n_rows,
		Index	n_cols,
		Index	n_jac_nz,
		Number *	jac_c_vals,
		Index *	jac_c_iRow,
		Index *	jac_c_jCol,
		std::list< Index > &	c_deps
	)			`[virtual]`

Method determining the number of linearly dependent rows in the matrix and the indices of those rows.

We assume that the matrix is available in "Triplet" format (MA28 format), and that the arrays given to this method can be modified internally, i.e., they are not used by the calling program anymore after this call. This method returns false if there was a problem with the underlying linear solver.

Implements Ipopt::TDependencyDetector.

static void Ipopt::TSymDependencyDetector::RegisterOptions ( SmartPtr< RegisteredOptions > roptions ) [static]