Ipopt 3.11.9
Loading...
Searching...
No Matches
IpSymLinearSolver.hpp
Go to the documentation of this file.
1// Copyright (C) 2004, 2006 International Business Machines and others.
2// All Rights Reserved.
3// This code is published under the Eclipse Public License.
4//
5// $Id: IpSymLinearSolver.hpp 2332 2013-06-14 14:05:12Z stefan $
6//
7// Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8
9#ifndef __IPSYMLINEARSOLVER_HPP__
10#define __IPSYMLINEARSOLVER_HPP__
11
12#include "IpUtils.hpp"
13#include "IpSymMatrix.hpp"
14#include "IpAlgStrategy.hpp"
15#include <vector>
16
17namespace Ipopt
18{
19
35
51 {
52 public:
57
59 {}
61
63 virtual bool InitializeImpl(const OptionsList& options,
64 const std::string& prefix) = 0;
65
81 std::vector<SmartPtr<const Vector> >& rhsV,
82 std::vector<SmartPtr<Vector> >& solV,
83 bool check_NegEVals,
84 Index numberOfNegEVals)=0;
85
90 const Vector& rhs, Vector& sol,
91 bool check_NegEVals,
92 Index numberOfNegEVals)
93 {
94 std::vector<SmartPtr<const Vector> > rhsV(1);
95 rhsV[0] = &rhs;
96 std::vector<SmartPtr<Vector> > solV(1);
97 solV[0] = &sol;
98 return MultiSolve(A, rhsV, solV, check_NegEVals,
99 numberOfNegEVals);
100 }
101
108 virtual Index NumberOfNegEVals() const =0;
110
111 //* @name Options of Linear solver */
113
118 virtual bool IncreaseQuality() =0;
119
123 virtual bool ProvidesInertia() const =0;
125 };
126
127
128} // namespace Ipopt
129
130#endif
This is the base class for all algorithm strategy objects.
This class stores a list of user set options.
Template class for Smart Pointers.
Base class for all derived symmetric linear solvers.
virtual bool IncreaseQuality()=0
Request to increase quality of solution for next solve.
virtual Index NumberOfNegEVals() const =0
Number of negative eigenvalues detected during last factorization.
virtual ESymSolverStatus MultiSolve(const SymMatrix &A, std::vector< SmartPtr< const Vector > > &rhsV, std::vector< SmartPtr< Vector > > &solV, bool check_NegEVals, Index numberOfNegEVals)=0
Solve operation for multiple right hand sides.
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)=0
overloaded from AlgorithmStrategyObject
ESymSolverStatus Solve(const SymMatrix &A, const Vector &rhs, Vector &sol, bool check_NegEVals, Index numberOfNegEVals)
Solve operation for a single right hand side.
virtual bool ProvidesInertia() const =0
Query whether inertia is computed by linear solver.
This is the base class for all derived symmetric matrix types.
Vector Base Class.
Definition IpVector.hpp:48
ESymSolverStatus
Enum to report outcome of a linear solve.
@ SYMSOLVER_FATAL_ERROR
Unrecoverable error in linear solver occurred.
@ SYMSOLVER_SUCCESS
Successful solve.
@ SYMSOLVER_WRONG_INERTIA
The number of negative eigenvalues is not correct.
@ SYMSOLVER_SINGULAR
Matrix seems to be singular; solve was aborted.
@ SYMSOLVER_CALL_AGAIN
Call the solver interface again after the matrix values have been restored.
int Index
Type of all indices of vectors, matrices etc.
Definition IpTypes.hpp:19