lapack_lu.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#ifndef CASADI_LAPACK_LU_HPP
#define CASADI_LAPACK_LU_HPP
 
#include "casadi/core/linsol_internal.hpp"
#include <casadi/interfaces/lapack/casadi_linsol_lapacklu_export.h>
 
// On WebAssembly the wasm linker enforces strict function signatures, and
// the flang-built LAPACK on wasm uses the standard Fortran-77 ABI where
// CHARACTER arguments have a hidden trailing length (size_t).  Native
// builds of LAPACK (OpenBLAS/MKL/Netlib via gfortran) also use this ABI
// but are tolerant of the missing length on most architectures because
// the extra argument lands in an unused register/stack slot.  We add the
// hidden length parameter on wasm only to keep the native side unchanged.
#ifdef __EMSCRIPTEN__
#define CASADI_LAPACK_CHARLEN_1 , 1
#define CASADI_LAPACK_CHARLEN_DECL_1 , size_t len1
#define CASADI_LAPACK_CHARLEN_DECL_2 , size_t len1, size_t len2
#define CASADI_LAPACK_CHARLEN_DECL_4 , size_t len1, size_t len2, size_t len3, size_t len4
#define CASADI_LAPACK_CHARLEN_2 , 1, 1
#define CASADI_LAPACK_CHARLEN_4 , 1, 1, 1, 1
#else
#define CASADI_LAPACK_CHARLEN_1
#define CASADI_LAPACK_CHARLEN_DECL_1
#define CASADI_LAPACK_CHARLEN_DECL_2
#define CASADI_LAPACK_CHARLEN_DECL_4
#define CASADI_LAPACK_CHARLEN_2
#define CASADI_LAPACK_CHARLEN_4
#endif
 
extern "C" {
  void dgetrf_(int *m, int *n, double *a, int *lda, int *ipiv, int *info);
 
  void dgetrs_(char* trans, int *n, int *nrhs, double *a,
               int *lda, int *ipiv, double *b, int *ldb, int *info
               CASADI_LAPACK_CHARLEN_DECL_1);
 
  void dgeequ_(int *m, int *n, double *a, int *lda, double *r, double *c,
               double *colcnd, double *rowcnd, double *amax, int *info);
 
  void dlaqge_(int *m, int *n, double *a, int *lda, double *r, double *c,
               double *colcnd, double *rowcnd, double *amax, char *equed
               CASADI_LAPACK_CHARLEN_DECL_1);
}
 
namespace casadi {
 
  struct  LapackLuMemory : public LinsolMemory {
    // Matrix
    std::vector<double> mat;
 
    std::vector<int> ipiv;
 
    std::vector<double> r, c;
 
    char equed;
  };
 
  class  LapackLu : public LinsolInternal {
  public:
    // Create a linear solver given a sparsity pattern and a number of right hand sides
    LapackLu(const std::string& name, const Sparsity& sp);
 
    static LinsolInternal* creator(const std::string& name, const Sparsity& sp) {
      return new LapackLu(name, sp);
    }
 
    ~LapackLu() override;
 
 
    static const Options options_;
    const Options& get_options() const override { return options_;}
 
    void init(const Dict& opts) override;
 
    void* alloc_mem() const override { return new LapackLuMemory();}
 
    int init_mem(void* mem) const override;
 
    void free_mem(void *mem) const override { delete static_cast<LapackLuMemory*>(mem);}
 
    // Factorize the linear system
    int nfact(void* mem, const double* A) const override;
 
    // Solve the linear system
    int solve(void* mem, const double* A, double* x, casadi_int nrhs, bool tr) const override;
 
    static const std::string meta_doc;
 
    void serialize_body(SerializingStream &s) const override;
 
    static ProtoFunction* deserialize(DeserializingStream& s) { return new LapackLu(s); }
 
  protected:
    explicit LapackLu(DeserializingStream& s);
 
    bool equilibriate_;
 
    bool allow_equilibration_failure_;
 
    // Get name of the plugin
    const char* plugin_name() const override { return "lapacklu";}
 
    // Get name of the class
    std::string class_name() const override { return "LapackLu";}
  };
 
 
} // namespace casadi
 
#endif // CASADI_LAPACK_LU_HPP