#include <importer.hpp>

Detailed Description

Just-in-time compilation of code

General information

List of plugins

Note: some of the plugins in this list might not be available on your system. Also, there might be extra plugins available to you that are not listed here. You can obtain their documentation with Importer.doc("myextraplugin")

clang

Interface to the JIT compiler CLANG

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

List of available options
Id	Type	Description
flags	OT_STRINGVECTOR	Compile flags for the JIT compiler. Default: None
include_path	OT_STRING	Include paths for the JIT compiler. The include directory shipped with CasADi will be automatically appended.

shell

Interface to the JIT compiler SHELL

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

List of available options
Id	Type	Description
cleanup	OT_BOOL	Cleanup temporary files when unloading. Default: true
compiler	OT_STRING	Compiler command
compiler_flags	OT_STRINGVECTOR	Alias for 'compiler_flags'
compiler_output_flag	OT_STRING	Compiler flag to denote object output. Default: '-o '
compiler_setup	OT_STRING	Compiler setup command. Intended to be fixed. The 'flag' option is the prefered way to set custom flags.
directory	OT_STRING	Directory to put temporary objects in. Must end with a file separator.
extra_suffixes	OT_STRINGVECTOR	List of suffixes for extra files that the compiler may generate. Default: None
flags	OT_STRINGVECTOR	Compile flags for the JIT compiler. Default: None
linker	OT_STRING	Linker command
linker_flags	OT_STRINGVECTOR	Linker flags for the JIT compiler. Default: None
linker_output_flag	OT_STRING	Linker flag to denote shared library output. Default: '-o '
linker_setup	OT_STRING	Linker setup command. Intended to be fixed. The 'flag' option is the prefered way to set custom flags.
name	OT_STRING	The file name used to write out compiled objects/libraries. The actual file names used depend on 'temp_suffix' and include extensions. Default: 'tmp_casadi_compiler_shell'
temp_suffix	OT_BOOL	Use a temporary (seemingly random) filename suffix for file names. This is desired for thread-safety. This behaviour may defeat caching compiler wrappers. Default: true

Author: Joris Gillis

Date: 2015

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

Definition at line 84 of file importer.hpp.

Inheritance diagram for casadi::Importer:

[legend]

Collaboration diagram for casadi::Importer:

[legend]

Public Types
using	internal_base_type = SharedObjectInternal

using	base_type = SharedObject

Public Member Functions
	Importer ()
	Default constructor. More...

	Importer (const std::string &name, const std::string &compiler, const Dict &opts=Dict())
	Importer factory. More...

ImporterInternal *	operator-> ()
	Access functions of the node. More...

const ImporterInternal *	operator-> () const

std::string	plugin_name () const
	Query plugin name. More...

bool	has_function (const std::string &symname) const

signal_t	get_function (const std::string &symname)
	Get a function pointer for numerical evaluation. More...

bool	has_meta (const std::string &cmd, casadi_int ind=-1) const
	Does a meta entry exist? More...

std::string	get_meta (const std::string &cmd, casadi_int ind=-1) const
	Get entry as a text. More...

bool	inlined (const std::string &symname) const
	Check if a function is inlined. More...

std::string	body (const std::string &symname) const
	Get the function body, if inlined. More...

std::string	library () const
	Get library name. More...

template<typename T >
T	to (const std::string &cmd, casadi_int ind=-1) const
	Convert to a type. More...

std::string	meta_string (const std::string &cmd, casadi_int ind=-1) const
	Get entry as a string. More...

template<typename T >
std::vector< T >	meta_vector (const std::string &cmd, casadi_int ind=-1) const
	Get entry as a vector. More...

template<typename T >
std::set< T >	meta_set (const std::string &cmd, casadi_int ind=-1) const
	Get entry as a set. More...

casadi_int	meta_int (const std::string &cmd, casadi_int ind=-1) const
	Get entry as an integer. More...

void	serialize (SerializingStream &s) const
	Serialize an object. 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...

SharedObjectInternal *	get () const
	Get a const pointer to the node. 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...

Static Public Member Functions
static std::string	type_name ()
	Get type name. More...

static bool	test_cast (const SharedObjectInternal *ptr)
	Check if a particular cast is allowed. More...

static bool	has_plugin (const std::string &name)
	Check if a plugin is available. More...

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

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

static Importer	create (ImporterInternal *node)
	Create from node. More...

static Importer	create (ImporterInternal *node, const Dict &opts)
	Create from node and initialize. More...

static std::string	indexed (const std::string &cmd, casadi_int ind)

static Importer	deserialize (DeserializingStream &s)
	Deserialize with type disambiguation. 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

◆ Importer() [1/2]

casadi::Importer::Importer ( )

Definition at line 31 of file importer.cpp.

31 {

32 }

◆ Importer() [2/2]

casadi::Importer::Importer	(	const std::string &	name,
		const std::string &	compiler,
		const Dict &	opts = `Dict()`
	)

explicit

Definition at line 34 of file importer.cpp.

                                              {
     if (compiler=="none") {
       own(new ImporterInternal(name));
     } else if (compiler=="dll") {
       own(new DllLibrary(name));
     } else {
       own(ImporterInternal::getPlugin(compiler).creator(name));
     }
     (*this)->construct(opts);
   }

References casadi::PluginInterface< ImporterInternal >::getPlugin(), 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 124 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 97 of file generic_shared_impl.hpp.

                                                               {
     node = node_;
   }

◆ body()

std::string casadi::Importer::body ( const std::string & symname ) const

Definition at line 95 of file importer.cpp.

                                                          {
     return (*this)->body(symname);
   }

Referenced by casadi::External::codegen_body().

◆ 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 134 of file generic_shared_impl.hpp.

                                                    {
 #ifdef WITH_EXTRA_CHECKS
     casadi_assert_dev(Function::call_depth_==0);
 #endif // WITH_EXTRA_CHECKS
     if (!node) return;
     if (node->weak_ref_) {
 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
       auto mutex = node->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);
       // Could it be that this mutex is destroyed when the lock goes out of scope?
 #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 133 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++;
  
   }

◆ create() [1/2]

Importer casadi::Importer::create ( ImporterInternal * node )

static

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

Definition at line 111 of file importer.cpp.

                                                   {
     Importer ret;
     ret.own(node);
     return ret;
   }

References casadi::GenericShared< Shared, Internal >::own().

Referenced by create(), and deserialize().

◆ create() [2/2]

Importer casadi::Importer::create	(	ImporterInternal *	node,
		const Dict &	opts
	)

static

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

Definition at line 117 of file importer.cpp.

                                                                     {
     Importer ret = create(node);
     ret->construct(opts);
     return ret;
   }

References casadi::ImporterInternal::construct(), and create().

◆ debug_repr()

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

inherited

Definition at line 113 of file generic_shared_impl.hpp.

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

◆ deserialize()

Importer casadi::Importer::deserialize ( DeserializingStream & s )

static

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

Definition at line 107 of file importer.cpp.

                                                        {
     return Importer::create(ImporterInternal::deserialize(s));
   }

References create(), and casadi::ImporterInternal::deserialize().

◆ 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::Importer::doc ( const std::string & name )

static

Definition at line 67 of file importer.cpp.

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

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

◆ get()

SharedObjectInternal * casadi::GenericShared< SharedObject , SharedObjectInternal >::get

inherited

Definition at line 100 of file generic_shared_impl.hpp.

                                                        {
     return node;
   }

◆ get_function()

signal_t casadi::Importer::get_function ( const std::string & symname )

Definition at line 79 of file importer.cpp.

                                                           {
     return (*this)->get_function(symname);
   }

Referenced by casadi::external_transform(), casadi::FunctionInternal::finalize(), casadi::External::init_external(), casadi::GenericExternal::init_external(), and casadi::FmuInternal::load_function().

◆ get_meta()

std::string casadi::Importer::get_meta	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

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

Definition at line 87 of file importer.cpp.

                                                                          {
     return (*this)->get_meta(cmd, ind);
   }

◆ 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 103 of file generic_shared_impl.hpp.

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

◆ has_function()

bool casadi::Importer::has_function ( const std::string & symname ) const

Definition at line 75 of file importer.cpp.

                                                             {
     return (*this)->has_function(symname);
   }

Referenced by casadi::External::factory(), casadi::External::has_forward(), casadi::External::has_jacobian(), casadi::External::has_reverse(), and casadi::External::init().

◆ has_meta()

bool casadi::Importer::has_meta	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

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

Definition at line 83 of file importer.cpp.

                                                                     {
     return (*this)->has_meta(cmd, ind);
   }

Referenced by casadi::GenericExternal::get_jac_sparsity(), casadi::External::get_n_in(), casadi::External::get_n_out(), casadi::External::get_name_in(), casadi::External::get_name_out(), casadi::GenericExternal::get_sparsity_in(), casadi::GenericExternal::get_sparsity_out(), casadi::GenericExternal::has_jac_sparsity(), and casadi::External::init().

◆ has_plugin()

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

static

Definition at line 59 of file importer.cpp.

                                                  {
     return ImporterInternal::has_plugin(name);
   }

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

◆ indexed()

static std::string casadi::Importer::indexed	(	const std::string &	cmd,
		casadi_int	ind
	)

inlinestatic

Convert indexed command

Definition at line 163 of file importer.hpp.

                                                                           {
       std::stringstream ss;
       ss << cmd << "[" << ind << "]";
       return ss.str();
     }

◆ inlined()

bool casadi::Importer::inlined ( const std::string & symname ) const

Definition at line 91 of file importer.cpp.

                                                        {
     return (*this)->inlined(symname);
   }

Referenced by casadi::External::codegen_body(), and casadi::External::codegen_declarations().

◆ is_null()

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

inherited

Definition at line 117 of file generic_shared_impl.hpp.

                                                       {
     return node==nullptr;
   }

◆ library()

std::string casadi::Importer::library ( ) const

Definition at line 99 of file importer.cpp.

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

Referenced by casadi::external(), casadi::External::External(), and casadi::FunctionInternal::serialize_body().

◆ load_plugin()

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

static

Definition at line 63 of file importer.cpp.

                                                   {
     ImporterInternal::load_plugin(name);
   }

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

◆ meta_int()

casadi_int casadi::Importer::meta_int	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

inline

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

Definition at line 203 of file importer.hpp.

                                                                        {
       return to<casadi_int>(cmd, ind);
     }

Referenced by casadi::External::get_n_in(), and casadi::External::get_n_out().

◆ meta_set()

template<typename T >

std::set<T> casadi::Importer::meta_set	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

inline

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

Definition at line 196 of file importer.hpp.

                                                                       {
       return text2set<T>(get_meta(cmd, ind));
     }

◆ meta_string()

std::string casadi::Importer::meta_string	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

inline

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

Definition at line 180 of file importer.hpp.

                                                                          {
       return to<std::string>(cmd, ind);
     }

Referenced by casadi::External::get_name_in(), and casadi::External::get_name_out().

◆ meta_vector()

template<typename T >

std::vector<T> casadi::Importer::meta_vector	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

inline

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

Definition at line 188 of file importer.hpp.

                                                                             {
       return text2vector<T>(get_meta(cmd, ind));
     }

Referenced by casadi::GenericExternal::get_jac_sparsity(), casadi::GenericExternal::get_sparsity_in(), casadi::GenericExternal::get_sparsity_out(), and casadi::External::init().

◆ operator->() [1/2]

ImporterInternal * casadi::Importer::operator-> ( )

Definition at line 47 of file importer.cpp.

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

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

◆ operator->() [2/2]

const ImporterInternal * casadi::Importer::operator-> ( ) const

Definition at line 51 of file importer.cpp.

                                                      {
     return static_cast<const ImporterInternal*>(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 90 of file generic_shared_impl.hpp.

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

◆ plugin_name()

std::string casadi::Importer::plugin_name ( ) const

Definition at line 71 of file importer.cpp.

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

◆ 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().

◆ serialize()

void casadi::Importer::serialize ( SerializingStream & s ) const

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

Definition at line 103 of file importer.cpp.

                                                      {
     return (*this)->serialize(s);
   }

◆ swap()

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

inherited

Definition at line 106 of file generic_shared_impl.hpp.

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

◆ test_cast()

bool casadi::Importer::test_cast ( const SharedObjectInternal * ptr )

static

Definition at line 55 of file importer.cpp.

                                                           {
     return dynamic_cast<const ImporterInternal*>(ptr)!=nullptr;
   }

◆ to()

template<typename T >

T casadi::Importer::to	(	const std::string &	cmd,
		casadi_int	ind = `-1`
	)		const

inline

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

Definition at line 173 of file importer.hpp.

                                                         {
       return text2type<T>(get_meta(cmd, ind));
     }

References casadi::T.

◆ type_name()

static std::string casadi::Importer::type_name ( )

inlinestatic

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

Definition at line 91 of file importer.hpp.

91 {return "Importer";}

◆ weak()

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

inherited

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

Definition at line 131 of file generic_shared_impl.hpp.

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

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

Detailed Description

General information

List of plugins

clang

shell

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

◆ base_type

◆ internal_base_type

Constructor & Destructor Documentation

◆ Importer() [1/2]

◆ Importer() [2/2]

Member Function Documentation

◆ __hash__()

◆ assign()

◆ body()

◆ class_name()

◆ count_down()

◆ count_up()

◆ create() [1/2]

◆ create() [2/2]

◆ debug_repr()

◆ deserialize()

◆ disp()

◆ doc()

◆ get()

◆ get_function()

◆ get_meta()

◆ get_str()

◆ getCount()

◆ has_function()

◆ has_meta()

◆ has_plugin()

◆ indexed()

◆ inlined()

◆ is_null()

◆ library()

◆ load_plugin()

◆ meta_int()

◆ meta_set()

◆ meta_string()

◆ meta_vector()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ own()

◆ plugin_name()

◆ print_ptr()

◆ serialize()

◆ swap()

◆ test_cast()

◆ to()

◆ type_name()

◆ weak()

◆ hash()