casadi::GraphBuilderInternal Class Reference

Internal class for GraphBuilder. More...

#include <graph_builder_internal.hpp>

Detailed Description

Single mutable holder of graph metadata + configuration; dependency-free. Metadata is populated either from a parsed model (via a GraphModel backend) or from a source Function.

Date

2026

Extra doc: https://github.com/casadi/casadi/wiki/L_2jv

Definition at line 65 of file graph_builder_internal.hpp.

Inheritance diagram for casadi::GraphBuilderInternal:

Collaboration diagram for casadi::GraphBuilderInternal:

Public Types
using	weak_ref_type = WeakRefInternal

Public Member Functions
	GraphBuilderInternal (const std::string &name, const std::vector< uint8_t > &model_data, const std::string &format, const Dict &opts)
	Construct from parsed model bytes of a given format. More...
	GraphBuilderInternal (const std::string &name, const Function &f, const Dict &opts)
	Construct from a source Function (export lifecycle) More...
	~GraphBuilderInternal () override
std::string	class_name () const override
	Readable name of the internal class. More...
void	disp (std::ostream &stream, bool more) const override
	Print a description of the object. More...
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 >	input_shape (const std::string &name) const
std::vector< casadi_int >	output_shape (const std::string &name) const
std::vector< std::string >	dynamic_params () const
Node	node (const std::string &name) const
std::vector< Node >	nodes () 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_value (const std::string &input_name, const std::vector< double > &value)
Function	create_function (const std::string &name, const std::vector< std::string > &name_in, const std::vector< std::string > &name_out, const Dict &opts) const
void	export_onnx (const std::string &filename, const Dict &opts)
void	add_node (const Node &n)
	Append a tensor descriptor (called by a backend during fill_metadata) More...
void	clear_nodes ()
	Drop all tensor descriptors (called by a backend before re-filling) More...
std::vector< casadi_int >	resolved_shape (const Node &n) const
const Node &	find (const std::string &name, const std::string &io) const
	Locate a node by name in a given I/O role (throws if absent) More...
casadi_int	getCount () const
	Get the reference count. More...
std::string	debug_repr (const SharedObjectInternal *) const
GenericWeakRef< SharedObject, SharedObjectInternal > *	weak ()
	Get a weak reference to the object. More...
const std::vector< Node > &	node_list () const
const std::map< std::string, casadi_int > &	dim_bindings () const

Public Attributes
Dict	opts_
	Original constructor options, retained for lazy derivative model loading. More...
std::string	name_
std::string	format_
std::string	model_path_
	Absolute source filename, empty for in-memory models. More...
std::vector< uint8_t >	model_data_
Function	fun_
	Source Function (export lifecycle); null when built from a model. More...
GraphModel	model_
	Parsed model backend (import lifecycle); null when built from a Function. More...
std::vector< Node >	nodes_
	Tensor metadata (inputs followed by outputs) More...
std::map< std::string, casadi_int >	dim_bindings_
	Pending configuration carried into create() More...
std::map< std::string, std::vector< casadi_int > >	input_shapes_
std::map< std::string, std::vector< double > >	input_values_

Protected Member Functions
void	initSingleton ()
void	destroySingleton ()
B	shared_from_this ()
	Get a shared object from the current internal object. More...
const B	shared_from_this () const
	Get a shared object from the current internal object. More...

Member Typedef Documentation

weak_ref_type

using casadi::SharedObjectInternal::weak_ref_type = WeakRefInternal

inherited

Definition at line 152 of file shared_object.hpp.

Constructor & Destructor Documentation

GraphBuilderInternal() [1/2]

casadi::GraphBuilderInternal::GraphBuilderInternal	(	const std::string &	name,
		const std::vector< uint8_t > &	model_data,
		const std::string &	format,
		const Dict &	opts
	)

Definition at line 148 of file graph_builder.cpp.

    : opts_(opts), name_(name), format_(format), model_data_(model_data) {
    model_ = GraphModel(format, model_data, opts);
    model_.fill_metadata(*this);
  }

References casadi::GraphModel::fill_metadata(), and model_.

GraphBuilderInternal() [2/2]

casadi::GraphBuilderInternal::GraphBuilderInternal	(	const std::string &	name,
		const Function &	f,
		const Dict &	opts
	)

Definition at line 156 of file graph_builder.cpp.

    : opts_(opts), name_(name), format_("onnx"), fun_(f) {
    populate_from_function();
  }

~GraphBuilderInternal()

casadi::GraphBuilderInternal::~GraphBuilderInternal ( )

override

Definition at line 162 of file graph_builder.cpp.

                                              {
  }

Member Function Documentation

add_node()

void casadi::GraphBuilderInternal::add_node ( const Node &  n )

inline

Definition at line 98 of file graph_builder_internal.hpp.

{ nodes_.push_back(n); }

Referenced by casadi::Onnx::fill_metadata().

bind_dim()

void casadi::GraphBuilderInternal::bind_dim ( const std::string &  param, casadi_int  value  )

inline

Definition at line 87 of file graph_builder_internal.hpp.

{ dim_bindings_[param] = value; }

bind_shape()

void casadi::GraphBuilderInternal::bind_shape	(	const std::string &	input_name,
		const std::vector< casadi_int > &	shape
	)

Definition at line 262 of file graph_builder.cpp.

                                                                            {
    const Node& t = find(input_name, "input");
    casadi_assert(shape.size() == t.dimension.size(),
                  "bind_shape: rank mismatch for '" + input_name + "'");
    input_shapes_[input_name] = shape;
    // Pinning a named dynamic axis also binds that dim everywhere it appears (e.g. outputs)
    for (size_t k = 0; k < t.dimension.size(); ++k) {
      if (t.dimension[k] < 0 && !t.dim_params[k].empty()) dim_bindings_[t.dim_params[k]] = shape[k];
    }
  }

References dim_bindings_, casadi::Node::dim_params, casadi::Node::dimension, find(), and input_shapes_.

class_name()

std::string casadi::GraphBuilderInternal::class_name ( ) const

inlineoverridevirtual

Implements casadi::SharedObjectInternal.

Definition at line 74 of file graph_builder_internal.hpp.

{ return "GraphBuilderInternal"; }

clear_nodes()

void casadi::GraphBuilderInternal::clear_nodes ( )

inline

Definition at line 100 of file graph_builder_internal.hpp.

{ nodes_.clear(); }

Referenced by casadi::Onnx::fill_metadata().

create_function()

Function casadi::GraphBuilderInternal::create_function	(	const std::string &	name,
		const std::vector< std::string > &	name_in,
		const std::vector< std::string > &	name_out,
		const Dict &	opts
	)		const

Definition at line 274 of file graph_builder.cpp.

                              {
    bool symbolic = false;
    std::string backend = "ort";
    Dict o;
    for (auto&& op : opts) {
      if (op.first == "symbolic") symbolic = op.second;
      else if (op.first == "backend") backend = op.second.to_string();
      else
        o[op.first] = op.second;
    }
 
    if (symbolic) {
      casadi_assert(!model_.is_null(),
        "GraphBuilder: symbolic create requires a parsed model (build from a file)");
      Function f = model_.import_symbolic(*this, name);
      if (o.empty()) return f;
      std::vector<MX> args = f.mx_in(), res;
      f.call(args, res, true);
      return Function(name, args, res, f.name_in(), f.name_out(), o);
    }
 
    // Numeric path: OnnxFunction freezes a snapshot directly from this builder's config
    casadi_assert(!model_data_.empty(), "GraphBuilder: numeric create requires model bytes");
    return OnnxFunction::create(backend, name, this, inputs, outputs, o);
  }

References casadi::Function::call(), casadi::OnnxFunction::create(), casadi::GraphModel::import_symbolic(), casadi::GenericShared< Shared, Internal >::is_null(), model_, model_data_, casadi::Function::mx_in(), casadi::Function::name_in(), and casadi::Function::name_out().

debug_repr()

std::string casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::debug_repr ( const Internal *  i ) const

inherited

Definition at line 62 of file generic_shared_internal.hpp.

                                                                                       {
    // Note: i != this because of something something multiple inheritance
    return str( (casadi_int)(i)) + "/" + static_cast<const Internal*>(this)->class_name();
  }

destroySingleton()

void casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::destroySingleton ( )

inlineprotectedinherited

Called in the destructor of singletons

Definition at line 77 of file generic_shared_internal.hpp.

                            {
      static_cast<Internal*>(this)->count--;
    }

dim_bindings()

const std::map<std::string, casadi_int>& casadi::GraphBuilderInternal::dim_bindings ( ) const

inline

Read-only views for backends

Definition at line 105 of file graph_builder_internal.hpp.

{ return dim_bindings_; }

Referenced by casadi::Onnx::import_symbolic().

disp()

void casadi::GraphBuilderInternal::disp ( std::ostream &  stream, bool  more  ) const

overridevirtual

Implements casadi::SharedObjectInternal.

Definition at line 317 of file graph_builder.cpp.

                                                                     {
    stream << "GraphBuilder '" << name_ << "': " << n_in() << " input(s), "
           << n_out() << " output(s)";
    if (!more) return;
    stream << "\nInputs:";
    for (const Node& n : nodes_) if (n.io == "input") stream << "\n  " << n.get_str();
    stream << "\nOutputs:";
    for (const Node& n : nodes_) if (n.io == "output") stream << "\n  " << n.get_str();
    std::vector<std::string> dp = dynamic_params();
    if (!dp.empty()) {
      stream << "\nDynamic dimensions:";
      for (const std::string& p : dp) stream << " " << p;
    }
  }

References dynamic_params(), n_in(), n_out(), name_, and nodes_.

dynamic_params()

std::vector< std::string > casadi::GraphBuilderInternal::dynamic_params

(

)

const

Definition at line 234 of file graph_builder.cpp.

                                                                  {
    std::vector<std::string> r;
    for (const Node& n : nodes_) {
      for (size_t k = 0; k < n.dimension.size(); ++k) {
        if (n.dimension[k] < 0 && !n.dim_params[k].empty() &&
            std::find(r.begin(), r.end(), n.dim_params[k]) == r.end()) {
          r.push_back(n.dim_params[k]);
        }
      }
    }
    return r;
  }

References nodes_.

Referenced by disp().

export_onnx()

void casadi::GraphBuilderInternal::export_onnx	(	const std::string &	filename,
		const Dict &	opts
	)

Definition at line 303 of file graph_builder.cpp.

                                                                                    {
    std::vector<uint8_t> bytes;
    if (!fun_.is_null()) {
      GraphModel gm(format_);
      bytes = gm.export_symbolic(fun_, opts);
    } else {
      casadi_assert(!model_data_.empty(), "GraphBuilder: nothing to export");
      bytes = model_data_;
    }
    std::ofstream out(filename, std::ios::binary);
    casadi_assert(out.good(), "Cannot open output file: " + filename);
    out.write(reinterpret_cast<const char*>(bytes.data()), bytes.size());
  }

References casadi::GraphModel::export_symbolic(), casadi::filename(), format_, fun_, casadi::GenericShared< Shared, Internal >::is_null(), and model_data_.

find()

const Node & casadi::GraphBuilderInternal::find	(	const std::string &	name,
		const std::string &	io
	)		const

Definition at line 202 of file graph_builder.cpp.

                                                                                         {
    for (const Node& n : nodes_) if (n.io == io && n.name == name) return n;
    casadi_error("Graph tensor '" + name + "' (" + io + ") not found in model '" + name_ + "'");
  }

References name_, and nodes_.

Referenced by bind_shape(), input_shape(), output_shape(), and set_value().

getCount()

casadi_int casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::getCount

inherited

Definition at line 60 of file generic_shared_internal.hpp.

                                                                     {
    return static_cast<const Internal*>(this)->count;
  }

initSingleton()

void casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::initSingleton ( )

inlineprotectedinherited

Called in the constructor of singletons to avoid that the counter reaches zero

Definition at line 71 of file generic_shared_internal.hpp.

                         {
      casadi_assert_dev(static_cast<Internal*>(this)->count==0);
      static_cast<Internal*>(this)->count++;
    }

input_shape()

std::vector< casadi_int > casadi::GraphBuilderInternal::input_shape

(

const std::string &

name

)

const

Definition at line 227 of file graph_builder.cpp.

                                                                                     {
    return find(name, "input").dimension;
  }

References casadi::Node::dimension, and find().

n_in()

casadi_int casadi::GraphBuilderInternal::n_in

(

)

const

Definition at line 207 of file graph_builder.cpp.

                                              {
    casadi_int c = 0;
    for (const Node& n : nodes_) if (n.io == "input") ++c;
    return c;
  }

References nodes_.

Referenced by disp().

n_out()

casadi_int casadi::GraphBuilderInternal::n_out

(

)

const

Definition at line 212 of file graph_builder.cpp.

                                               {
    casadi_int c = 0;
    for (const Node& n : nodes_) if (n.io == "output") ++c;
    return c;
  }

References nodes_.

Referenced by disp().

name_in()

std::vector< std::string > casadi::GraphBuilderInternal::name_in

(

)

const

Definition at line 217 of file graph_builder.cpp.

                                                           {
    std::vector<std::string> r;
    for (const Node& n : nodes_) if (n.io == "input") r.push_back(n.name);
    return r;
  }

References nodes_.

name_out()

std::vector< std::string > casadi::GraphBuilderInternal::name_out

(

)

const

Definition at line 222 of file graph_builder.cpp.

                                                            {
    std::vector<std::string> r;
    for (const Node& n : nodes_) if (n.io == "output") r.push_back(n.name);
    return r;
  }

References nodes_.

node()

Node casadi::GraphBuilderInternal::node

(

const std::string &

name

)

const

Definition at line 247 of file graph_builder.cpp.

                                                             {
    for (const Node& n : nodes_) if (n.name == name) return n;
    casadi_error("Graph tensor '" + name + "' not found in model '" + name_ + "'");
  }

References name_, and nodes_.

node_list()

const std::vector<Node>& casadi::GraphBuilderInternal::node_list ( ) const

inline

Read-only views for backends

Definition at line 104 of file graph_builder_internal.hpp.

{ return nodes_; }

Referenced by casadi::OnnxFunction::init(), casadi::OnnxFunction::OnnxFunction(), and casadi::OnnxFunction::wrap_derivative().

nodes()

std::vector<Node> casadi::GraphBuilderInternal::nodes ( ) const

inline

Definition at line 85 of file graph_builder_internal.hpp.

{ return nodes_; }

output_shape()

std::vector< casadi_int > casadi::GraphBuilderInternal::output_shape

(

const std::string &

name

)

const

Definition at line 230 of file graph_builder.cpp.

                                                                                      {
    return find(name, "output").dimension;
  }

References casadi::Node::dimension, and find().

resolved_shape()

std::vector< casadi_int > casadi::GraphBuilderInternal::resolved_shape

(

const Node &

n

)

const

Resolve a node's declared shape to concrete sizes: input_shapes_ override (inputs), else dynamic axes bound via dim_bindings_ (named) or defaulted to 1

Definition at line 185 of file graph_builder.cpp.

                                                                                {
    if (n.io == "input") {
      auto ov = input_shapes_.find(n.name);
      if (ov != input_shapes_.end()) return ov->second;  // explicit override
    }
    std::vector<casadi_int> shape;
    for (size_t k = 0; k < n.dimension.size(); ++k) {
      casadi_int d = n.dimension[k];
      if (d < 0) {  // dynamic: bound name else default 1
        auto it = dim_bindings_.find(n.dim_params[k]);
        d = (it != dim_bindings_.end()) ? it->second : 1;
      }
      shape.push_back(d);
    }
    return shape;
  }

References dim_bindings_, casadi::Node::dim_params, casadi::Node::dimension, input_shapes_, casadi::Node::io, and casadi::Node::name.

Referenced by casadi::OnnxFunction::OnnxFunction().

set_value()

void casadi::GraphBuilderInternal::set_value	(	const std::string &	input_name,
		const std::vector< double > &	value
	)

Definition at line 252 of file graph_builder.cpp.

                                                                       {
    find(input_name, "input");  // validate the name
    input_values_[input_name] = value;
    for (Node& n : nodes_) if (n.io == "input" && n.name == input_name) {
      n.value = value;
      n.baked = true;
    }
  }

References find(), input_values_, and nodes_.

shared_from_this() [1/2]

B casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::shared_from_this ( )

inlineprotectedinherited

Definition at line 83 of file generic_shared_internal.hpp.

                         {
      casadi_assert_dev(B::test_cast(static_cast<Internal*>(this)));
      B ret;
      ret.own(static_cast<Internal*>(this));
      return ret;
    }

shared_from_this() [2/2]

const B casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::shared_from_this ( ) const

inlineprotectedinherited

Definition at line 92 of file generic_shared_internal.hpp.

                                     {
      casadi_assert_dev(B::test_cast(static_cast<const Internal*>(this)));
      B ret;
      ret.own(const_cast<Internal*>(static_cast<const Internal*>(this)));
      return ret;
    }

weak()

GenericWeakRef< SharedObject , SharedObjectInternal > * casadi::GenericSharedInternal< SharedObject , SharedObjectInternal >::weak

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_1ai

Definition at line 67 of file generic_shared_internal.hpp.

                                                                                  {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
    auto* w = weak_ref_.load(std::memory_order_acquire);
    if (!w) {
      auto* nw = new GenericWeakRef<Shared, Internal>(static_cast<Internal*>(this));
      GenericWeakRef<Shared, Internal>* expected = nullptr;
      if (weak_ref_.compare_exchange_strong(
            expected, nw, std::memory_order_release, std::memory_order_acquire)) {
        w = nw;
      } else {
        delete nw; // lost the race; another thread published first
        w = expected;
      }
    }
    return w;
#else
    if (weak_ref_==nullptr) {
      weak_ref_ = new GenericWeakRef<Shared, Internal>(static_cast<Internal*>(this));
    }
    return weak_ref_;
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
  }

Member Data Documentation

dim_bindings_

std::map<std::string, casadi_int> casadi::GraphBuilderInternal::dim_bindings_

Definition at line 132 of file graph_builder_internal.hpp.

Referenced by bind_shape(), casadi::OnnxFunction::from_model_data(), casadi::OnnxFunction::OnnxFunction(), resolved_shape(), and casadi::OnnxFunction::wrap_derivative().

format_

std::string casadi::GraphBuilderInternal::format_

Definition at line 119 of file graph_builder_internal.hpp.

Referenced by export_onnx().

fun_

Function casadi::GraphBuilderInternal::fun_

Definition at line 124 of file graph_builder_internal.hpp.

Referenced by export_onnx().

input_shapes_

std::map<std::string, std::vector<casadi_int> > casadi::GraphBuilderInternal::input_shapes_

Definition at line 133 of file graph_builder_internal.hpp.

Referenced by bind_shape(), casadi::OnnxFunction::from_model_data(), casadi::OnnxFunction::OnnxFunction(), resolved_shape(), and casadi::OnnxFunction::wrap_derivative().

input_values_

std::map<std::string, std::vector<double> > casadi::GraphBuilderInternal::input_values_

Definition at line 134 of file graph_builder_internal.hpp.

Referenced by casadi::OnnxFunction::from_model_data(), casadi::OnnxFunction::OnnxFunction(), set_value(), and casadi::OnnxFunction::wrap_derivative().

model_

GraphModel casadi::GraphBuilderInternal::model_

Definition at line 126 of file graph_builder_internal.hpp.

Referenced by create_function(), and GraphBuilderInternal().

model_data_

std::vector<uint8_t> casadi::GraphBuilderInternal::model_data_

Definition at line 121 of file graph_builder_internal.hpp.

Referenced by create_function(), export_onnx(), and casadi::OnnxFunction::OnnxFunction().

model_path_

std::string casadi::GraphBuilderInternal::model_path_

Definition at line 120 of file graph_builder_internal.hpp.

Referenced by casadi::OnnxFunction::OnnxFunction(), and casadi::OnnxFunction::wrap_derivative().

name_

std::string casadi::GraphBuilderInternal::name_

Definition at line 118 of file graph_builder_internal.hpp.

Referenced by disp(), find(), node(), and casadi::OnnxFunction::wrap_derivative().

nodes_

std::vector<Node> casadi::GraphBuilderInternal::nodes_

Definition at line 129 of file graph_builder_internal.hpp.

Referenced by disp(), dynamic_params(), find(), n_in(), n_out(), name_in(), name_out(), node(), and set_value().

opts_

Dict casadi::GraphBuilderInternal::opts_

Definition at line 116 of file graph_builder_internal.hpp.

Referenced by casadi::OnnxFunction::OnnxFunction().

---

The documentation for this class was generated from the following files:

• graph_builder_internal.hpp
• graph_builder.cpp