Format-agnostic handle to a parsed computational-graph model. More...

#include <graph_model_impl.hpp>

Detailed Description

Loaded by format name as a plugin (e.g. "onnx"); the concrete backend is the only place a heavy dependency (protobuf) is linked. The Fmu analogue for GraphBuilder. Internal: owned by GraphBuilderInternal, not exposed to the scripting layer.

Date: 2026

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

List of available options
Id	Type	Description	Used in
verbose	OT_BOOL	Verbose evaluation – for debugging	casadi::GraphModel

Definition at line 47 of file graph_model_impl.hpp.

Inheritance diagram for casadi::GraphModel:

[legend]

Collaboration diagram for casadi::GraphModel:

[legend]

Public Types
using	internal_base_type = SharedObjectInternal

using	base_type = SharedObject

Public Member Functions
std::string	type_name () const
	Readable name of the class. More...

	GraphModel ()
	Default constructor (null handle) More...

	GraphModel (const std::string &format, const std::vector< uint8_t > &model_data=std::vector< uint8_t >(), const Dict &opts=Dict())
	Load a backend for a format, optionally with parsed model bytes. More...

std::string	format () const
	Format name (plugin name) More...

void	fill_metadata (GraphBuilderInternal &gb) const
	Populate a builder's Node metadata from the parsed model. More...

Function	import_symbolic (const GraphBuilderInternal &gb, const std::string &name) const
	Symbolic import: rebuild the graph as a CasADi Function. More...

std::vector< uint8_t >	export_symbolic (const Function &f, const Dict &opts=Dict())
	Symbolic export: serialize a CasADi Function to model bytes. More...

const std::vector< uint8_t > &	model_data () const
	Raw model bytes. More...

std::string	class_name () const
	Get class name. More...

void	disp (std::ostream &stream, bool more=false) const
	Print a description of the object. More...

std::string	get_str (bool more=false) const
	Get string representation. More...

void	print_ptr (std::ostream &stream=casadi::uout()) const

void	own (SharedObjectInternal *node)

void	assign (SharedObjectInternal *node)
	Assign the node to a node class pointer without reference counting. More...

casadi_int	getCount () const
	Get the reference count. More...

void	swap (GenericShared &other)
	Swap content with another instance. More...

std::string	debug_repr () const

bool	is_null () const
	Is a null pointer? More...

casadi_int	__hash__ () const
	Returns a number that is unique for a given Node. More...

GenericWeakRef< SharedObject, SharedObjectInternal > *	weak ()
	Get a weak reference to the object. More...


GraphModelInternal *	operator-> ()

const GraphModelInternal *	operator-> () const

GraphModelInternal *	get () const

Static Public Member Functions
static bool	has_plugin (const std::string &name)
	Check if a format plugin is available. More...

static void	load_plugin (const std::string &name)
	Explicitly load a format plugin. More...

static std::string	doc (const std::string &name)
	Get format-specific documentation. More...

Protected Member Functions
void	count_up ()

void	count_down ()

Member Typedef Documentation

◆ base_type

using casadi::SharedObject::base_type = SharedObject

inherited

Definition at line 103 of file shared_object.hpp.

◆ internal_base_type

using casadi::SharedObject::internal_base_type = SharedObjectInternal

inherited

Definition at line 102 of file shared_object.hpp.

Constructor & Destructor Documentation

◆ GraphModel() [1/2]

casadi::GraphModel::GraphModel ( )

Definition at line 32 of file graph_model.cpp.

32 {

33 }

◆ GraphModel() [2/2]

casadi::GraphModel::GraphModel	(	const std::string &	format,
		const std::vector< uint8_t > &	model_data = `std::vector<uint8_t>()`,
		const Dict &	opts = `Dict()`
	)

explicit

Definition at line 35 of file graph_model.cpp.

                                            {
     own(GraphModelInternal::getPlugin(format).creator(model_data));
     (*this)->construct(opts);
   }

References format(), casadi::PluginInterface< GraphModelInternal >::getPlugin(), model_data(), and casadi::GenericShared< SharedObject, SharedObjectInternal >::own().

Member Function Documentation

◆ hash()

casadi_int casadi::GenericShared< SharedObject , SharedObjectInternal >::__hash__

inherited

If the Object does not point to any node, "0" is returned.

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

Definition at line 123 of file generic_shared_impl.hpp.

                                                              {
     return reinterpret_cast<casadi_int>(get());
   }

◆ assign()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::assign ( Internal * node )

inherited

improper use will cause memory leaks!

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

Definition at line 96 of file generic_shared_impl.hpp.

                                                               {
     node = node_;
   }

◆ class_name()

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

inherited

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

Definition at line 31 of file shared_object.cpp.

                                            {
     return (*this)->class_name();
   }

Referenced by casadi::FmuFunction::check_mem_count(), casadi::MXFunction::export_code_body(), and casadi::BlazingSplineFunction::merge().

◆ count_down()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::count_down

protectedinherited

Definition at line 133 of file generic_shared_impl.hpp.

                                                    {
 #ifdef WITH_EXTRA_CHECKS
     casadi_assert_dev(Function::call_depth_==0);
 #endif // WITH_EXTRA_CHECKS
     if (!node) return;
 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
     GenericWeakRef<Shared, Internal>* weak_ref =
       node->weak_ref_.load(std::memory_order_acquire);
 #else
     GenericWeakRef<Shared, Internal>* weak_ref = node->weak_ref_;
 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
     if (weak_ref) {
 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
       // get_mutex() returns a shared_ptr copy, so the mutex outlives this lock
       // even if delete node (below) destroys the WeakRefInternal holding it
       auto mutex = weak_ref->get_mutex();
       // Avoid triggering a delete while a weak_ref.shared_if_alive is being called
       std::lock_guard<std::mutex> lock(*mutex);
 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
  
       if (--static_cast<Internal*>(node)->count == 0) {
         delete node;
         node = nullptr;
       }
     } else {
       if (--static_cast<Internal*>(node)->count == 0) {
         delete node;
         node = nullptr;
       }
     }
   }

◆ count_up()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::count_up

protectedinherited

Definition at line 132 of file generic_shared_impl.hpp.

                                                  {
 #ifdef WITH_EXTRA_CHECKS
     casadi_assert_dev(Function::call_depth_==0);
 #endif // WITH_EXTRA_CHECKS
  
     if (node) static_cast<Internal*>(node)->count++;
  
   }

◆ debug_repr()

std::string casadi::GenericShared< SharedObject , SharedObjectInternal >::debug_repr

inherited

Definition at line 112 of file generic_shared_impl.hpp.

                                                               {
     if (node) {
         return node->debug_repr(node);
     } else {
         return "NULL";
     }
   }

◆ disp()

void casadi::SharedObject::disp	(	std::ostream &	stream,
		bool	more = `false`
	)		const

inherited

Definition at line 35 of file shared_object.cpp.

                                                              {
     if (is_null()) {
       stream << "NULL";
     } else {
       (*this)->disp(stream, more);
     }
   }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::is_null().

Referenced by casadi::Nlpsol::disp_more(), and casadi::CsparseInterface::nfact().

◆ doc()

std::string casadi::GraphModel::doc ( const std::string & name )

static

Definition at line 73 of file graph_model.cpp.

                                                  {
     return GraphModelInternal::getPlugin(name).doc;
   }

References casadi::PluginInterface< GraphModelInternal >::getPlugin().

Referenced by casadi::doc_graphmodel().

◆ export_symbolic()

std::vector< uint8_t > casadi::GraphModel::export_symbolic	(	const Function &	f,
		const Dict &	opts = `Dict()`
	)

Definition at line 62 of file graph_model.cpp.

                                                                                     {
     return (*this)->export_symbolic(f, opts);
   }

Referenced by casadi::GraphBuilderInternal::export_onnx().

◆ fill_metadata()

void casadi::GraphModel::fill_metadata ( GraphBuilderInternal & gb ) const

Definition at line 53 of file graph_model.cpp.

                                                                {
     (*this)->fill_metadata(gb);
   }

Referenced by casadi::GraphBuilderInternal::GraphBuilderInternal().

◆ format()

std::string casadi::GraphModel::format ( ) const

Definition at line 51 of file graph_model.cpp.

51 { return (*this)->plugin_name(); }

Referenced by GraphModel().

◆ get()

GraphModelInternal * casadi::GraphModel::get ( ) const

Access functions of the node

Definition at line 47 of file graph_model.cpp.

                                             {
     return static_cast<GraphModelInternal*>(SharedObject::get());
   }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::get().

Referenced by import_symbolic().

◆ get_str()

std::string casadi::SharedObject::get_str ( bool more = false ) const

inlineinherited

Definition at line 91 of file shared_object.hpp.

                                                {
         std::stringstream ss;
         disp(ss, more);
         return ss.str();
       }

◆ getCount()

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

inherited

Definition at line 102 of file generic_shared_impl.hpp.

                                                              {
     return (*this)->getCount();
   }

◆ has_plugin()

bool casadi::GraphModel::has_plugin ( const std::string & name )

static

Definition at line 67 of file graph_model.cpp.

                                                    {
     return GraphModelInternal::has_plugin(name);
   }

References casadi::PluginInterface< GraphModelInternal >::has_plugin().

Referenced by casadi::has_graphmodel().

◆ import_symbolic()

Function casadi::GraphModel::import_symbolic	(	const GraphBuilderInternal &	gb,
		const std::string &	name
	)		const

Definition at line 56 of file graph_model.cpp.

                                    {
     // Shallow const: the backend engine mutates internally, but importing does not
     // change the model handle's logical state.
     return get()->import_symbolic(gb, name);
   }

References get(), and casadi::GraphModelInternal::import_symbolic().

Referenced by casadi::GraphBuilderInternal::create_function().

◆ is_null()

bool casadi::GenericShared< SharedObject , SharedObjectInternal >::is_null

inherited

Definition at line 116 of file generic_shared_impl.hpp.

                                                       {
     return node==nullptr;
   }

◆ load_plugin()

void casadi::GraphModel::load_plugin ( const std::string & name )

static

Definition at line 70 of file graph_model.cpp.

                                                     {
     GraphModelInternal::load_plugin(name);
   }

References casadi::PluginInterface< GraphModelInternal >::load_plugin().

Referenced by casadi::load_graphmodel().

◆ model_data()

const std::vector< uint8_t > & casadi::GraphModel::model_data ( ) const

Definition at line 65 of file graph_model.cpp.

65 { return (*this)->model_data(); }

Referenced by GraphModel().

◆ operator->() [1/2]

GraphModelInternal * casadi::GraphModel::operator-> ( )

Access functions of the node

Definition at line 41 of file graph_model.cpp.

                                              {
     return static_cast<GraphModelInternal*>(SharedObject::operator->());
   }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::operator->().

◆ operator->() [2/2]

const GraphModelInternal * casadi::GraphModel::operator-> ( ) const

Access functions of the node

Definition at line 44 of file graph_model.cpp.

                                                          {
     return static_cast<const GraphModelInternal*>(SharedObject::operator->());
   }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::operator->().

◆ own()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::own ( Internal * node )

inherited

Assign the node to a node class pointer (or null)

Definition at line 89 of file generic_shared_impl.hpp.

                                                            {
     count_down();
     node = node_;
     count_up();
   }

◆ print_ptr()

void casadi::SharedObject::print_ptr ( std::ostream & stream = casadi::uout() ) const

inherited

Print the pointer to the internal class

Definition at line 43 of file shared_object.cpp.

                                                        {
     stream << get();
   }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::get().

◆ swap()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::swap ( GenericShared< SharedObject, SharedObjectInternal > & other )

inherited

Definition at line 105 of file generic_shared_impl.hpp.

                                                                  {
     GenericShared<Shared, Internal> temp = *this;
     *this = other;
     other = temp;
   }

◆ type_name()

std::string casadi::GraphModel::type_name ( ) const

inline

Definition at line 50 of file graph_model_impl.hpp.

50 { return "GraphModel"; }

◆ weak()

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

inherited

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

Definition at line 130 of file generic_shared_impl.hpp.

                                                                           {
     return (*this)->weak();
   }

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

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

◆ base_type

◆ internal_base_type

Constructor & Destructor Documentation

◆ GraphModel() [1/2]

◆ GraphModel() [2/2]

Member Function Documentation

◆ __hash__()

◆ assign()

◆ class_name()

◆ count_down()

◆ count_up()

◆ debug_repr()

◆ disp()

◆ doc()

◆ export_symbolic()

◆ fill_metadata()

◆ format()

◆ get()

◆ get_str()

◆ getCount()

◆ has_plugin()

◆ import_symbolic()

◆ is_null()

◆ load_plugin()

◆ model_data()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ own()

◆ print_ptr()

◆ swap()

◆ type_name()

◆ weak()

◆ hash()