Ipopt Documentation  
Ipopt::Ma28TDependencyDetector Class Reference

#include <IpMa28TDependencyDetector.hpp>

+ Inheritance diagram for Ipopt::Ma28TDependencyDetector:

Public Member Functions

virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 Has to be called to initialize and reset these objects. More...
 
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. More...
 
Constructor/Destructor
 Ma28TDependencyDetector ()
 
virtual ~Ma28TDependencyDetector ()
 
- 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. More...
 
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. More...
 
 AlgorithmStrategyObject ()
 Default Constructor. More...
 
virtual ~AlgorithmStrategyObject ()
 Destructor. 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
 

Static Public Member Functions

static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 This must be called to make the options for this class known. More...
 

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.

 Ma28TDependencyDetector (const Ma28TDependencyDetector &)
 Copy Constructor. More...
 
void operator= (const Ma28TDependencyDetector &)
 Default Assignment Operator. More...
 

Private Attributes

SmartPtr< const Journalistjnlst_
 
Algorithmic parameters
Number ma28_pivtol_
 Pivot tolerance for MA28. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Definition at line 15 of file IpMa28TDependencyDetector.hpp.

Constructor & Destructor Documentation

◆ Ma28TDependencyDetector() [1/2]

Ipopt::Ma28TDependencyDetector::Ma28TDependencyDetector ( )

◆ ~Ma28TDependencyDetector()

virtual Ipopt::Ma28TDependencyDetector::~Ma28TDependencyDetector ( )
inlinevirtual

Definition at line 22 of file IpMa28TDependencyDetector.hpp.

◆ Ma28TDependencyDetector() [2/2]

Ipopt::Ma28TDependencyDetector::Ma28TDependencyDetector ( const Ma28TDependencyDetector )
private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::Ma28TDependencyDetector::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::Ma28TDependencyDetector::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::Ma28TDependencyDetector::RegisterOptions ( SmartPtr< RegisteredOptions roptions)
static

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

◆ operator=()

void Ipopt::Ma28TDependencyDetector::operator= ( const Ma28TDependencyDetector )
private

Default Assignment Operator.

Member Data Documentation

◆ jnlst_

SmartPtr<const Journalist> Ipopt::Ma28TDependencyDetector::jnlst_
private

Definition at line 78 of file IpMa28TDependencyDetector.hpp.

◆ ma28_pivtol_

Number Ipopt::Ma28TDependencyDetector::ma28_pivtol_
private

Pivot tolerance for MA28.

Definition at line 83 of file IpMa28TDependencyDetector.hpp.


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