Base class for FunctionInternal and LinsolInternal. More...

#include <function_internal.hpp>

Detailed Description

Author: Joel Andersson

Date: 2017

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

List of available options
Id	Type	Description	Used in
error_on_fail	OT_BOOL	Throw exceptions when function evaluation fails (default true).	casadi::ProtoFunction
print_time	OT_BOOL	print information about execution time. Implies record_time.	casadi::ProtoFunction
record_time	OT_BOOL	record information about execution time, for retrieval with stats().	casadi::ProtoFunction
regularity_check	OT_BOOL	Throw exceptions when NaN or Inf appears during evaluation	casadi::ProtoFunction
verbose	OT_BOOL	Verbose evaluation – for debugging	casadi::ProtoFunction

Definition at line 96 of file function_internal.hpp.

Inheritance diagram for casadi::ProtoFunction:

[legend]

Collaboration diagram for casadi::ProtoFunction:

[legend]

Public Types
using	weak_ref_type = WeakRefInternal

Public Member Functions
	ProtoFunction (const std::string &name)
	Constructor. More...

	~ProtoFunction () override=0
	Destructor. More...

void	construct (const Dict &opts)
	Construct. More...

virtual Dict	generate_options (const std::string &target) const
	Reconstruct options dict. More...

void	print_options (std::ostream &stream) const
	Print list of options. More...

void	print_option (const std::string &name, std::ostream &stream) const
	Print all information there is to know about a certain option. More...

bool	has_option (const std::string &option_name) const
	Does a particular option exist. More...

virtual void	change_option (const std::string &option_name, const GenericType &option_value)
	Change option after object creation for debugging. More...

virtual void	init (const Dict &opts)
	Initialize. More...

virtual void	finalize ()
	Finalize the object creation. More...

int	checkout () const
	Checkout a memory object. More...

void	release (int mem) const
	Release a memory object. More...

void *	memory (int ind) const
	Memory objects. More...

bool	has_memory (int ind) const
	Check for existance of memory object. More...

virtual void	check_mem_count (casadi_int n) const
	Check for validatity of memory object count. More...

virtual void *	alloc_mem () const
	Create memory block. More...

virtual int	init_mem (void *mem) const
	Initalize memory block. More...

virtual void	free_mem (void *mem) const
	Free memory block. More...

virtual Dict	get_stats (void *mem) const
	Get all statistics. More...

void	clear_mem ()
	Clear all memory (called from destructor) More...

void	print (const char *fmt,...) const
	C-style formatted printing during evaluation. More...

void	sprint (char buf, size_t buf_sz, const char fmt,...) const
	C-style formatted printing to string. More...

void	format_time (char *buffer, double time) const
	Format time in a fixed width 8 format. More...

void	print_time (const std::map< std::string, FStats > &fstats) const
	Print timing statistics. More...

void	serialize (SerializingStream &s) const
	Serialize an object. More...

virtual void	serialize_body (SerializingStream &s) const
	Serialize an object without type information. More...

virtual void	serialize_type (SerializingStream &s) const
	Serialize type information. More...

virtual std::string	serialize_base_function () const
	String used to identify the immediate FunctionInternal subclass. More...

virtual std::string	class_name () const =0
	Readable name of the internal class. More...

virtual void	disp (std::ostream &stream, bool more) const =0
	Print a description of the object. 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...

Public Attributes
std::string	name_
	Name. More...

bool	verbose_
	Verbose printout. More...

bool	print_time_

bool	record_time_

bool	regularity_check_
	Errors are thrown when NaN is produced. More...

bool	error_on_fail_
	Throw an exception on failure? More...

Protected Member Functions
	ProtoFunction (DeserializingStream &s)
	Deserializing constructor. More...

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...

static const Options	options_
	Options. More...

virtual const Options &	get_options () const
	Options. 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

◆ ProtoFunction() [1/2]

casadi::ProtoFunction::ProtoFunction ( const std::string & name )

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

Definition at line 60 of file function_internal.cpp.

                                                     : name_(name) {
     // Default options (can be overridden in derived classes)
     verbose_ = false;
     print_time_ = false;
     record_time_ = false;
     regularity_check_ = false;
     error_on_fail_ = true;
   }

References error_on_fail_, print_time_, record_time_, regularity_check_, and verbose_.

◆ ~ProtoFunction()

casadi::ProtoFunction::~ProtoFunction ( )

overridepure virtual

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

Definition at line 126 of file function_internal.cpp.

                                 {
     for (void* m : mem_) {
       if (m!=nullptr) casadi_warning("Memory object has not been properly freed");
     }
     mem_.clear();
   }

◆ ProtoFunction() [2/2]

casadi::ProtoFunction::ProtoFunction ( DeserializingStream & s )

explicitprotected

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

Definition at line 4233 of file function_internal.cpp.

                                                      {
     int version = s.version("ProtoFunction", 1, 2);
     s.unpack("ProtoFunction::name", name_);
     s.unpack("ProtoFunction::verbose", verbose_);
     s.unpack("ProtoFunction::print_time", print_time_);
     s.unpack("ProtoFunction::record_time", record_time_);
     if (version >= 2) s.unpack("ProtoFunction::regularity_check", regularity_check_);
     if (version >= 2) s.unpack("ProtoFunction::error_on_fail", error_on_fail_);
   }

References error_on_fail_, name_, print_time_, record_time_, regularity_check_, casadi::DeserializingStream::unpack(), verbose_, and casadi::DeserializingStream::version().

Member Function Documentation

◆ alloc_mem()

virtual void* casadi::ProtoFunction::alloc_mem ( ) const

inlinevirtual

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

Definition at line 186 of file function_internal.hpp.

186 { return new ProtoFunctionMemory(); }

Referenced by checkout().

◆ change_option()

void casadi::ProtoFunction::change_option	(	const std::string &	option_name,
		const GenericType &	option_value
	)

virtual

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

Reimplemented in casadi::SXFunction, casadi::MXFunction, casadi::FunctionInternal, and casadi::FmuFunction.

Definition at line 1117 of file function_internal.cpp.

                                        {
     if (option_name == "verbose") {
       verbose_ = option_value;
     } else if (option_name == "regularity_check") {
       regularity_check_ = option_value;
     } else {
       // Failure
       casadi_error("Option '" + option_name + "' cannot be changed");
     }
   }

References regularity_check_, and verbose_.

Referenced by casadi::FunctionInternal::change_option().

◆ check_mem_count()

virtual void casadi::ProtoFunction::check_mem_count ( casadi_int n ) const

inlinevirtual

Purpose if to allow more helpful error messages

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

Reimplemented in casadi::FmuFunction.

Definition at line 181 of file function_internal.hpp.

181 { }

Referenced by checkout().

◆ checkout()

int casadi::ProtoFunction::checkout ( ) const

Definition at line 3916 of file function_internal.cpp.

                                     {
 #ifdef CASADI_WITH_THREAD
     std::lock_guard<std::mutex> lock(mtx_);
 #endif //CASADI_WITH_THREAD
     if (unused_.empty()) {
       check_mem_count(mem_.size()+1);
       // Allocate a new memory object
       void* m = alloc_mem();
       mem_.push_back(m);
       if (init_mem(m)) {
         casadi_error("Failed to create or initialize memory object");
       }
       return static_cast<int>(mem_.size()) - 1;
     } else {
       // Use an unused memory object
       int m = unused_.top();
       unused_.pop();
       return m;
     }
   }

References alloc_mem(), check_mem_count(), and init_mem().

Referenced by casadi::FunctionInternal::codegen_meta(), finalize(), and casadi::Sqpmethod::init_mem().

◆ class_name()

virtual std::string casadi::SharedObjectInternal::class_name ( ) const

pure virtualinherited

◆ clear_mem()

void casadi::ProtoFunction::clear_mem ( )

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

Definition at line 3804 of file function_internal.cpp.

                                 {
     for (auto&& i : mem_) {
       if (i!=nullptr) free_mem(i);
     }
     mem_.clear();
   }

References free_mem().

◆ construct()

void casadi::ProtoFunction::construct ( const Dict & opts )

Prepares the function for evaluation

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

Definition at line 141 of file function_internal.cpp.

                                                 {
     // Sanitize dictionary is needed
     if (!Options::is_sane(opts)) {
       // Call recursively
       construct(Options::sanitize(opts));
       return;
     }
  
     // Make sure all options exist
     get_options().check(opts);
  
     // Initialize the class hierarchy
     try {
       init(opts);
     } catch(std::exception& e) {
       casadi_error("Error calling " + class_name() + "::init for '" + name_ + "':\n"
         + std::string(e.what()));
     }
  
     // Revisit class hierarchy in reverse order
     try {
       finalize();
     } catch(std::exception& e) {
       casadi_error("Error calling " + class_name() + "::finalize for '" + name_ + "':\n"
         + std::string(e.what()));
     }
   }

References casadi::Options::check(), casadi::SharedObjectInternal::class_name(), finalize(), get_options(), init(), casadi::Options::is_sane(), name_, and casadi::Options::sanitize().

Referenced by casadi::Function::create(), casadi::FmuFunction::factory(), casadi::FmuFunction::get_forward(), casadi::FmuFunction::get_jacobian(), casadi::LinearInterpolant::get_jacobian(), and casadi::FmuFunction::get_reverse().

◆ 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--;
     }

◆ disp()

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

pure virtualinherited

Implemented in casadi::XmlFileInternal, casadi::OptiNode, casadi::ModelicaParserInternal, casadi::SparsityInternal, casadi::WeakRefInternal, casadi::ZipMemResource, casadi::ZipResource, casadi::TemporaryDirResource, casadi::DirResource, casadi::MXNode, casadi::LinsolInternal, casadi::ImporterInternal, casadi::GraphModelInternal, casadi::GraphBuilderInternal, casadi::GenericTypeInternal< ID, T >, casadi::FunctionInternal, casadi::FmuInternal, and casadi::DaeBuilderInternal.

◆ finalize()

void casadi::ProtoFunction::finalize ( )

virtual

This function, which visits the class hierarchy in reverse order is run after init() has been completed.

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

Reimplemented in casadi::LinsolQr, casadi::PiqpInterface, casadi::OracleFunction, casadi::FunctionInternal, casadi::Conic, and casadi::CallbackInternal.

Definition at line 788 of file function_internal.cpp.

                                {
     // Create memory object
     int mem = checkout();
     casadi_assert_dev(mem==0);
   }

References checkout().

Referenced by construct(), casadi::Linsol::deserialize(), casadi::FunctionInternal::finalize(), and casadi::LinsolQr::finalize().

◆ format_time()

void casadi::ProtoFunction::format_time	(	char *	buffer,
		double	time
	)		const

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

Definition at line 4117 of file function_internal.cpp.

                                                                  {
     // Always of width 8
     casadi_assert_dev(time>=0);
     double log_time = log10(time);
     int magn = static_cast<int>(floor(log_time));
     int iprefix = static_cast<int>(floor(log_time/3));
     if (iprefix<-4) {
       sprint(buffer, 10, "       0");
       return;
     }
     if (iprefix>=5) {
       sprint(buffer, 10, "     inf");
       return;
     }
     char prefixes[] = "TGMk munp";
     char prefix = prefixes[4-iprefix];
  
     int rem = magn-3*iprefix;
     double time_normalized = time/pow(10, 3*iprefix);
  
     if (rem==0) {
       sprint(buffer, 10, "  %1.2f%cs", time_normalized, prefix);
     } else if (rem==1) {
       sprint(buffer, 10, " %2.2f%cs", time_normalized, prefix);
     } else {
       sprint(buffer, 10, "%3.2f%cs", time_normalized, prefix);
     }
   }

References sprint().

Referenced by print_time().

◆ free_mem()

virtual void casadi::ProtoFunction::free_mem ( void * mem ) const

inlinevirtual

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

Definition at line 196 of file function_internal.hpp.

196 { delete static_cast<ProtoFunctionMemory*>(mem); }

Referenced by clear_mem().

◆ generate_options()

Dict casadi::ProtoFunction::generate_options ( const std::string & target ) const

virtual

Reimplemented in casadi::SXFunction, casadi::MXFunction, and casadi::FunctionInternal.

Definition at line 379 of file function_internal.cpp.

                                                                     {
     Dict opts;
     opts["verbose"] = verbose_;
     opts["print_time"] = print_time_;
     opts["record_time"] = record_time_;
     opts["regularity_check"] = regularity_check_;
     opts["error_on_fail"] = error_on_fail_;
     return opts;
   }

References error_on_fail_, print_time_, record_time_, regularity_check_, and verbose_.

Referenced by casadi::FunctionInternal::generate_options().

◆ get_options()

virtual const Options& casadi::ProtoFunction::get_options ( ) const

inlinevirtual

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

Reimplemented in casadi::SymbolicQr, casadi::Sqpmethod, casadi::Scpgen, casadi::Qrsqp, casadi::Qrqp, casadi::QpToNlp, casadi::Newton, casadi::LinsolQr, casadi::LinsolLdl, casadi::LinearInterpolant, casadi::Ipqp, casadi::ImplicitToNlp, casadi::Feasiblesqpmethod, casadi::FastNewton, casadi::Collocation, casadi::BSplineInterpolant, casadi::XpressInterface, casadi::WorhpInterface, casadi::UnoInterface, casadi::SuperscsInterface, casadi::SundialsInterface, casadi::KinsolInterface, casadi::IdasInterface, casadi::CvodesInterface, casadi::SnoptInterface, casadi::SlicotDple, casadi::SLEQPInterface, casadi::QpoasesInterface, casadi::ProxqpInterface, casadi::PiqpInterface, casadi::OsqpInterface, casadi::OnnxRuntimeInterface, casadi::OoqpInterface, casadi::MumpsInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::LapackQr, casadi::LapackLu, casadi::KnitroInterface, casadi::IpoptInterface, casadi::HpmpcInterface, casadi::HpipmInterface, casadi::HighsInterface, casadi::GurobiInterface, casadi::FatropInterface, casadi::FatropConicInterface, casadi::DaqpInterface, casadi::CplexInterface, casadi::ConoptInterface, casadi::ClpInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, casadi::CbcInterface, casadi::BonminInterface, casadi::Blocksqp, casadi::AmplInterface, casadi::AlpaqaInterface, casadi::SXFunction, casadi::Rootfinder, casadi::OracleFunction, casadi::OnnxFunction, casadi::Nlpsol, casadi::MXFunction, casadi::JitFunction, casadi::Interpolant, casadi::ImplicitFixedStepIntegrator, casadi::FixedStepIntegrator, casadi::Integrator, casadi::FunctionInternal, casadi::FmuFunction, casadi::FiniteDiff, casadi::Expm, casadi::Dple, casadi::Conic, and casadi::BlazingSplineFunction.

Definition at line 120 of file function_internal.hpp.

120 { return options_;}

casadi::ProtoFunction::options_

static const Options options_

Options.

Definition: function_internal.hpp:119

Referenced by construct(), has_option(), print_option(), and print_options().

◆ get_stats()

Dict casadi::ProtoFunction::get_stats ( void * mem ) const

virtual

Reimplemented in casadi::Sqpmethod, casadi::Scpgen, casadi::Qrsqp, casadi::Qrqp, casadi::QpToNlp, casadi::Newton, casadi::Ipqp, casadi::ImplicitToNlp, casadi::Feasiblesqpmethod, casadi::FastNewton, casadi::XpressInterface, casadi::WorhpInterface, casadi::UnoInterface, casadi::SuperscsInterface, casadi::SundialsInterface, casadi::SnoptInterface, casadi::SLEQPInterface, casadi::QpoasesInterface, casadi::ProxqpInterface, casadi::PiqpInterface, casadi::OsqpInterface, casadi::OoqpInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::KnitroInterface, casadi::IpoptInterface, casadi::HpmpcInterface, casadi::HpipmInterface, casadi::HighsInterface, casadi::GurobiInterface, casadi::FatropInterface, casadi::FatropConicInterface, casadi::DaqpInterface, casadi::CplexInterface, casadi::ConoptInterface, casadi::ClpInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, casadi::CbcInterface, casadi::BonminInterface, casadi::AlpaqaInterface, casadi::Rootfinder, casadi::OracleFunction, casadi::Nlpsol, casadi::MXFunction, casadi::FunctionInternal, casadi::FmuFunction, and casadi::Conic.

Definition at line 3214 of file function_internal.cpp.

                                                {
     auto *m = static_cast<ProtoFunctionMemory*>(mem);
     // Add timing statistics
     Dict stats;
     for (const auto& s : m->fstats) {
       stats["n_call_" +s.first] = s.second.n_call;
       stats["t_wall_" +s.first] = s.second.t_wall;
       stats["t_proc_" +s.first] = s.second.t_proc;
     }
     return stats;
   }

Referenced by casadi::FunctionInternal::get_stats().

◆ 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;
   }

◆ has_memory()

bool casadi::ProtoFunction::has_memory ( int ind ) const

Definition at line 3912 of file function_internal.cpp.

                                               {
     return ind<mem_.size();
   }

◆ has_option()

bool casadi::ProtoFunction::has_option ( const std::string & option_name ) const

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

Definition at line 1113 of file function_internal.cpp.

                                                                    {
     return get_options().find(option_name) != nullptr;
   }

References casadi::Options::find(), and get_options().

◆ init()

void casadi::ProtoFunction::init ( const Dict & opts )

virtual

Initialize and make the object ready for setting arguments and evaluation. This method is typically called after setting options but before evaluating. If passed to another class (in the constructor), this class should invoke this function when initialized.

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

Definition at line 362 of file function_internal.cpp.

                                            {
     // Read options
     for (auto&& op : opts) {
       if (op.first=="verbose") {
         verbose_ = op.second;
       } else if (op.first=="print_time") {
         print_time_ = op.second;
       } else if (op.first=="record_time") {
         record_time_ = op.second;
       } else if (op.first=="regularity_check") {
         regularity_check_ = op.second;
       } else if (op.first=="error_on_fail") {
         error_on_fail_ = op.second;
       }
     }
   }

References error_on_fail_, print_time_, record_time_, regularity_check_, and verbose_.

Referenced by construct(), casadi::FunctionInternal::init(), and casadi::LinsolInternal::init().

◆ init_mem()

int casadi::ProtoFunction::init_mem ( void * mem ) const

virtual

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

Definition at line 921 of file function_internal.cpp.

                                              {
     auto *m = static_cast<ProtoFunctionMemory*>(mem);
     if (record_time_) {
       m->add_stat("total");
       m->t_total = &m->fstats.at("total");
     } else {
       m->t_total = nullptr;
     }
     return 0;
   }

References casadi::ProtoFunctionMemory::add_stat(), and record_time_.

Referenced by checkout(), casadi::FunctionInternal::codegen_checkout(), casadi::Conic::init_mem(), casadi::FmuFunction::init_mem(), casadi::LinsolInternal::init_mem(), casadi::OracleFunction::init_mem(), casadi::OnnxRuntimeInterface::init_mem(), casadi::SlicotDple::init_mem(), casadi::SlicotExpm::init_mem(), and casadi::OracleFunction::local_init_mem().

◆ 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++;
     }

◆ memory()

void * casadi::ProtoFunction::memory ( int ind ) const

Definition at line 3905 of file function_internal.cpp.

                                            {
 #ifdef CASADI_WITH_THREAD
     std::lock_guard<std::mutex> lock(mtx_);
 #endif //CASADI_WITH_THREAD
     return mem_.at(ind);
   }

Referenced by casadi::FunctionInternal::call_gen(), casadi::FunctionInternal::get_jac_sparsity_gen(), casadi::FunctionInternal::get_jac_sparsity_hierarchical(), casadi::Sqpmethod::solve_ela_QP(), and casadi::Sqpmethod::solve_QP().

◆ print()

void casadi::ProtoFunction::print	(	const char *	fmt,
			...
	)		const

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

Definition at line 4158 of file function_internal.cpp.

                                                       {
     // Variable number of arguments
     va_list args;
     va_start(args, fmt);
     // Static & dynamic buffers
     char buf[256];
     size_t buf_sz = sizeof(buf);
     char* buf_dyn = nullptr;
     // Try to print with a small buffer
     casadi_int n = vsnprintf(buf, buf_sz, fmt, args);
     // Need a larger buffer?
     if (n>static_cast<casadi_int>(buf_sz)) {
       buf_sz = static_cast<size_t>(n+1);
       buf_dyn = new char[buf_sz];
       n = vsnprintf(buf_dyn, buf_sz, fmt, args);
     }
     // Print buffer content
     if (n>=0) uout() << (buf_dyn ? buf_dyn : buf) << std::flush;
     // Cleanup
     delete[] buf_dyn;
     va_end(args);
     // Throw error if failure
     casadi_assert(n>=0, "Print failure while processing '" + std::string(fmt) + "'");
   }

References casadi::uout().

Referenced by casadi::Feasiblesqpmethod::anderson_acc_step_update(), casadi::Nlpsol::callback(), casadi::Blocksqp::convertHessian(), casadi::FmuFunction::eval_task(), casadi::Feasiblesqpmethod::feasibility_iterations(), casadi::Blocksqp::feasibilityRestorationPhase(), casadi::Blocksqp::fullstep(), casadi::Blocksqp::init(), casadi::Feasiblesqpmethod::init(), casadi::Ipqp::init(), casadi::Qrqp::init(), casadi::Qrsqp::init(), casadi::Sqpmethod::init(), casadi::LinsolQr::nfact(), casadi::Feasiblesqpmethod::print_iteration(), casadi::Qrsqp::print_iteration(), casadi::Sqpmethod::print_iteration(), casadi::SundialsInterface::print_stats(), print_time(), casadi::Blocksqp::printInfo(), casadi::Blocksqp::printProgress(), casadi::Blocksqp::run(), casadi::Blocksqp::solve(), casadi::Feasiblesqpmethod::solve(), casadi::Qrsqp::solve(), casadi::Sqpmethod::solve(), casadi::Sqpmethod::solve_ela_QP(), casadi::Feasiblesqpmethod::solve_LP(), casadi::Feasiblesqpmethod::solve_QP(), casadi::Qrsqp::solve_QP(), casadi::Sqpmethod::solve_QP(), and casadi::Blocksqp::solveQP().

◆ print_option()

void casadi::ProtoFunction::print_option	(	const std::string &	name,
		std::ostream &	stream
	)		const

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

Definition at line 1109 of file function_internal.cpp.

                                                                                   {
     get_options().print_one(name, stream);
   }

References get_options(), and casadi::Options::print_one().

◆ print_options()

void casadi::ProtoFunction::print_options ( std::ostream & stream ) const

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

Definition at line 1105 of file function_internal.cpp.

                                                             {
     get_options().print_all(stream);
   }

References get_options(), and casadi::Options::print_all().

◆ print_time()

void casadi::ProtoFunction::print_time ( const std::map< std::string, FStats > & fstats ) const

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

Definition at line 4078 of file function_internal.cpp.

                                                                               {
     if (!print_time_) return;
     // Length of the name being printed
     size_t name_len=0;
     for (auto &&s : fstats) {
       name_len = std::max(s.first.size(), name_len);
     }
     name_len = std::max(name_.size(), name_len);
  
     // Print name with a given length. Format: "%NNs "
     char namefmt[10];
     sprint(namefmt, sizeof(namefmt), "%%%ds ", static_cast<casadi_int>(name_len));
  
     // Print header
     print(namefmt, name_.c_str());
  
     print(" : %8s %10s %8s %10s %9s\n", "t_proc", "(avg)", "t_wall", "(avg)", "n_eval");
  
  
     char buffer_proc[10];
     char buffer_wall[10];
     char buffer_proc_avg[10];
     char buffer_wall_avg[10];
  
     // Print keys
     for (const auto &s : fstats) {
       if (s.second.n_call!=0) {
         print(namefmt, s.first.c_str());
         format_time(buffer_proc, s.second.t_proc);
         format_time(buffer_wall, s.second.t_wall);
         format_time(buffer_proc_avg, s.second.t_proc/s.second.n_call);
         format_time(buffer_wall_avg, s.second.t_wall/s.second.n_call);
         print(" | %s (%s) %s (%s) %9d\n",
           buffer_proc, buffer_proc_avg,
           buffer_wall, buffer_wall_avg, s.second.n_call);
       }
     }
   }

References format_time(), name_, print(), print_time_, and sprint().

Referenced by casadi::FunctionInternal::eval_gen().

◆ release()

void casadi::ProtoFunction::release ( int mem ) const

Definition at line 3937 of file function_internal.cpp.

                                            {
 #ifdef CASADI_WITH_THREAD
     std::lock_guard<std::mutex> lock(mtx_);
 #endif //CASADI_WITH_THREAD
     unused_.push(mem);
   }

Referenced by casadi::FunctionInternal::codegen_meta().

◆ serialize()

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

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

Definition at line 4451 of file function_internal.cpp.

                                                           {
     serialize_type(s);
     serialize_body(s);
   }

References serialize_body(), and serialize_type().

◆ serialize_base_function()

virtual std::string casadi::ProtoFunction::serialize_base_function ( ) const

inlinevirtual

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

Reimplemented in casadi::LinearInterpolantJac, casadi::Rootfinder, casadi::OnnxFunction, casadi::Nlpsol, casadi::MapSum, casadi::Map, casadi::Interpolant, casadi::Integrator, casadi::External, casadi::Conic, and casadi::BlazingSplineFunction.

Definition at line 243 of file function_internal.hpp.

                                                       {
       return class_name();
     }

Referenced by casadi::FunctionInternal::serialize_type().

◆ serialize_body()

void casadi::ProtoFunction::serialize_body ( SerializingStream & s ) const

virtual

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

Reimplemented in casadi::SymbolicQr, casadi::Sqpmethod, casadi::RungeKutta, casadi::Qrqp, casadi::QpToNlp, casadi::Newton, casadi::LinsolQr, casadi::LinsolLdl, casadi::LinearInterpolant, casadi::Ipqp, casadi::Feasiblesqpmethod, casadi::FastNewton, casadi::Collocation, casadi::BSplineInterpolant, casadi::XpressInterface, casadi::WorhpInterface, casadi::UnoInterface, casadi::SuperscsInterface, casadi::SundialsInterface, casadi::IdasInterface, casadi::CvodesInterface, casadi::SnoptInterface, casadi::SLEQPInterface, casadi::QpoasesInterface, casadi::ProxqpInterface, casadi::PiqpInterface, casadi::OsqpInterface, casadi::OnnxRuntimeInterface, casadi::OoqpInterface, casadi::MumpsInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::LapackQr, casadi::LapackLu, casadi::KnitroInterface, casadi::IpoptInterface, casadi::HpipmInterface, casadi::HighsInterface, casadi::GurobiInterface, casadi::FatropInterface, casadi::FatropConicInterface, casadi::DaqpInterface, casadi::CplexInterface, casadi::ConoptInterface, casadi::ClpInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, casadi::CbcInterface, casadi::BonminInterface, casadi::Blocksqp, casadi::AlpaqaInterface, casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::SXFunction, casadi::Switch, casadi::Rootfinder, casadi::OracleFunction, casadi::OnnxFunction, casadi::Nlpsol, casadi::MXFunction, casadi::MapSum, casadi::Map, casadi::LinsolInternal, casadi::Interpolant, casadi::ImplicitFixedStepIntegrator, casadi::FixedStepIntegrator, casadi::Integrator, casadi::FunctionInternal, casadi::FmuFunction, casadi::FiniteDiff, casadi::External, casadi::Conic, and casadi::BlazingSplineFunction.

Definition at line 4223 of file function_internal.cpp.

                                                                {
     s.version("ProtoFunction", 2);
     s.pack("ProtoFunction::name", name_);
     s.pack("ProtoFunction::verbose", verbose_);
     s.pack("ProtoFunction::print_time", print_time_);
     s.pack("ProtoFunction::record_time", record_time_);
     s.pack("ProtoFunction::regularity_check", regularity_check_);
     s.pack("ProtoFunction::error_on_fail", error_on_fail_);
   }

References error_on_fail_, name_, casadi::SerializingStream::pack(), print_time_, record_time_, regularity_check_, verbose_, and casadi::SerializingStream::version().

Referenced by serialize(), casadi::FunctionInternal::serialize_body(), and casadi::LinsolInternal::serialize_body().

◆ serialize_type()

virtual void casadi::ProtoFunction::serialize_type ( SerializingStream & s ) const

inlinevirtual

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

Reimplemented in casadi::LinearInterpolantJac, casadi::LinearInterpolant, casadi::Rootfinder, casadi::OnnxFunction, casadi::Nlpsol, casadi::MapSum, casadi::Map, casadi::LinsolInternal, casadi::Interpolant, casadi::Integrator, casadi::FunctionInternal, casadi::GenericExternal, and casadi::Conic.

Definition at line 238 of file function_internal.hpp.

238 {}

Referenced by serialize(), and casadi::LinsolInternal::serialize_type().

◆ 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;
     }

◆ sprint()

void casadi::ProtoFunction::sprint	(	char *	buf,
		size_t	buf_sz,
		const char *	fmt,
			...
	)		const

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

Definition at line 4146 of file function_internal.cpp.

                                                                                  {
     // Variable number of arguments
     va_list args;
     va_start(args, fmt);
     // Print to buffer
     casadi_int n = vsnprintf(buf, buf_sz, fmt, args);
     // Cleanup
     va_end(args);
     // Throw error if failure
     casadi_assert(n>=0 && n<buf_sz, "Print failure while processing '" + std::string(fmt) + "'");
   }

Referenced by format_time(), and print_time().

◆ 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

◆ error_on_fail_

bool casadi::ProtoFunction::error_on_fail_

Definition at line 263 of file function_internal.hpp.

◆ name_

std::string casadi::ProtoFunction::name_

Definition at line 248 of file function_internal.hpp.

◆ options_

const Options casadi::ProtoFunction::options_

static

Initial value:

= {{},
     {{"verbose",
       {OT_BOOL,
        "Verbose evaluation -- for debugging"}},
      {"print_time",
       {OT_BOOL,
        "print information about execution time. Implies record_time."}},
      {"record_time",
       {OT_BOOL,
        "record information about execution time, for retrieval with stats()."}},
      {"regularity_check",
       {OT_BOOL,
        "Throw exceptions when NaN or Inf appears during evaluation"}},
      {"error_on_fail",
       {OT_BOOL,
        "Throw exceptions when function evaluation fails (default true)."}}
      }
  }

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

Definition at line 119 of file function_internal.hpp.

Referenced by casadi::casadi_register_linsol_csparse(), casadi::casadi_register_linsol_lsqr(), casadi::casadi_register_linsol_ma27(), and casadi::casadi_register_linsol_tridiag().

◆ print_time_

bool casadi::ProtoFunction::print_time_

Definition at line 254 of file function_internal.hpp.

Referenced by casadi::FixedStepIntegrator::create_advanced(), generate_options(), init(), casadi::FunctionInternal::init(), casadi::Nlpsol::Nlpsol(), print_time(), ProtoFunction(), and serialize_body().

◆ record_time_

bool casadi::ProtoFunction::record_time_

Definition at line 257 of file function_internal.hpp.

Referenced by generate_options(), init(), casadi::FunctionInternal::init(), init_mem(), casadi::LinsolInternal::init_mem(), ProtoFunction(), and serialize_body().

◆ regularity_check_

bool casadi::ProtoFunction::regularity_check_

Definition at line 260 of file function_internal.hpp.

Referenced by casadi::OracleFunction::calc_function(), change_option(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::FunctionInternal(), generate_options(), init(), ProtoFunction(), and serialize_body().

◆ verbose_

bool casadi::ProtoFunction::verbose_

Definition at line 251 of file function_internal.hpp.

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

Detailed Description

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Member Typedef Documentation

◆ weak_ref_type

Constructor & Destructor Documentation

◆ ProtoFunction() [1/2]

◆ ~ProtoFunction()

◆ ProtoFunction() [2/2]

Member Function Documentation

◆ alloc_mem()

◆ change_option()

◆ check_mem_count()

◆ checkout()

◆ class_name()

◆ clear_mem()

◆ construct()

◆ debug_repr()

◆ destroySingleton()

◆ disp()

◆ finalize()

◆ format_time()

◆ free_mem()

◆ generate_options()

◆ get_options()

◆ get_stats()

◆ getCount()

◆ has_memory()

◆ has_option()

◆ init()

◆ init_mem()

◆ initSingleton()

◆ memory()

◆ print()

◆ print_option()

◆ print_options()

◆ print_time()

◆ release()

◆ serialize()

◆ serialize_base_function()

◆ serialize_body()

◆ serialize_type()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]

◆ sprint()

◆ weak()

Member Data Documentation

◆ error_on_fail_

◆ name_

◆ options_

◆ print_time_

◆ record_time_

◆ regularity_check_

◆ verbose_