linsol.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2014 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_LINSOL_HPP
#define CASADI_LINSOL_HPP
 
#include "function.hpp"
#include "printable.hpp"
 
namespace casadi {
 
  // Forward declaration of internal class
  class LinsolInternal;
 
  class CASADI_EXPORT Linsol
    : public SharedObject,
      public SWIG_IF_ELSE(PrintableCommon, Printable<Linsol>) {
  public:
    static std::string type_name() {return "Linsol";}
 
    Linsol();
 
    explicit Linsol(const std::string& name, const std::string& solver,
                    const Sparsity& sp, const Dict& opts=Dict());
 
    LinsolInternal* operator->();
    const LinsolInternal* operator->() const;
 
#ifndef SWIG
    static bool test_cast(const SharedObjectInternal* ptr);
#endif //SWIG
 
#ifndef SWIG
    static Linsol create(LinsolInternal* node);
#endif // SWIG
 
    static bool has_plugin(const std::string& name);
 
    static void load_plugin(const std::string& name);
 
    static std::string doc(const std::string& name);
 
    std::string plugin_name() const;
 
    const Sparsity& sparsity() const;
 
    void sfact(const DM& A) const;
 
    void nfact(const DM& A) const;
 
    DM solve(const DM& A, const DM& B, bool tr=false) const;
    MX solve(const MX& A, const MX& B, bool tr=false) const;
 
    casadi_int neig(const DM& A) const;
 
    casadi_int rank(const DM& A) const;
 
    Dict stats(int mem=1) const;
 
    #ifndef SWIG
    int sfact(const double* A, int mem=0) const;
    int nfact(const double* A, int mem=0) const;
    int solve(const double* A, double* x, casadi_int nrhs=1, bool tr=false, int mem=0) const;
    casadi_int neig(const double* A, int mem=0) const;
    casadi_int rank(const double* A, int mem=0) const;
 
    casadi_int checkout() const;
 
    void release(int mem) const;
 
    void serialize(SerializingStream &s) const;
 
    static Linsol deserialize(DeserializingStream& s);
 
    #endif // SWIG
  };
 
  CASADI_EXPORT bool has_linsol(const std::string& name);
 
  CASADI_EXPORT void load_linsol(const std::string& name);
 
  CASADI_EXPORT std::string doc_linsol(const std::string& name);
 
} // namespace casadi
 
#endif // CASADI_LINSOL_HPP