IpSparseSymLinearSolverInterface.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2007 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-03-17
 
#ifndef __IPSPARSESYMLINEARSOLVERINTERFACE_HPP__
#define __IPSPARSESYMLINEARSOLVERINTERFACE_HPP__
 
#include "IpUtils.hpp"
#include "IpAlgStrategy.hpp"
#include "IpSymLinearSolver.hpp"
 
namespace Ipopt
{
 
class SparseSymLinearSolverInterface: public AlgorithmStrategyObject
{
public:
   enum EMatrixFormat
   {
      Triplet_Format,
      CSR_Format_0_Offset,
      CSR_Format_1_Offset,
      CSR_Full_Format_0_Offset,
      CSR_Full_Format_1_Offset
   };
 
   SparseSymLinearSolverInterface()
   { }
 
   virtual ~SparseSymLinearSolverInterface()
   { }
 
   virtual bool InitializeImpl(
      const OptionsList& options,
      const std::string& prefix
   ) = 0;
 
 
   virtual ESymSolverStatus InitializeStructure(
      Index        dim,
      Index        nonzeros,
      const Index* ia,
      const Index* ja
   ) = 0;
 
   virtual Number* GetValuesArrayPtr() = 0;
 
   virtual ESymSolverStatus MultiSolve(
      bool         new_matrix,
      const Index* ia,
      const Index* ja,
      Index        nrhs,
      Number*      rhs_vals,
      bool         check_NegEVals,
      Index        numberOfNegEVals
   ) = 0;
 
   virtual Index NumberOfNegEVals() const = 0;
 
   //* @name Options of Linear solver */
 
   virtual bool IncreaseQuality() = 0;
 
   virtual bool ProvidesInertia() const = 0;
 
   virtual EMatrixFormat MatrixFormat() const = 0;
 
 
   virtual bool ProvidesDegeneracyDetection() const
   {
      return false;
   }
 
   virtual ESymSolverStatus DetermineDependentRows(
      const Index*      /*ia*/,
      const Index*      /*ja*/,
      std::list<Index>& /*c_deps*/
   )
   {
      return SYMSOLVER_FATAL_ERROR;
   }
};
 
} // namespace Ipopt
 
#endif