graph_builder.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_GRAPH_BUILDER_HPP
#define CASADI_GRAPH_BUILDER_HPP
 
#include "function.hpp"
 
namespace casadi {
 
  class GraphBuilderInternal;
 
  class CASADI_EXPORT GraphBuilder
    : public SharedObject,
      public SWIG_IF_ELSE(PrintableCommon, Printable<GraphBuilder>) {
   public:
    std::string type_name() const { return "GraphBuilder"; }
 
    GraphBuilder();
 
    explicit GraphBuilder(const std::string& model_path, const Dict& opts = Dict());
 
    explicit GraphBuilder(const Function& f, const Dict& opts = Dict());
 
#ifndef SWIG
    GraphBuilder(const std::string& name, const std::vector<uint8_t>& model_data,
                 const std::string& format, const Dict& opts = Dict());
#endif // SWIG
 
    const std::string& name() const;
 
 
    casadi_int n_in() const;
    casadi_int n_out() const;
    std::vector<std::string> name_in() const;
    std::vector<std::string> name_out() const;
    std::vector<casadi_int> dimension(const std::string& name) const;
    std::string dtype(const std::string& name) const;
    std::vector<std::string> dimension_param(const std::string& name) const;
    std::vector<std::string> dynamic_params() const;
 
 
    void bind_dim(const std::string& param, casadi_int value);
    void bind_shape(const std::string& input_name, const std::vector<casadi_int>& shape);
    void set(const std::string& input_name, const std::vector<double>& value);
    void set(const std::string& input_name, double value);
 
    Function create(const std::string& name,
      const std::vector<std::string>& name_in,
      const std::vector<std::string>& name_out,
      const Dict& opts = Dict()) const;
 
    Function create(const std::string& name, const Dict& opts = Dict()) const;
 
    Function create() const { return create(name() + "_graph"); }
 
    void export_onnx(const std::string& filename, const Dict& opts = Dict());
 
#ifndef SWIG
    GraphBuilderInternal* operator->();
    const GraphBuilderInternal* operator->() const;
    GraphBuilderInternal* get() const;
#endif // SWIG
  };
 
} // namespace casadi
 
#endif // CASADI_GRAPH_BUILDER_HPP