IpMa57TSolverInterface.hpp

Go to the documentation of this file.

// Copyright (C) 2005, 2006 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Michael Hagemann               Univ of Basel 2005-10-28
//               original version (based on MA27TSolverInterface.hpp)
 
#ifndef __IPMA57TSOLVERINTERFACE_HPP__
#define __IPMA57TSOLVERINTERFACE_HPP__
 
#include "IpSparseSymLinearSolverInterface.hpp"
#include "IpLibraryLoader.hpp"
#include "IpTypes.h"
 
#ifdef FUNNY_MA57_FINT
#include <cstddef>
typedef ptrdiff_t ma57int;
#else
#include "IpTypes.h"
typedef ipindex ma57int;
#endif
 
#define IPOPT_DECL_MA57A(x) void (x)( \
   ma57int*       n,      \
   ma57int*       ne,     \
   const ma57int* irn,    \
   const ma57int* jcn,    \
   ma57int*       lkeep,  \
   ma57int*       keep,   \
   /* Automatically iflag = 0; ikeep pivot order iflag = 1 */ \
   ma57int*       iwork,  \
   ma57int*       icntl,  \
   ma57int*       info,   \
   ipnumber*      rinfo   \
)
 
#define IPOPT_DECL_MA57B(x) void (x)( \
   ma57int*   n,       \
   ma57int*   ne,      \
   ipnumber*  a,       \
   ipnumber*  fact,    \
   ma57int*   lfact,   \
   ma57int*   ifact,   \
   ma57int*   lifact,  \
   ma57int*   lkeep,   \
   ma57int*   keep,    \
   ma57int*   iwork,   \
   ma57int*   icntl,   \
   ipnumber*  cntl,    \
   ma57int*   info,    \
   ipnumber*  rinfo    \
)
 
/* Solution job:  Solve for...
 * - JOB <= 1:  A
 * - JOB == 2:  PLP^t
 * - JOB == 3:  PDP^t
 * - JOB >= 4:  PL^t P^t
 */
#define IPOPT_DECL_MA57C(x) void (x)( \
   ma57int*   job,     \
   ma57int*   n,       \
   ipnumber*  fact,    \
   ma57int*   lfact,   \
   ma57int*   ifact,   \
   ma57int*   lifact,  \
   ma57int*   nrhs,    \
   ipnumber*  rhs,     \
   ma57int*   lrhs,    \
   ipnumber*  work,    \
   ma57int*   lwork,   \
   ma57int*   iwork,   \
   ma57int*   icntl,   \
   ma57int*   info     \
)
 
#define IPOPT_DECL_MA57E(x) void (x)( \
   ma57int*   n,      \
   ma57int*   ic,   \
   ma57int*   keep,   \
   ipnumber*  fact,   \
   ma57int*   lfact,  \
   ipnumber*  newfac, \
   ma57int*   lnew,   \
   ma57int*   ifact,  \
   ma57int*   lifact, \
   ma57int*   newifc, \
   ma57int*   linew,  \
   ma57int*   info    \
)
 
#define IPOPT_DECL_MA57I(x) void (x)( \
   ipnumber* cntl, \
   ma57int*  icntl \
)
 
namespace Ipopt
{
class Ma57TSolverInterface: public SparseSymLinearSolverInterface
{
public:
 
   Ma57TSolverInterface(
      SmartPtr<LibraryLoader> hslloader_   
   );
 
   virtual ~Ma57TSolverInterface();
 
   bool InitializeImpl(
      const OptionsList& options,
      const std::string& prefix
   );
 
   virtual ESymSolverStatus InitializeStructure(
      Index        dim,
      Index        nonzeros,
      const Index* airn,
      const Index* ajcn
   );
 
   virtual Number* GetValuesArrayPtr();
 
   virtual ESymSolverStatus MultiSolve(
      bool         new_matrix,
      const Index* airn,
      const Index* ajcn,
      Index        nrhs,
      Number*      rhs_vals,
      bool         check_NegEVals,
      Index        numberOfNegEVals
   );
 
   virtual Index NumberOfNegEVals() const;
 
   //* @name Options of Linear solver */
   virtual bool IncreaseQuality();
 
   virtual bool ProvidesInertia() const
   {
      return true;
   }
 
   EMatrixFormat MatrixFormat() const
   {
      return Triplet_Format;
   }
 
   static void RegisterOptions(
      SmartPtr<RegisteredOptions> roptions
   );
 
   static void SetFunctions(
      IPOPT_DECL_MA57A(*ma57a),
      IPOPT_DECL_MA57B(*ma57b),
      IPOPT_DECL_MA57C(*ma57c),
      IPOPT_DECL_MA57E(*ma57e),
      IPOPT_DECL_MA57I(*ma57i)
   );
 
private:
 
   Ma57TSolverInterface(
      const Ma57TSolverInterface&
   );
 
   void operator=(
      const Ma57TSolverInterface&
   );
 
   SmartPtr<LibraryLoader> hslloader;
 
   IPOPT_DECL_MA57A(*ma57a);
   IPOPT_DECL_MA57B(*ma57b);
   IPOPT_DECL_MA57C(*ma57c);
   IPOPT_DECL_MA57E(*ma57e);
   IPOPT_DECL_MA57I(*ma57i);
 
 
   Index dim_;
 
   Index nonzeros_;
 
 
   Index negevals_;
 
 
   bool initialized_;
   bool pivtol_changed_;
   bool refactorize_;
 
 
   Number pivtol_;
   Number pivtolmax_;
   Number ma57_pre_alloc_;
   bool warm_start_same_structure_;
 
   Number wd_cntl_[5];
   ma57int wd_icntl_[20];
 
   ma57int wd_info_[40];
   Number wd_rinfo_[20];
 
   ma57int wd_lkeep_; /* LKEEP >= 5*N + NE + max(N,NE) + 42. */
   ma57int* wd_keep_;
 
   ma57int* wd_iwork_; /* 5 * N. */
 
   Number* wd_fact_;
   ma57int wd_lfact_;
   ma57int* wd_ifact_;
   ma57int wd_lifact_;
 
   Number* a_;
 
 
   ESymSolverStatus SymbolicFactorization(
      const Index* airn,
      const Index* ajcn
   );
 
   ESymSolverStatus Factorization(
      const Index* airn,
      const Index* ajcn,
      bool         check_NegEVals,
      Index        numberOfNegEVals
   );
 
   ESymSolverStatus Backsolve(
      Index   nrhs,
      Number* rhs_vals
   );
};
 
} // namespace Ipopt
#endif