Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
IpTSymLinearSolver.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2007 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id: IpTSymLinearSolver.hpp 2206 2013-04-13 15:29:15Z stefan $
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-03-17
8 
9 #ifndef __IPTSYMLINEARSOLVER_HPP__
10 #define __IPTSYMLINEARSOLVER_HPP__
11 
12 #include "IpSymLinearSolver.hpp"
14 #include "IpTSymScalingMethod.hpp"
15 #include "IpSymMatrix.hpp"
17 #include <vector>
18 #include <list>
19 
20 namespace Ipopt
21 {
22 
34  {
35  public:
43  SmartPtr<TSymScalingMethod> scaling_method);
44 
46  virtual ~TSymLinearSolver();
48 
50  bool InitializeImpl(const OptionsList& options,
51  const std::string& prefix);
52 
58  virtual ESymSolverStatus MultiSolve(const SymMatrix &A,
59  std::vector<SmartPtr<const Vector> >& rhsV,
60  std::vector<SmartPtr<Vector> >& solV,
61  bool check_NegEVals,
62  Index numberOfNegEVals);
63 
68  virtual Index NumberOfNegEVals() const;
70 
71  //* @name Options of Linear solver */
73 
78  virtual bool IncreaseQuality();
79 
83  virtual bool ProvidesInertia() const;
85 
91  bool ProvidesDegeneracyDetection() const;
97  Index n_jac_nz,
98  Number* jac_c_vals,
99  Index* jac_c_iRow,
100  Index* jac_c_jCol,
101  std::list<Index>& c_deps);
103 
106  static void RegisterOptions(SmartPtr<RegisteredOptions> roptions);
108 
109  private:
120 
123 
125  void operator=(const TSymLinearSolver&);
127 
132 
135 
145 
158 
173 
189 
196 
204 
207  void GiveMatrixToSolver(bool new_matrix, const SymMatrix& sym_A);
209  };
210 
211 } // namespace Ipopt
212 #endif
SmartPtr< SparseSymLinearSolverInterface > solver_interface_
Strategy Object for an interface to a linear solver.
bool have_structure_
Flag indicating if the internal structures are initialized.
SmartPtr< TSymScalingMethod > scaling_method_
Strategy Object for a method that computes scaling factors for the matrices.
ESymSolverStatus
Enum to report outcome of a linear solve.
SparseSymLinearSolverInterface::EMatrixFormat matrix_format_
Flag indicating what matrix data format the solver requires.
bool just_switched_on_scaling_
Flag indicating whether we just switched on the scaling.
virtual Index NumberOfNegEVals() const
Number of negative eigenvalues detected during last factorization.
virtual ~TSymLinearSolver()
Destructor.
bool warm_start_same_structure_
Flag indicating whether the TNLP with identical structure has already been solved before...
General driver for linear solvers for sparse indefinite symmetric matrices.
double Number
Type of all numbers.
Definition: IpTypes.hpp:17
virtual ESymSolverStatus MultiSolve(const SymMatrix &A, std::vector< SmartPtr< const Vector > > &rhsV, std::vector< SmartPtr< Vector > > &solV, bool check_NegEVals, Index numberOfNegEVals)
Solve operation for multiple right hand sides.
Index * airn_
row indices of matrix in triplet (MA27) format.
ESymSolverStatus InitializeStructure(const SymMatrix &symT_A)
Initialize nonzero structure.
bool InitializeImpl(const OptionsList &options, const std::string &prefix)
overloaded from AlgorithmStrategyObject
TSymLinearSolver()
Default Constructor.
This is the base class for all derived symmetric matrix types.
Definition: IpSymMatrix.hpp:23
Template class for Smart Pointers.
Definition: IpSmartPtr.hpp:172
This class stores a list of user set options.
Index nonzeros_triplet_
Number of nonzeros of the matrix in triplet format.
void GiveMatrixToSolver(bool new_matrix, const SymMatrix &sym_A)
Copy the elements of the matrix in the required format into the array that is provided by the solver ...
ESymSolverStatus 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)
Given the entries of a matrix in Triplet format, this method determines the list of row indices of th...
Index * ajcn_
column indices of matrix in triplet (MA27) format.
void operator=(const TSymLinearSolver &)
Overloaded Equals Operator.
SmartPtr< TripletToCSRConverter > triplet_to_csr_converter_
Pointer to object for conversion from triplet to compressed format.
bool linear_scaling_on_demand_
Flag indicating whether the scaling objected is to be switched on when increased quality is requested...
bool use_scaling_
Flag indicating whether scaling should be performed.
static void RegisterOptions(SmartPtr< RegisteredOptions > roptions)
Methods for OptionsList.
int Index
Type of all indices of vectors, matrices etc.
Definition: IpTypes.hpp:19
double * scaling_factors_
Array storing the scaling factors.
unsigned int Tag
Type for the Tag values.
EMatrixFormat
Enum to specify sparse matrix format.
bool ProvidesDegeneracyDetection() const
Returns true if the underlying linear solver can detect the linearly dependent rows in a matrix...
TaggedObject::Tag atag_
Tag for the incoming matrix.
Base class for all derived symmetric linear solvers.
virtual bool IncreaseQuality()
Request to increase quality of solution for next solve.
virtual bool ProvidesInertia() const
Query whether inertia is computed by linear solver.
Index dim_
Number of rows and columns of the matrix.
bool initialized_
Flag indicating if the InitializeStructure method has been called for the linear solver.
Index nonzeros_compressed_
Number of nonzeros in compressed format.