IpSymLinearSolver.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2006 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13
 
#ifndef __IPSYMLINEARSOLVER_HPP__
#define __IPSYMLINEARSOLVER_HPP__
 
#include "IpUtils.hpp"
#include "IpSymMatrix.hpp"
#include "IpAlgStrategy.hpp"
#include <vector>
 
namespace Ipopt
{
 
enum ESymSolverStatus
{
   SYMSOLVER_SUCCESS,
   SYMSOLVER_SINGULAR,
   SYMSOLVER_WRONG_INERTIA,
   SYMSOLVER_CALL_AGAIN,
   SYMSOLVER_FATAL_ERROR
};
 
class IPOPTLIB_EXPORT SymLinearSolver: public AlgorithmStrategyObject
{
public:
   SymLinearSolver()
   { }
 
   virtual ~SymLinearSolver()
   { }
 
   virtual bool InitializeImpl(
      const OptionsList& options,
      const std::string& prefix
   ) = 0;
 
 
   virtual ESymSolverStatus MultiSolve(
      const SymMatrix&                      A,
      std::vector<SmartPtr<const Vector> >& rhsV,
      std::vector<SmartPtr<Vector> >&       solV,
      bool                                  check_NegEVals,
      Index                                 numberOfNegEVals
   ) = 0;
 
   ESymSolverStatus Solve(
      const SymMatrix& A,
      const Vector&    rhs,
      Vector&          sol,
      bool             check_NegEVals,
      Index            numberOfNegEVals
   )
   {
      std::vector<SmartPtr<const Vector> > rhsV(1);
      rhsV[0] = &rhs;
      std::vector<SmartPtr<Vector> > solV(1);
      solV[0] = &sol;
      return MultiSolve(A, rhsV, solV, check_NegEVals, numberOfNegEVals);
   }
 
   virtual Index NumberOfNegEVals() const = 0;
 
   //* @name Options of Linear solver */
 
   virtual bool IncreaseQuality() = 0;
 
   virtual bool ProvidesInertia() const = 0;
};
 
} // namespace Ipopt
 
#endif