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:

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 ()
Public Member Functions inherited from Ipopt::TDependencyDetector
	TDependencyDetector ()
virtual	~TDependencyDetector ()
Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
bool	Initialize (const Journalist &jnlst, IpoptNLP &ip_nlp, IpoptData &ip_data, IpoptCalculatedQuantities &ip_cq, const OptionsList &options, const std::string &prefix)
	This method is called every time the algorithm starts again - it is used to reset any internal state.
bool	ReducedInitialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
	Reduced version of the Initialize method, which does not require special Ipopt information.
	AlgorithmStrategyObject ()
	Default Constructor.
virtual	~AlgorithmStrategyObject ()
	Destructor.
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

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 &)
	Default Assignment Operator.

Private Attributes
SmartPtr< const Journalist >	jnlst_
SmartPtr< TSymLinearSolver >	tsym_linear_solver_

Additional Inherited Members
Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const Journalist &	Jnlst () const
IpoptNLP &	IpNLP () const
IpoptData &	IpData () const
IpoptCalculatedQuantities &	IpCq () const
bool	HaveIpData () const

Detailed Description

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

Definition at line 19 of file IpTSymDependencyDetector.hpp.

Constructor & Destructor Documentation

TSymDependencyDetector() [1/3]

Ipopt::TSymDependencyDetector::TSymDependencyDetector

(

TSymLinearSolver &

tsym_linear_solver

)

~TSymDependencyDetector()

virtual Ipopt::TSymDependencyDetector::~TSymDependencyDetector ( )

inlinevirtual

Definition at line 27 of file IpTSymDependencyDetector.hpp.

TSymDependencyDetector() [2/3]

Ipopt::TSymDependencyDetector::TSymDependencyDetector ( )

private

Default Constructor.

TSymDependencyDetector() [3/3]

Ipopt::TSymDependencyDetector::TSymDependencyDetector ( const TSymDependencyDetector &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

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.

DetermineDependentRows()

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.

Returns

false if there was a problem with the underlying linear solver

Implements Ipopt::TDependencyDetector.

RegisterOptions()

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

static

This must be called to make the options for this class known.

operator=()

void Ipopt::TSymDependencyDetector::operator= ( const TSymDependencyDetector &  )

private

Default Assignment Operator.

Member Data Documentation

jnlst_

SmartPtr<const Journalist> Ipopt::TSymDependencyDetector::jnlst_

private

Definition at line 86 of file IpTSymDependencyDetector.hpp.

tsym_linear_solver_

SmartPtr<TSymLinearSolver> Ipopt::TSymDependencyDetector::tsym_linear_solver_

private

Definition at line 88 of file IpTSymDependencyDetector.hpp.

---

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

• src/Algorithm/LinearSolvers/IpTSymDependencyDetector.hpp