#include <fmu_function.hpp>

Detailed Description

List of available options
Id	Type	Description	Used in
abstol	OT_DOUBLE	Absolute error tolerance, scaled by nominal value	casadi::FmuFunction
ad_weight	OT_DOUBLE	Weighting factor for derivative calculation.When there is an option of either using forward or reverse mode directional derivatives, the condition ad_weightnf<=(1-ad_weight)na is used where nf and na are estimates of the number of forward/reverse mode directional derivatives needed. By default, ad_weight is calculated automatically, but this can be overridden by setting this option. In particular, 0 means forcing forward mode and 1 forcing reverse mode. Leave unset for (class specific) heuristics.	casadi::FunctionInternal
ad_weight_sp	OT_DOUBLE	Weighting factor for sparsity pattern calculation calculation.Overrides default behavior. Set to 0 and 1 to force forward and reverse mode respectively. Cf. option "ad_weight". When set to -1, sparsity is completely ignored and dense matrices are used.	casadi::FunctionInternal
always_inline	OT_BOOL	Force inlining.	casadi::FunctionInternal
asymmetric_hessian_coloring	OT_BOOL	Calculate Hessian using unidirectional graph coloring (star coloring). Ensures that upper and lower triangular parts are calculated separately, which may be desirable for diagnostics. If both symmetric coloring ('hessian_coloring' option) and asymmetric coloring is enabled, the symmetric coloring will be used.	casadi::FmuFunction
aux	OT_STRINGVECTOR	Auxilliary variables	casadi::FmuFunction
cache	OT_DICT	Prepopulate the function cache. Default: empty	casadi::FunctionInternal
check_hessian	OT_BOOL	[DEPRECATED] Renamed 'validate_hessian'	casadi::FmuFunction
compiler	OT_STRING	Just-in-time compiler plugin to be used.	casadi::FunctionInternal
custom_jacobian	OT_FUNCTION	Override CasADi's AD. Use together with 'jac_penalty': 0. Note: Highly experimental. Syntax may break often.	casadi::FunctionInternal
der_options	OT_DICT	Default options to be used to populate forward_options, reverse_options, and jacobian_options before those options are merged in.	casadi::FunctionInternal
derivative_of	OT_FUNCTION	The function is a derivative of another function. The type of derivative (directional derivative, Jacobian) is inferred from the function name.	casadi::FunctionInternal
dump	OT_BOOL	Dump function to file upon first evaluation. [false]	casadi::FunctionInternal
dump_dir	OT_STRING	Directory to dump inputs/outputs and traces to. Make sure the directory exists [.]	casadi::FunctionInternal
dump_format	OT_STRING	Choose file format to dump matrices. See DM.from_file [mtx]	casadi::FunctionInternal
dump_in	OT_BOOL	Dump numerical values of inputs to file (readable with DM.from_file) [default: false] A counter is used to generate unique names. The counter may be reset using reset_dump_count.	casadi::FunctionInternal
dump_out	OT_BOOL	Dump numerical values of outputs to file (readable with DM.from_file) [default: false] A counter is used to generate unique names. The counter may be reset using reset_dump_count.	casadi::FunctionInternal
enable_ad	OT_BOOL	[DEPRECATED] Renamed uses_directional_derivatives	casadi::FmuFunction
enable_adjoint_hessian	OT_BOOL	Use finite differencing of adjoints for Hessian calculation.	casadi::FmuFunction
enable_adjoint_jacobian	OT_BOOL	Allow Jacobian calculation using adjoint mode AD.	casadi::FmuFunction
enable_fd	OT_BOOL	Enable derivative calculation by finite differencing. [default: false]]	casadi::FunctionInternal
enable_forward	OT_BOOL	Enable derivative calculation using generated functions for Jacobian-times-vector products - typically using forward mode AD - if available. [default: true]	casadi::FunctionInternal
enable_forward_jacobian	OT_BOOL	Allow Jacobian calculation using forward mode AD.	casadi::FmuFunction
enable_jacobian	OT_BOOL	Enable derivative calculation using generated functions for Jacobians of all differentiable outputs with respect to all differentiable inputs - if available. [default: true]	casadi::FunctionInternal
enable_reverse	OT_BOOL	Enable derivative calculation using generated functions for transposed Jacobian-times-vector products - typically using reverse mode AD - if available. [default: true]	casadi::FunctionInternal
error_on_fail	OT_BOOL	Throw exceptions when function evaluation fails (default true).	casadi::ProtoFunction
external_transform	OT_VECTORVECTOR	List of external_transform instruction arguments. Default: empty	casadi::FunctionInternal
fd_flip	OT_BOOL	Allow flipping the sign of the finite difference step to keep it in bounds	casadi::FmuFunction
fd_method	OT_STRING	Method for finite differencing [default 'central']	casadi::FunctionInternal
fd_options	OT_DICT	Options to be passed to the finite difference instance	casadi::FunctionInternal
forward_options	OT_DICT	Options to be passed to a forward mode constructor	casadi::FunctionInternal
gather_stats	OT_BOOL	Deprecated option (ignored): Statistics are now always collected.	casadi::FunctionInternal
hessian_coloring	OT_BOOL	Calculate Hessian using symmetry exploiting graph coloring (star coloring).	casadi::FmuFunction
inputs_check	OT_BOOL	Throw exceptions when the numerical values of the inputs don't make sense	casadi::FunctionInternal
is_diff_in	OT_BOOLVECTOR	Indicate for each input if it should be differentiable.	casadi::FunctionInternal
is_diff_out	OT_BOOLVECTOR	Indicate for each output if it should be differentiable.	casadi::FunctionInternal
jac_penalty	OT_DOUBLE	When requested for a number of forward/reverse directions, it may be cheaper to compute first the full jacobian and then multiply with seeds, rather than obtain the requested directions in a straightforward manner. Casadi uses a heuristic to decide which is cheaper. A high value of 'jac_penalty' makes it less likely for the heurstic to chose the full Jacobian strategy. The special value -1 indicates never to use the full Jacobian strategy	casadi::FunctionInternal
jacobian_options	OT_DICT	Options to be passed to a Jacobian constructor	casadi::FunctionInternal
jit	OT_BOOL	Use just-in-time compiler to speed up the evaluation	casadi::FunctionInternal
jit_cleanup	OT_BOOL	Cleanup up the temporary source file that jit creates. Default: true	casadi::FunctionInternal
jit_name	OT_STRING	The file name used to write out code. The actual file names used depend on 'jit_temp_suffix' and include extensions. Default: 'jit_tmp'	casadi::FunctionInternal
jit_options	OT_DICT	Options to be passed to the jit compiler.	casadi::FunctionInternal
jit_serialize	OT_STRING	Specify behaviour when serializing a jitted function: SOURCE\|link\|embed.	casadi::FunctionInternal
jit_temp_suffix	OT_BOOL	Use a temporary (seemingly random) filename suffix for generated code and libraries. This is desired for thread-safety. This behaviour may defeat caching compiler wrappers. Default: true	casadi::FunctionInternal
make_symmetric	OT_BOOL	Ensure Hessian is symmetric	casadi::FmuFunction
max_io	OT_INT	Acceptable number of inputs and outputs. Warn if exceeded.	casadi::FunctionInternal
max_num_dir	OT_INT	Specify the maximum number of directions for derivative functions. Overrules the builtin optimized_num_dir.	casadi::FunctionInternal
nadj	OT_INT	Number of adjoint sensitivities to be calculated [1]	casadi::FmuFunction
never_inline	OT_BOOL	Forbid inlining.	casadi::FunctionInternal
new_forward	OT_BOOL	Use forward AD implementation in class (conversion option, to be removed)	casadi::FmuFunction
new_hessian	OT_BOOL	Use Hessian implementation in class (conversion option, to be removed)	casadi::FmuFunction
new_jacobian	OT_BOOL	Use Jacobian implementation in class (conversion option, to be removed)	casadi::FmuFunction
nfwd	OT_INT	Number of forward sensitivities to be calculated [1]	casadi::FmuFunction
parallelization	OT_STRING	Parallelization [SERIAL\|openmp\|thread]	casadi::FmuFunction
post_expand	OT_BOOL	After construction, expand this Function. Default: False	casadi::FunctionInternal
post_expand_options	OT_DICT	Options to be passed to post-construction expansion. Default: empty	casadi::FunctionInternal
print_canonical	OT_BOOL	When printing numerical matrices, use a format that is exact and reproducible in generated C code.	casadi::FunctionInternal
print_in	OT_BOOL	Print numerical values of inputs [default: false]	casadi::FunctionInternal
print_out	OT_BOOL	Print numerical values of outputs [default: false]	casadi::FunctionInternal
print_progress	OT_BOOL	Print progress during Jacobian/Hessian evaluation	casadi::FmuFunction
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
reltol	OT_DOUBLE	Relative error tolerance	casadi::FmuFunction
reverse_options	OT_DICT	Options to be passed to a reverse mode constructor	casadi::FunctionInternal
scheme	OT_DICT	Definitions of the scheme variables	casadi::FmuFunction
scheme_in	OT_STRINGVECTOR	Names of the inputs in the scheme	casadi::FmuFunction
scheme_out	OT_STRINGVECTOR	Names of the outputs in the scheme	casadi::FmuFunction
step	OT_DOUBLE	Step size, scaled by nominal value	casadi::FmuFunction
user_data	OT_VOIDPTR	A user-defined field that can be used to identify the function or pass additional information	casadi::FunctionInternal
uses_adjoint_derivatives	OT_BOOL	Use the analytic adjoint derivative support in the FMU	casadi::FmuFunction
uses_directional_derivatives	OT_BOOL	Use the analytic forward directional derivative support in the FMU	casadi::FmuFunction
validate_ad	OT_BOOL	[DEPRECATED] Renamed 'validate_forward'	casadi::FmuFunction
validate_ad_file	OT_STRING	Redirect results of Hessian validation to a file instead of generating a warning	casadi::FmuFunction
validate_forward	OT_BOOL	Compare forward derivatives with finite differences for validation	casadi::FmuFunction
validate_hessian	OT_BOOL	Validate entries of the Hessian for self-consistency	casadi::FmuFunction
verbose	OT_BOOL	Verbose evaluation – for debugging	casadi::ProtoFunction

Definition at line 135 of file fmu_function.hpp.

Inheritance diagram for casadi::FmuFunction:

[legend]

Collaboration diagram for casadi::FmuFunction:

[legend]

Public Types
using	weak_ref_type = WeakRefInternal

Public Member Functions
	FmuFunction (const std::string &name, const Fmu &fmu, const std::vector< std::string > &name_in, const std::vector< std::string > &name_out)
	Constructor. More...

	~FmuFunction () override
	Destructor. More...

std::string	class_name () const override
	Get type name. More...

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

int	eval (const double arg, double res, casadi_int iw, double w, void *mem) const override
	Evaluate numerically. More...

int	eval_all (FmuMemory *m, casadi_int n_task, bool need_nondiff, bool need_jac, bool need_fwd, bool need_adj, bool need_hess) const

int	eval_task (FmuMemory *m, casadi_int task, casadi_int n_task, bool need_nondiff, bool need_jac, bool need_fwd, bool need_adj, bool need_hess) const

void	finalize_hessian (FmuMemory m, double hess_nz, casadi_int *iw) const

bool	all_regular () const

bool	all_vectors () const

Function	factory (const std::string &name, const std::vector< std::string > &s_in, const std::vector< std::string > &s_out, const Function::AuxOut &aux, const Dict &opts) const override

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

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

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

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

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

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

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

virtual std::string	getAdaptorSolverName () const
	Obtain solver name from Adaptor. More...

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

void	reset_dump_count ()
	Reset the counter used to name dump files. More...

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

Function	self () const
	Get a public class instance. More...

virtual std::vector< std::string >	get_function () const

virtual const Function &	get_function (const std::string &name) const

virtual bool	has_function (const std::string &fname) const

void	add_embedded (std::map< FunctionInternal *, std::pair< Function, size_t > > &all_fun, const Function &dep, casadi_int max_depth) const

virtual void	find (std::map< FunctionInternal *, std::pair< Function, size_t > > &all_fun, casadi_int max_depth) const

virtual std::vector< bool >	which_depends (const std::string &s_in, const std::vector< std::string > &s_out, casadi_int order, bool tr=false) const
	Which variables enter with some order. More...

virtual Function	simplify_passes (const std::vector< std::pair< std::string, casadi_int > > &tasks) const
	Apply an ordered list of simplify passes (used by transform) More...

virtual int	eval_sx (const SXElem arg, SXElem res, casadi_int iw, SXElem w, void *mem, bool always_inline, bool never_inline) const
	Evaluate with symbolic scalars. More...

virtual void	eval_mx (const MXVector &arg, MXVector &res, bool always_inline, bool never_inline) const
	Evaluate with symbolic matrices. More...

template<typename M >
void	call (const std::vector< M > &arg, std::vector< M > &res, bool always_inline, bool never_inline) const
	Call a function, templated. More...

template<typename M >
bool	matching_arg (const std::vector< M > &arg, casadi_int &npar) const
	Check if input arguments that needs to be replaced. More...

template<typename M >
bool	matching_res (const std::vector< M > &arg, casadi_int &npar) const
	Check if output arguments that needs to be replaced. More...

template<typename M >
std::vector< M >	replace_arg (const std::vector< M > &arg, casadi_int npar) const
	Replace 0-by-0 inputs. More...

template<typename M >
std::vector< M >	project_arg (const std::vector< M > &arg, casadi_int npar) const
	Project sparsities. More...

template<typename M >
std::vector< M >	project_res (const std::vector< M > &arg, casadi_int npar) const
	Project sparsities. More...

template<typename M >
std::vector< M >	replace_res (const std::vector< M > &res, casadi_int npar) const
	Replace 0-by-0 outputs. More...

template<typename M >
std::vector< std::vector< M > >	replace_fseed (const std::vector< std::vector< M >> &fseed, casadi_int npar) const
	Replace 0-by-0 forward seeds. More...

template<typename M >
std::vector< std::vector< M > >	replace_fseed (const std::vector< std::vector< M > > &fseed, casadi_int npar) const

template<typename M >
std::vector< std::vector< M > >	replace_aseed (const std::vector< std::vector< M >> &aseed, casadi_int npar) const
	Replace 0-by-0 reverse seeds. More...

template<typename M >
std::vector< std::vector< M > >	replace_aseed (const std::vector< std::vector< M > > &aseed, casadi_int npar) const

std::vector< MX >	mapsum_mx (const std::vector< MX > &arg, const std::string &parallelization)
	Parallel evaluation. More...

virtual bool	uses_output () const
	Do the derivative functions need nondifferentiated outputs? More...

std::string	diff_prefix (const std::string &prefix) const
	Determine prefix for differentiated functions. More...

virtual Function	slice (const std::string &name, const std::vector< casadi_int > &order_in, const std::vector< casadi_int > &order_out, const Dict &opts) const
	returns a new function with a selection of inputs/outputs of the original More...

virtual const Function &	oracle () const
	Get oracle. More...

bool	has_derivative () const
	Can derivatives be calculated in any way? More...

virtual double	ad_weight () const
	Weighting factor for chosing forward/reverse mode. More...

virtual double	sp_weight () const
	Weighting factor for chosing forward/reverse mode,. More...

virtual std::vector< MX >	free_mx () const
	Get free variables (MX) More...

virtual std::vector< SX >	free_sx () const
	Get free variables (SX) More...

virtual bool	has_free () const
	Does the function have free variables. More...

virtual void	generate_lifted (Function &vdef_fcn, Function &vinit_fcn) const
	Extract the functions needed for the Lifted Newton method. More...

virtual casadi_int	n_instructions () const
	Get the number of atomic operations. More...

virtual casadi_int	instruction_id (casadi_int k) const
	Get an atomic operation operator index. More...

virtual std::vector< casadi_int >	instruction_input (casadi_int k) const
	Get the (integer) input arguments of an atomic operation. More...

virtual double	instruction_constant (casadi_int k) const
	Get the floating point output argument of an atomic operation. More...

virtual std::vector< casadi_int >	instruction_output (casadi_int k) const
	Get the (integer) output argument of an atomic operation. More...

virtual casadi_int	n_nodes () const
	Number of nodes in the algorithm. More...

virtual MX	instruction_MX (casadi_int k) const
	get MX expression associated with instruction More...

virtual SX	instructions_sx () const
	get SX expression associated with instructions More...

Dict	cache () const
	Get all functions in the cache. More...

bool	incache (const std::string &fname, Function &f, const std::string &suffix="") const
	Get function in cache. More...

void	tocache (const Function &f, const std::string &suffix="") const
	Save function to cache. More...

void	tocache_if_missing (Function &f, const std::string &suffix="") const
	Save function to cache, only if missing. More...

void	codegen (CodeGenerator &g, const std::string &fname) const
	Generate code the function. More...

void	codegen_meta (CodeGenerator &g) const
	Generate meta-information allowing a user to evaluate a generated function. More...

void	codegen_sparsities (CodeGenerator &g) const
	Codegen sparsities. More...

virtual std::string	codegen_name (const CodeGenerator &g, bool ns=true) const
	Get name in codegen. More...

std::string	codegen_mem (CodeGenerator &g, const std::string &index="mem") const
	Get thread-local memory object. More...

virtual void	codegen_incref (CodeGenerator &g) const
	Codegen incref for dependencies. More...

virtual void	codegen_decref (CodeGenerator &g) const
	Codegen decref for dependencies. More...

virtual void	codegen_alloc_mem (CodeGenerator &g) const
	Codegen decref for alloc_mem. More...

virtual void	codegen_init_mem (CodeGenerator &g) const
	Codegen decref for init_mem. More...

virtual void	codegen_free_mem (CodeGenerator &g) const
	Codegen for free_mem. More...

virtual void	codegen_checkout (CodeGenerator &g) const
	Codegen for checkout. More...

virtual void	codegen_release (CodeGenerator &g) const
	Codegen for release. More...

std::string	signature (const std::string &fname) const
	Code generate the function. More...

std::string	signature_unrolled (const std::string &fname) const
	Code generate the function. More...

virtual void	codegen_declarations (CodeGenerator &g) const
	Generate code for the declarations of the C function. More...

virtual void	codegen_body (CodeGenerator &g) const
	Generate code for the function body. More...

virtual std::string	codegen_mem_type () const
	Thread-local memory object type. More...

virtual bool	codegen_needs_mem () const
	Is thread-local memory object needed? More...

virtual bool	codegen_mem_is_opaque () const
	Is thread-local memory object managed by checkout/release. More...

virtual std::string	generate_dependencies (const std::string &fname, const Dict &opts) const
	Export / Generate C code for the dependency function. More...

virtual bool	has_codegen () const
	Is codegen supported? More...

virtual void	jit_dependencies (const std::string &fname)
	Jit dependencies. More...

virtual void	export_code (const std::string &lang, std::ostream &stream, const Dict &options) const
	Export function in a specific language. More...

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

void	disp (std::ostream &stream, bool more) const override
	Display object. More...

virtual void	disp_more (std::ostream &stream) const
	Print more. More...

std::string	definition () const
	Get function signature: name:(inputs)->(outputs) More...

void	print_dimensions (std::ostream &stream) const
	Print dimensions of inputs and outputs. More...

virtual std::vector< std::string >	get_free () const
	Print free variables. More...

void	get_partition (casadi_int iind, casadi_int oind, Sparsity &D1, Sparsity &D2, bool compact, bool symmetric, bool allow_forward, bool allow_reverse) const
	Get the unidirectional or bidirectional partition. More...

virtual double	get_default_in (casadi_int ind) const
	Get default input value. More...

virtual double	get_max_in (casadi_int ind) const
	Get largest input value. More...

virtual double	get_min_in (casadi_int ind) const
	Get smallest input value. More...

virtual double	get_reltol () const
	Get relative tolerance. More...

virtual double	get_abstol () const
	Get absolute tolerance. More...

virtual bool	get_diff_in (casadi_int i)
	Which inputs are differentiable. More...

virtual bool	get_diff_out (casadi_int i)
	Which outputs are differentiable. More...

casadi_int	index_in (const std::string &name) const
	Get input scheme index by name. More...

casadi_int	index_out (const std::string &name) const
	Get output scheme index by name. More...

virtual int	sp_forward (const bvec_t arg, bvec_t res, casadi_int iw, bvec_t w, void *mem) const
	Propagate sparsity forward. More...

virtual int	eval_activity (const bvec_t arg, bvec_t res, casadi_int iw, bvec_t w, void *mem) const
	Propagate signal activity forward. More...

virtual int	sp_forward_block (const bvec_t arg, bvec_t res, casadi_int iw, bvec_t w, void *mem, casadi_int oind, casadi_int iind) const
	Propagate sparsity forward, specific block. More...

virtual int	sp_reverse (bvec_t arg, bvec_t res, casadi_int iw, bvec_t w, void *mem) const
	Propagate sparsity backwards. More...

void	sz_work (size_t &sz_arg, size_t &sz_res, size_t &sz_iw, size_t &sz_w) const
	Get number of temporary variables needed. More...

size_t	sz_arg () const
	Get required length of arg field. More...

size_t	sz_res () const
	Get required length of res field. More...

size_t	sz_iw () const
	Get required length of iw field. More...

size_t	sz_w () const
	Get required length of w field. More...

void	alloc_arg (size_t sz_arg, bool persistent=false)
	Ensure required length of arg field. More...

void	alloc_res (size_t sz_res, bool persistent=false)
	Ensure required length of res field. More...

void	alloc_iw (size_t sz_iw, bool persistent=false)
	Ensure required length of iw field. More...

void	alloc_w (size_t sz_w, bool persistent=false)
	Ensure required length of w field. More...

void	alloc (const Function &f, bool persistent=false, int num_threads=1)
	Ensure work vectors long enough to evaluate function. More...

virtual void	set_work (void mem, const double &arg, double &res, casadi_int &iw, double *&w) const
	Set the (persistent) work vectors. More...

virtual void	set_temp (void mem, const double arg, double res, casadi_int iw, double *w) const
	Set the (temporary) work vectors. More...

void	setup (void mem, const double arg, double res, casadi_int iw, double *w) const
	Set the (persistent and temporary) work vectors. More...

virtual Dict	info () const

Function	map (casadi_int n, const std::string &parallelization) const
	Generate/retrieve cached serial map. More...

void	generate_in (const std::string &fname, const double **arg) const
	Export an input file that can be passed to generate C code with a main. More...

void	generate_out (const std::string &fname, double **res) const

virtual bool	is_a (const std::string &type, bool recursive) const
	Check if the function is of a particular type. More...

virtual void	merge (const std::vector< MX > &arg, std::vector< MX > &subs_from, std::vector< MX > &subs_to) const
	List merge opportunitities. More...

template<typename MatType >
std::vector< std::vector< MatType > >	fwd_seed (casadi_int nfwd) const
	Symbolic expressions for the forward seeds. More...

template<typename MatType >
std::vector< std::vector< MatType > >	symbolicAdjSeed (casadi_int nadj, const std::vector< MatType > &v) const
	Symbolic expressions for the adjoint seeds. More...

void	print_in (std::ostream &stream, const double **arg, bool truncate) const
	Print inputs. More...

void	print_out (std::ostream &stream, double **res, bool truncate) const
	Print outputs. More...

void	construct (const Dict &opts)
	Construct. 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...

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

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 std::string	serialize_base_function () const
	String used to identify the immediate FunctionInternal subclass. 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...


size_t	get_n_in () override
	Number of function inputs and outputs. More...

size_t	get_n_out () override
	Number of function inputs and outputs. More...


Sparsity	get_sparsity_in (casadi_int i) override
	Retreive sparsities. More...

Sparsity	get_sparsity_out (casadi_int i) override
	Retreive sparsities. More...


std::vector< double >	get_nominal_in (casadi_int i) const override
	Retreive nominal values. More...

std::vector< double >	get_nominal_out (casadi_int i) const override
	Retreive nominal values. More...


bool	has_jac_sparsity (casadi_int oind, casadi_int iind) const override
	Return sparsity of Jacobian of an output respect to an input. More...

Sparsity	get_jac_sparsity (casadi_int oind, casadi_int iind, bool symmetric) const override
	Return sparsity of Jacobian of an output respect to an input. More...


bool	has_jacobian () const override
	Full Jacobian. More...

Function	get_jacobian (const std::string &name, const std::vector< std::string > &inames, const std::vector< std::string > &onames, const Dict &opts) const override
	Full Jacobian. More...


bool	has_forward (casadi_int nfwd) const override
	Return function that calculates forward derivatives. More...

Function	get_forward (casadi_int nfwd, const std::string &name, const std::vector< std::string > &inames, const std::vector< std::string > &onames, const Dict &opts) const override
	Return function that calculates forward derivatives. More...


bool	has_reverse (casadi_int nadj) const override
	Reverse mode AD. More...

Function	get_reverse (casadi_int nadj, const std::string &name, const std::vector< std::string > &inames, const std::vector< std::string > &onames, const Dict &opts) const override
	Reverse mode AD. More...


virtual bool	has_spfwd () const
	Is the class able to propagate seeds through the algorithm? More...

virtual bool	has_sprev () const
	Is the class able to propagate seeds through the algorithm? More...


int	eval_gen (const double arg, double res, casadi_int iw, double w, void *mem, bool always_inline, bool never_inline) const
	Evaluate numerically. More...


int	eval_gen (const SXElem arg, SXElem res, casadi_int iw, SXElem w, void *mem, bool always_inline, bool never_inline) const
	Evaluate a function, overloaded. More...

int	eval_gen (const bvec_t arg, bvec_t res, casadi_int iw, bvec_t w, void *mem, bool always_inline, bool never_inline) const
	Evaluate a function, overloaded. More...


virtual std::vector< DM >	eval_dm (const std::vector< DM > &arg) const
	Evaluate with DM matrices. More...

virtual bool	has_eval_dm () const
	Evaluate with DM matrices. More...


void	call_gen (const MXVector &arg, MXVector &res, casadi_int npar, bool always_inline, bool never_inline) const
	Call a function, overloaded. More...

template<typename D >
void	call_gen (const std::vector< Matrix< D > > &arg, std::vector< Matrix< D > > &res, casadi_int npar, bool always_inline, bool never_inline) const
	Call a function, overloaded. More...


template<typename M >
void	check_arg (const std::vector< M > &arg, casadi_int &npar) const
	Check if input arguments have correct length and dimensions. More...


template<typename M >
void	check_res (const std::vector< M > &res, casadi_int &npar) const
	Check if output arguments have correct length and dimensions. More...


template<typename M >
std::map< std::string, M >	convert_arg (const std::vector< M > &arg) const
	Convert from/to input/output lists/map. More...

template<typename M >
std::vector< M >	convert_arg (const std::map< std::string, M > &arg) const
	Convert from/to input/output lists/map. More...

template<typename M >
std::map< std::string, M >	convert_res (const std::vector< M > &res) const
	Convert from/to input/output lists/map. More...

template<typename M >
std::vector< M >	convert_res (const std::map< std::string, M > &res) const
	Convert from/to input/output lists/map. More...


std::vector< double >	nz_in (const std::vector< DM > &arg) const
	Convert from/to flat vector of input/output nonzeros. More...

std::vector< DM >	nz_in (const std::vector< double > &arg) const
	Convert from/to flat vector of input/output nonzeros. More...

std::vector< double >	nz_out (const std::vector< DM > &res) const
	Convert from/to flat vector of input/output nonzeros. More...

std::vector< DM >	nz_out (const std::vector< double > &res) const
	Convert from/to flat vector of input/output nonzeros. More...


virtual void	call_forward (const std::vector< MX > &arg, const std::vector< MX > &res, const std::vector< std::vector< MX > > &fseed, std::vector< std::vector< MX > > &fsens, bool always_inline, bool never_inline) const
	Forward mode AD, virtual functions overloaded in derived classes. More...

virtual void	call_forward (const std::vector< SX > &arg, const std::vector< SX > &res, const std::vector< std::vector< SX > > &fseed, std::vector< std::vector< SX > > &fsens, bool always_inline, bool never_inline) const
	Forward mode AD, virtual functions overloaded in derived classes. More...


virtual void	call_reverse (const std::vector< MX > &arg, const std::vector< MX > &res, const std::vector< std::vector< MX > > &aseed, std::vector< std::vector< MX > > &asens, bool always_inline, bool never_inline) const
	Reverse mode, virtual functions overloaded in derived classes. More...

virtual void	call_reverse (const std::vector< SX > &arg, const std::vector< SX > &res, const std::vector< std::vector< SX > > &aseed, std::vector< std::vector< SX > > &asens, bool always_inline, bool never_inline) const
	Reverse mode, virtual functions overloaded in derived classes. More...


Function	jacobian () const
	Return Jacobian of all input elements with respect to all output elements. More...


Sparsity &	jac_sparsity (casadi_int oind, casadi_int iind, bool compact, bool symmetric) const
	Get Jacobian sparsity. More...


Function	forward (casadi_int nfwd) const
	Return function that calculates forward derivatives. More...


Function	reverse (casadi_int nadj) const
	Return function that calculates adjoint derivatives. More...


virtual const SX	sx_in (casadi_int ind) const
	Get function input(s) and output(s) More...

virtual const std::vector< SX >	sx_in () const
	Get function input(s) and output(s) More...

virtual const SX	sx_out (casadi_int ind) const
	Get function input(s) and output(s) More...

virtual const std::vector< SX >	sx_out () const
	Get function input(s) and output(s) More...

virtual const MX	mx_in (casadi_int ind) const
	Get function input(s) and output(s) More...

virtual const std::vector< MX >	mx_in () const
	Get function input(s) and output(s) More...

virtual const MX	mx_out (casadi_int ind) const
	Get function input(s) and output(s) More...

virtual const std::vector< MX >	mx_out () const
	Get function input(s) and output(s) More...

const DM	dm_in (casadi_int ind) const
	Get function input(s) and output(s) More...

const std::vector< DM >	dm_in () const
	Get function input(s) and output(s) More...

const DM	dm_out (casadi_int ind) const
	Get function input(s) and output(s) More...

const std::vector< DM >	dm_out () const
	Get function input(s) and output(s) More...


Function	wrap (const std::string &name) const
	Wrap in an Function instance consisting of only one MX call. More...

Function	wrap () const
	Wrap in an Function instance consisting of only one MX call. More...


Function	wrap_as_needed (const std::string &name, const Dict &opts) const
	Wrap in an Function instance consisting of only one MX call. More...

Function	wrap_as_needed (const Dict &opts) const
	Wrap in an Function instance consisting of only one MX call. More...


casadi_int	nnz_in () const
	Number of input/output nonzeros. More...

casadi_int	nnz_in (casadi_int ind) const
	Number of input/output nonzeros. More...

casadi_int	nnz_out () const
	Number of input/output nonzeros. More...

casadi_int	nnz_out (casadi_int ind) const
	Number of input/output nonzeros. More...


casadi_int	numel_in () const
	Number of input/output elements. More...

casadi_int	numel_in (casadi_int ind) const
	Number of input/output elements. More...

casadi_int	numel_out (casadi_int ind) const
	Number of input/output elements. More...

casadi_int	numel_out () const
	Number of input/output elements. More...


casadi_int	size1_in (casadi_int ind) const
	Input/output dimensions. More...

casadi_int	size2_in (casadi_int ind) const
	Input/output dimensions. More...

casadi_int	size1_out (casadi_int ind) const
	Input/output dimensions. More...

casadi_int	size2_out (casadi_int ind) const
	Input/output dimensions. More...

std::pair< casadi_int, casadi_int >	size_in (casadi_int ind) const
	Input/output dimensions. More...

std::pair< casadi_int, casadi_int >	size_out (casadi_int ind) const
	Input/output dimensions. More...


const Sparsity &	sparsity_in (casadi_int ind) const
	Input/output sparsity. More...

const Sparsity &	sparsity_out (casadi_int ind) const
	Input/output sparsity. More...


bool	all_scalar () const
	Are all inputs and outputs scalar. More...

virtual bool	jac_is_symm (casadi_int oind, casadi_int iind) const
	Is a Jacobian block known to be symmetric a priori? More...

Sparsity	to_compact (casadi_int oind, casadi_int iind, const Sparsity &sp) const
	Convert to compact Jacobian sparsity pattern. More...

Sparsity	from_compact (casadi_int oind, casadi_int iind, const Sparsity &sp) const
	Convert from compact Jacobian sparsity pattern. More...

template<bool fwd>
Sparsity	get_jac_sparsity_gen (casadi_int oind, casadi_int iind) const
	Get the sparsity pattern via sparsity seed propagation. More...

Sparsity	get_jac_sparsity_hierarchical (casadi_int oind, casadi_int iind) const
	A flavor of get_jac_sparsity_gen that does hierarchical block structure recognition. More...

Sparsity	get_jac_sparsity_hierarchical_symm (casadi_int oind, casadi_int iind) const

virtual std::vector< MX >	symbolic_output (const std::vector< MX > &arg) const
	Get a vector of symbolic variables corresponding to the outputs. More...


virtual std::string	get_name_in (casadi_int i)
	Names of function input and outputs. More...

virtual std::string	get_name_out (casadi_int i)
	Names of function input and outputs. More...


virtual size_t	codegen_sz_arg (const CodeGenerator &g) const
	Get required lengths, for codegen. More...

virtual size_t	codegen_sz_res (const CodeGenerator &g) const
	Get required lengths, for codegen. More...

virtual size_t	codegen_sz_iw (const CodeGenerator &g) const
	Get required lengths, for codegen. More...

virtual size_t	codegen_sz_w (const CodeGenerator &g) const
	Get required lengths, for codegen. More...


virtual bool	fwdViaJac (casadi_int nfwd) const
	Calculate derivatives by multiplying the full Jacobian and multiplying. More...

virtual bool	adjViaJac (casadi_int nadj) const
	Calculate derivatives by multiplying the full Jacobian and multiplying. More...

Static Public Member Functions
static void	identify_io (std::vector< std::string > scheme_in, std::vector< std::string > scheme_out, const std::vector< std::string > &name_in, const std::vector< std::string > &name_out)

static ProtoFunction *	deserialize (DeserializingStream &s)
	Deserialize without type information. More...

static std::string	forward_name (const std::string &fcn, casadi_int nfwd)
	Helper function: Get name of forward derivative function. More...

static std::string	reverse_name (const std::string &fcn, casadi_int nadj)
	Helper function: Get name of adjoint derivative function. More...

template<typename MatType >
static MatType	ensure_stacked (const MatType &v, const Sparsity &sp, casadi_int n)
	Ensure that a matrix's sparsity is a horizontal multiple of another, or empty. More...

static std::string	get_jit_directory (const Dict &jit_options)
	Get JIT directory from options. More...

template<typename MatType >
static bool	purgable (const std::vector< MatType > &seed)
	Can a derivative direction be skipped. More...

static std::string	string_from_UnifiedReturnStatus (UnifiedReturnStatus status)

static void	print_canonical (std::ostream &stream, const Sparsity &sp, const double *nz)
	Print canonical representation of a numeric matrix. More...

static void	print_canonical (std::ostream &stream, casadi_int sz, const double *nz)
	Print canonical representation of a numeric vector. More...

static void	print_canonical (std::ostream &stream, double a)
	Print canonical representation of a number. More...


static bool	check_mat (const Sparsity &arg, const Sparsity &inp, casadi_int &npar)

Public Attributes
Fmu	fmu_

std::vector< InputStruct >	in_

std::vector< OutputStruct >	out_

std::vector< size_t >	jac_in_

std::vector< size_t >	jac_out_

std::vector< double >	jac_nom_in_

std::vector< Sparsity >	sp_trans_

std::vector< casadi_int >	sp_trans_map_

bool	has_jac_

bool	has_fwd_

bool	has_adj_

bool	has_hess_

bool	uses_directional_derivatives_

bool	uses_adjoint_derivatives_

casadi_int	nfwd_
	Number of sensitivities. More...

casadi_int	nadj_

bool	validate_forward_

bool	validate_hessian_

double	step_

double	abstol_

double	reltol_

bool	print_progress_

bool	new_jacobian_

bool	new_forward_

bool	new_hessian_

bool	fd_flip_

bool	make_symmetric_

bool	hessian_coloring_

bool	asymmetric_hessian_coloring_

bool	enable_forward_jacobian_

bool	enable_adjoint_jacobian_

bool	enable_adjoint_hessian_

std::string	validate_ad_file_

FdMode	fd_

Parallelization	parallelization_

Dict	init_stats_

Sparsity	jac_sp_

Sparsity	hess_sp_

Sparsity	adj_sp_

Sparsity	jac_colors_

Sparsity	adj_colors_

Sparsity	hess_colors_

Sparsity	hess_uni_colors_

std::vector< casadi_int >	which_hess_color_

std::vector< casadi_int >	nonlin_

casadi_jac_prob< double >	jac_prob_

casadi_jac_prob< double >	adj_prob_

casadi_int	max_jac_tasks_

casadi_int	max_hess_tasks_

casadi_int	max_adj_tasks_

casadi_int	max_n_tasks_

bool	always_inline_

bool	never_inline_

size_t	n_in_
	Number of inputs and outputs. More...

size_t	n_out_

std::vector< bool >	is_diff_in_
	Are inputs and outputs differentiable? More...

std::vector< bool >	is_diff_out_

std::vector< Sparsity >	sparsity_in_
	Input and output sparsity. More...

std::vector< Sparsity >	sparsity_out_

std::vector< std::string >	name_in_
	Input and output scheme. More...

std::vector< std::string >	name_out_

bool	jit_
	Use just-in-time compiler. More...

bool	jit_cleanup_
	Cleanup jit source file. More...

std::string	jit_serialize_
	Serialize behaviour. More...

std::string	jit_name_
	Name if jit source file. More...

std::string	jit_directory_

std::string	jit_base_name_

bool	jit_temp_suffix_
	Use a temporary name. More...

eval_t	eval_
	Numerical evaluation redirected to a C function. More...

casadi_checkout_t	checkout_
	Checkout redirected to a C function. More...

casadi_release_t	release_
	Release redirected to a C function. More...

signal_t	incref_
	Incref/decref redirected to C functions. More...

signal_t	decref_

Dict	stats_
	Dict of statistics (resulting from evaluate) More...

bool	has_refcount_
	Reference counting in codegen? More...

bool	has_refcount_in_deps_
	Reference counting in dependent functions. More...

Dict	cache_init_
	Values to prepopulate the function cache with. More...

WeakCache< std::string, Function >	cache_
	Function cache. More...

std::vector< Sparsity >	jac_sparsity_ [2]
	Cache for sparsities of the Jacobian blocks. More...

Function	derivative_of_
	If the function is the derivative of another function. More...

void *	user_data_
	User-set field. More...

std::string	compiler_plugin_
	Just-in-time compiler. More...

Importer	compiler_

Dict	jit_options_

double	jac_penalty_
	Penalty factor for using a complete Jacobian to calculate directional derivatives. More...

bool	enable_forward_

bool	enable_reverse_

bool	enable_jacobian_

bool	enable_fd_

bool	enable_forward_op_

bool	enable_reverse_op_

bool	enable_jacobian_op_

bool	enable_fd_op_

double	ad_weight_
	Weighting factor for derivative calculation and sparsity pattern calculation. More...

double	ad_weight_sp_

casadi_int	max_num_dir_
	Maximum number of sensitivity directions. More...

bool	inputs_check_
	Errors are thrown if numerical values of inputs look bad. More...

Dict	fd_options_

double	fd_step_

std::string	fd_method_

bool	print_in_

bool	print_out_

bool	print_canonical_

casadi_int	max_io_

bool	dump_in_

bool	dump_out_

bool	dump_

std::string	dump_dir_

std::string	dump_format_

Dict	forward_options_

Dict	reverse_options_

Dict	jacobian_options_

Dict	der_options_

Function	custom_jacobian_

std::vector< Function >	registered_functions_

casadi_int	dump_count_

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

Static Public Attributes
static std::map< std::string, ProtoFunction ()(DeserializingStream &)>	deserialize_map

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

void	set_jac_sparsity (casadi_int oind, casadi_int iind, const Sparsity &sp)
	Populate jac_sparsity_ and jac_sparsity_compact_ during initialization. More...

std::unique_ptr< std::ostream >	open_trace (const double **arg, casadi_int dump_id) const

void	finish_trace (std::ostream &trace, double **res, int ret) const

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 Protected Member Functions
static void	trace_values (std::ostream &trace, const double *values, casadi_int nnz)

static const Options	options_
	Options. More...

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

◆ FmuFunction() [1/2]

casadi::FmuFunction::FmuFunction	(	const std::string &	name,
		const Fmu &	fmu,
		const std::vector< std::string > &	name_in,
		const std::vector< std::string > &	name_out
	)

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

Definition at line 115 of file fmu_function.cpp.

     : FunctionInternal(name), fmu_(fmu) {
   // Parse input IDs
   in_.resize(name_in.size());
   for (size_t k = 0; k < name_in.size(); ++k) {
     try {
       in_[k] = InputStruct::parse(name_in[k], &fmu);
     } catch (std::exception& e) {
       casadi_error("Cannot process input " + name_in[k] + ": " + std::string(e.what()));
     }
   }
   // Parse output IDs
   out_.resize(name_out.size());
   for (size_t k = 0; k < name_out.size(); ++k) {
     try {
       out_[k] = OutputStruct::parse(name_out[k], &fmu);
     } catch (std::exception& e) {
       casadi_error("Cannot process output " + name_out[k] + ": " + std::string(e.what()));
     }
   }
   // Which inputs and outputs exist
   has_fwd_ = has_adj_ = has_jac_ = has_hess_ = false;
   for (auto&& i : out_) {
     switch (i.type) {
     case OutputType::JAC:
     case OutputType::JAC_TRANS:
       has_jac_ = true;
       break;
     case OutputType::FWD:
       has_fwd_ = true;
       break;
     case OutputType::ADJ:
       has_adj_ = true;
       break;
     case OutputType::HESS:
       has_adj_ = true;
       has_hess_ = true;
     default:
       break;
     }
   }
   // Set input/output names
   name_in_ = name_in;
   name_out_ = name_out;
   // Default options
   uses_directional_derivatives_ = fmu.provides_directional_derivatives();
   uses_adjoint_derivatives_ = fmu.provides_adjoint_derivatives();
   validate_forward_ = false;
   validate_hessian_ = false;
   validate_ad_file_ = "";
   make_symmetric_ = true;
   nfwd_ = has_fwd_ ? 1 : 0;
   nadj_ = has_adj_ ? 1 : 0;
   // Use FD for second and higher order derivatives
   enable_fd_op_ = fmu.provides_directional_derivatives() && !all_regular();
   step_ = 1e-6;
   fd_flip_ = true;
   abstol_ = 1e-3;
   reltol_ = 1e-3;
   print_progress_ = false;
   new_jacobian_ = true;
   new_forward_ = true;
   new_hessian_ = true;
   enable_forward_jacobian_ = true;
   enable_adjoint_jacobian_ = false;
   enable_adjoint_hessian_ = false;  // change to true when tested and adjoints are available
   hessian_coloring_ = true;
   asymmetric_hessian_coloring_ = false;
   parallelization_ = Parallelization::SERIAL;
   // Number of parallel tasks, by default
   max_n_tasks_ = 1;
   max_jac_tasks_ = max_hess_tasks_ = 0;
 }

References abstol_, casadi::ADJ, all_regular(), asymmetric_hessian_coloring_, enable_adjoint_hessian_, enable_adjoint_jacobian_, casadi::FunctionInternal::enable_fd_op_, enable_forward_jacobian_, fd_flip_, casadi::FWD, has_adj_, has_fwd_, has_hess_, has_jac_, casadi::HESS, hessian_coloring_, in_, casadi::JAC, casadi::JAC_TRANS, make_symmetric_, max_hess_tasks_, max_jac_tasks_, max_n_tasks_, nadj_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::name_out_, new_forward_, new_hessian_, new_jacobian_, nfwd_, out_, parallelization_, casadi::InputStruct::parse(), casadi::OutputStruct::parse(), print_progress_, casadi::Fmu::provides_adjoint_derivatives(), casadi::Fmu::provides_directional_derivatives(), reltol_, casadi::SERIAL, step_, uses_adjoint_derivatives_, uses_directional_derivatives_, validate_ad_file_, validate_forward_, and validate_hessian_.

Referenced by factory(), get_forward(), get_jacobian(), and get_reverse().

◆ ~FmuFunction()

casadi::FmuFunction::~FmuFunction ( )

override

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

Definition at line 236 of file fmu_function.cpp.

                           {
   // Free memory
   clear_mem();
 }

References casadi::ProtoFunction::clear_mem().

◆ FmuFunction() [2/2]

casadi::FmuFunction::FmuFunction ( DeserializingStream & s )

explicitprotected

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

Definition at line 1778 of file fmu_function.cpp.

                                                : FunctionInternal(s) {
   s.version("FmuFunction", 6, 6);
  
   s.unpack("FmuFunction::Fmu", fmu_);
  
   in_.resize(n_in_);
   for (InputStruct& e : in_) {
     int t = 0;
     s.unpack("FmuFunction::in::type", t);
     e.type = static_cast<InputType>(t);
     s.unpack("FmuFunction::in::ind", e.ind);
   }
   out_.resize(n_out_);
   for (OutputStruct& e : out_) {
     int t = 0;
     s.unpack("FmuFunction::out::type", t);
     e.type = static_cast<OutputType>(t);
     s.unpack("FmuFunction::out::ind", e.ind);
     s.unpack("FmuFunction::out::wrt", e.wrt);
     s.unpack("FmuFunction::out::rbegin", e.rbegin);
     s.unpack("FmuFunction::out::rend", e.rend);
     s.unpack("FmuFunction::out::cbegin", e.cbegin);
     s.unpack("FmuFunction::out::cend", e.cend);
   }
  
   s.unpack("FmuFunction::jac_in", jac_in_);
   s.unpack("FmuFunction::jac_out", jac_out_);
  
   s.unpack("FmuFunction::jac_nom_in", jac_nom_in_);
   s.unpack("FmuFunction::sp_trans", sp_trans_);
   s.unpack("FmuFunction::sp_trans_map", sp_trans_map_);
  
   s.unpack("FmuFunction::has_jac", has_jac_);
   s.unpack("FmuFunction::has_fwd", has_fwd_);
   s.unpack("FmuFunction::has_adj", has_adj_);
   s.unpack("FmuFunction::has_hess", has_hess_);
  
   s.unpack("FmuFunction::uses_directional_derivatives", uses_directional_derivatives_);
   s.unpack("FmuFunction::uses_adjoint_derivatives", uses_adjoint_derivatives_);
   s.unpack("FmuFunction::nfwd", nfwd_);
   s.unpack("FmuFunction::nadj", nadj_);
   s.unpack("FmuFunction::validate_forward", validate_forward_);
   s.unpack("FmuFunction::validate_hessian", validate_hessian_);
   s.unpack("FmuFunction::make_symmetric", make_symmetric_);
   s.unpack("FmuFunction::step", step_);
   s.unpack("FmuFunction::fd_flip", fd_flip_);
   s.unpack("FmuFunction::abstol", abstol_);
   s.unpack("FmuFunction::reltol", reltol_);
   s.unpack("FmuFunction::print_progress", print_progress_);
   s.unpack("FmuFunction::new_jacobian", new_jacobian_);
   s.unpack("FmuFunction::new_forward", new_forward_);
   s.unpack("FmuFunction::new_hessian", new_hessian_);
   s.unpack("FmuFunction::hessian_coloring", hessian_coloring_);
   s.unpack("FmuFunction::asymmetric_hessian_coloring", asymmetric_hessian_coloring_);
   s.unpack("FmuFunction::enable_forward_jacobian", enable_forward_jacobian_);
   s.unpack("FmuFunction::enable_adjoint_jacobian", enable_adjoint_jacobian_);
   s.unpack("FmuFunction::enable_adjoint_hessian", enable_adjoint_hessian_);
   s.unpack("FmuFunction::validate_ad_file", validate_ad_file_);
  
   int fd = 0;
   s.unpack("FmuFunction::fd", fd);
   fd_ = static_cast<FdMode>(fd);
   int parallelization = 0;
   s.unpack("FmuFunction::parallelization", parallelization);
   parallelization_ = static_cast<Parallelization>(parallelization);
  
   s.unpack("FmuFunction::init_stats", init_stats_);
  
   s.unpack("FmuFunction::jac_sp", jac_sp_);
   s.unpack("FmuFunction::hess_sp", hess_sp_);
   s.unpack("FmuFunction::adj_sp", adj_sp_);
   s.unpack("FmuFunction::jac_colors", jac_colors_);
   s.unpack("FmuFunction::adj_colors", adj_colors_);
   s.unpack("FmuFunction::hess_colors", hess_colors_);
   s.unpack("FmuFunction::hess_uni_colors", hess_uni_colors_);
   s.unpack("FmuFunction::which_hess_color", which_hess_color_);
   s.unpack("FmuFunction::nonlin", nonlin_);
  
   s.unpack("FmuFunction::max_jac_tasks", max_jac_tasks_);
   s.unpack("FmuFunction::max_hess_tasks", max_hess_tasks_);
   s.unpack("FmuFunction::max_n_tasks", max_n_tasks_);
  
   if (has_jac_ || has_adj_ || has_hess_) {
     // Setup Jacobian memory (via forward mode)
     casadi_jac_setup(&jac_prob_, jac_sp_, jac_colors_);
     jac_prob_.nom_in = get_ptr(jac_nom_in_);
     jac_prob_.map_out = get_ptr(jac_out_);
     jac_prob_.map_in = get_ptr(jac_in_);
   }
   if (enable_adjoint_jacobian_) {
     // Setup adjoint Jacobian memory (via reverse mode)
     casadi_jac_setup(&adj_prob_, adj_sp_, adj_colors_);
     adj_prob_.nom_in = nullptr;
     adj_prob_.map_out = get_ptr(jac_in_);
     adj_prob_.map_in = get_ptr(jac_out_);
   }
 }

References abstol_, adj_colors_, adj_prob_, adj_sp_, asymmetric_hessian_coloring_, enable_adjoint_hessian_, enable_adjoint_jacobian_, enable_forward_jacobian_, fd_, fd_flip_, fmu_, casadi::get_ptr(), has_adj_, has_fwd_, has_hess_, has_jac_, hess_colors_, hess_sp_, hess_uni_colors_, hessian_coloring_, in_, init_stats_, jac_colors_, jac_in_, jac_nom_in_, jac_out_, jac_prob_, jac_sp_, make_symmetric_, casadi_jac_prob< T1 >::map_in, casadi_jac_prob< T1 >::map_out, max_hess_tasks_, max_jac_tasks_, max_n_tasks_, casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, nadj_, new_forward_, new_hessian_, new_jacobian_, nfwd_, casadi_jac_prob< T1 >::nom_in, nonlin_, out_, parallelization_, print_progress_, reltol_, sp_trans_, sp_trans_map_, step_, casadi::DeserializingStream::unpack(), uses_adjoint_derivatives_, uses_directional_derivatives_, validate_ad_file_, validate_forward_, validate_hessian_, casadi::DeserializingStream::version(), and which_hess_color_.

Member Function Documentation

◆ ad_weight()

double casadi::FunctionInternal::ad_weight ( ) const

virtualinherited

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

Definition at line 3522 of file function_internal.cpp.

                                            {
     // If reverse mode derivatives unavailable, use forward
     if (!enable_reverse_) return 0;
  
     // If forward mode derivatives unavailable, use reverse
     if (!enable_forward_ && !enable_fd_) return 1;
  
     // Use the (potentially user set) option
     return ad_weight_;
   }

References casadi::FunctionInternal::ad_weight_, casadi::FunctionInternal::enable_fd_, casadi::FunctionInternal::enable_forward_, and casadi::FunctionInternal::enable_reverse_.

Referenced by casadi::FunctionInternal::adjViaJac(), casadi::FunctionInternal::fwdViaJac(), casadi::FunctionInternal::get_partition(), casadi::FunctionInternal::wrap(), and casadi::FunctionInternal::wrap_as_needed().

◆ add_embedded()

void casadi::FunctionInternal::add_embedded	(	std::map< FunctionInternal *, std::pair< Function, size_t > > &	all_fun,
		const Function &	dep,
		casadi_int	max_depth
	)		const

inherited

Definition at line 3964 of file function_internal.cpp.

                                                        {
     // Add, if not already in graph and not null
     if (!dep.is_null() && all_fun.find(dep.get()) == all_fun.end()) {
       size_t index = all_fun.size();
       all_fun[dep.get()] = std::make_pair(dep, index);
       // Also add its dependencies
       if (max_depth > 0) dep->find(all_fun, max_depth - 1);
     }
   }

References casadi::FunctionInternal::find(), casadi::Function::get(), and casadi::GenericShared< Shared, Internal >::is_null().

Referenced by casadi::FunctionInternal::find(), casadi::Map::find(), casadi::MapSum::find(), casadi::MXFunction::find(), casadi::OracleFunction::find(), casadi::Switch::find(), casadi::SXFunction::find(), and casadi::BSplineInterpolant::find().

◆ adjViaJac()

bool casadi::FunctionInternal::adjViaJac ( casadi_int nadj ) const

virtualinherited

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

Definition at line 3255 of file function_internal.cpp.

                                                         {
     if (!enable_reverse_) return true;
     if (jac_penalty_==-1) return false;
  
     // Heuristic 1: Jac calculated via reverse mode likely cheaper
     if (jac_penalty_*static_cast<double>(nnz_out())<nadj) return true;
  
     // Heuristic 2: Jac calculated via forward mode likely cheaper
     double w = ad_weight();
     if ((enable_forward_ || enable_fd_) &&
         jac_penalty_*w*static_cast<double>(nnz_in())<(1-w)*static_cast<double>(nadj))
       return true; // NOLINT
  
     return false;
   }

References casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::enable_fd_, casadi::FunctionInternal::enable_forward_, casadi::FunctionInternal::enable_reverse_, casadi::FunctionInternal::jac_penalty_, casadi::FunctionInternal::nnz_in(), and casadi::FunctionInternal::nnz_out().

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

◆ all_regular()

bool casadi::FmuFunction::all_regular ( ) const

Definition at line 1513 of file fmu_function.cpp.

                                     {
   // Look for any non-regular input
   for (auto&& e : in_) if (e.type != InputType::REG) return false;
   // Look for any non-regular output
   for (auto&& e : out_) if (e.type != OutputType::REG) return false;
   // Only regular inputs and outputs
   return true;
 }

References in_, out_, and casadi::REG.

Referenced by FmuFunction(), has_forward(), has_jacobian(), and has_reverse().

◆ all_scalar()

bool casadi::FunctionInternal::all_scalar ( ) const

inherited

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

Definition at line 4009 of file function_internal.cpp.

                                           {
     // Check inputs
     for (casadi_int i=0; i<n_in_; ++i) {
       if (!sparsity_in_[i].is_scalar()) return false;
     }
     // Check outputs
     for (casadi_int i=0; i<n_out_; ++i) {
       if (!sparsity_out_[i].is_scalar()) return false;
     }
     // All are scalar
     return true;
   }

References casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, casadi::FunctionInternal::sparsity_in_, and casadi::FunctionInternal::sparsity_out_.

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

◆ all_vectors()

bool casadi::FmuFunction::all_vectors ( ) const

Definition at line 1522 of file fmu_function.cpp.

                                     {
   // Check inputs
   for (auto&& e : in_) {
     switch (e.type) {
       // Supported for derivative calculations
       case InputType::REG:
       case InputType::OUT:
         break;
       // Supported if one derivative
       case InputType::FWD:
         if (nfwd_ > 1) return false;
         break;
       case InputType::ADJ:
         if (nadj_ > 1) return false;
         break;
       // Not supported
       default:
         return false;
     }
   }
   // Check outputs
   for (auto&& e : out_) {
     // Supported for derivative calculations
     switch (e.type) {
       case OutputType::REG:
       case OutputType::ADJ:
         break;
       // Not supported
       default:
         return false;
     }
   }
   // OK if reached this point
   return true;
 }

References casadi::ADJ, casadi::FWD, in_, nadj_, nfwd_, casadi::OUT, out_, and casadi::REG.

Referenced by has_jacobian().

◆ alloc()

void casadi::FunctionInternal::alloc	(	const Function &	f,
		bool	persistent = `false`,
		int	num_threads = `1`
	)

inherited

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

Definition at line 3203 of file function_internal.cpp.

                                                                                   {
     if (f.is_null()) return;
     size_t sz_arg, sz_res, sz_iw, sz_w;
     f.sz_work(sz_arg, sz_res, sz_iw, sz_w);
     alloc_arg(sz_arg*num_threads, persistent);
     alloc_res(sz_res*num_threads, persistent);
     alloc_iw(sz_iw*num_threads, persistent);
     alloc_w(sz_w*num_threads, persistent);
     registered_functions_.push_back(f);
   }

References casadi::FunctionInternal::alloc_arg(), casadi::FunctionInternal::alloc_iw(), casadi::FunctionInternal::alloc_res(), casadi::FunctionInternal::alloc_w(), casadi::GenericShared< Shared, Internal >::is_null(), casadi::FunctionInternal::registered_functions_, casadi::FunctionInternal::sz_arg(), casadi::FunctionInternal::sz_iw(), casadi::FunctionInternal::sz_res(), casadi::FunctionInternal::sz_w(), and casadi::Function::sz_work().

Referenced by casadi::OracleFunction::finalize(), casadi::KinsolInterface::get_jtimes(), casadi::FiniteDiff::init(), casadi::Nlpsol::init(), casadi::Rootfinder::init(), casadi::Switch::init(), casadi::Feasiblesqpmethod::init(), casadi::ImplicitToNlp::init(), casadi::QpToNlp::init(), casadi::Qrsqp::init(), casadi::Scpgen::init(), and casadi::Sqpmethod::init().

◆ alloc_arg()

void casadi::FunctionInternal::alloc_arg	(	size_t	sz_arg,
		bool	persistent = `false`
	)

inherited

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

Definition at line 3171 of file function_internal.cpp.

                                                                  {
     if (persistent) {
       sz_arg_per_ += sz_arg;
     } else {
       sz_arg_tmp_ = std::max(sz_arg_tmp_, sz_arg);
     }
   }

References casadi::FunctionInternal::sz_arg().

◆ alloc_iw()

void casadi::FunctionInternal::alloc_iw	(	size_t	sz_iw,
		bool	persistent = `false`
	)

inherited

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

Definition at line 3187 of file function_internal.cpp.

                                                                {
     if (persistent) {
       sz_iw_per_ += sz_iw;
     } else {
       sz_iw_tmp_ = std::max(sz_iw_tmp_, sz_iw);
     }
   }

References casadi::FunctionInternal::sz_iw().

◆ alloc_mem()

void * casadi::FmuFunction::alloc_mem ( ) const

overridevirtual

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

Reimplemented from casadi::ProtoFunction.

Definition at line 81 of file fmu_function.cpp.

                                    {
   // Create (master) memory object
   FmuMemory* m = fmu_.alloc_mem(*this);
   // Attach additional (slave) memory objects
   for (casadi_int i = 1; i < max_jac_tasks_; ++i) {
     m->slaves.push_back(fmu_.alloc_mem(*this));
   }
   return m;
 }

References casadi::Fmu::alloc_mem(), fmu_, max_jac_tasks_, and casadi::FmuMemory::slaves.

◆ alloc_res()

void casadi::FunctionInternal::alloc_res	(	size_t	sz_res,
		bool	persistent = `false`
	)

inherited

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

Definition at line 3179 of file function_internal.cpp.

                                                                  {
     if (persistent) {
       sz_res_per_ += sz_res;
     } else {
       sz_res_tmp_ = std::max(sz_res_tmp_, sz_res);
     }
   }

References casadi::FunctionInternal::sz_res().

◆ alloc_w()

void casadi::FunctionInternal::alloc_w	(	size_t	sz_w,
		bool	persistent = `false`
	)

inherited

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

Definition at line 3195 of file function_internal.cpp.

                                                              {
     if (persistent) {
       sz_w_per_ += sz_w;
     } else {
       sz_w_tmp_ = std::max(sz_w_tmp_, sz_w);
     }
   }

References casadi::FunctionInternal::sz_w().

◆ cache()

Dict casadi::FunctionInternal::cache ( ) const

inherited

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

Definition at line 1163 of file function_internal.cpp.

                                      {
     // Return value
     Dict ret;
  
     // Retrieve all Function instances that haven't been deleted
     std::vector<std::string> keys;
     std::vector<Function> entries;
     cache_.cache(keys, entries);
  
     for (size_t i=0; i<keys.size(); ++i) {
       // Get the name of the key
       std::string s = keys[i];
       casadi_assert_dev(s.size() > 0);
       // Replace ':' with '_'
       std::replace(s.begin(), s.end(), ':', '_');
       // Remove trailing underscore, if any
       if (s.back() == '_') s.resize(s.size() - 1);
       // Add entry to function return
       ret[s] = entries[i];
     }
  
     return ret;
   }

References casadi::FunctionInternal::cache_.

◆ call()

template<typename M >

void casadi::FunctionInternal::call	(	const std::vector< M > &	arg,
		std::vector< M > &	res,
		bool	always_inline,
		bool	never_inline
	)		const

inherited

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

Definition at line 1622 of file function_internal.hpp.

                                                                            {
     // If all inputs are scalar ...
     if (all_scalar()) {
       // ... and some arguments are matrix-valued with matching dimensions ...
       bool matrix_call = false;
       std::pair<casadi_int, casadi_int> sz;
       for (auto&& a : arg) {
         if (!a.is_scalar() && !a.is_empty()) {
           if (!matrix_call) {
             // Matrix call
             matrix_call = true;
             sz = a.size();
           } else if (a.size()!=sz) {
             // Not same dimensions
             matrix_call = false;
             break;
           }
         }
       }
  
       // ... then, call multiple times
       if (matrix_call) {
         // Start with zeros
         res.resize(n_out_);
         M z = M::zeros(sz);
         for (auto&& a : res) a = z;
         // Call multiple times
         std::vector<M> arg1 = arg, res1;
         for (casadi_int c=0; c<sz.second; ++c) {
           for (casadi_int r=0; r<sz.first; ++r) {
             // Get scalar arguments
             for (casadi_int i=0; i<arg.size(); ++i) {
               if (arg[i].size()==sz) arg1[i] = arg[i](r, c);
             }
             // Call recursively with scalar arguments
             call(arg1, res1, always_inline, never_inline);
             // Get results
             casadi_assert_dev(res.size() == res1.size());
             for (casadi_int i=0; i<res.size(); ++i) res[i](r, c) = res1[i];
           }
         }
         // All elements assigned
         return;
       }
     }
  
     // Check if inputs need to be replaced
     casadi_int npar = 1;
     if (!matching_arg(arg, npar)) {
       return call(replace_arg(arg, npar), res, always_inline, never_inline);
     }
  
     // Call the type-specific method
     call_gen(arg, res, npar, always_inline, never_inline);
   }

References casadi::FunctionInternal::all_scalar(), casadi::FunctionInternal::call_gen(), casadi::FunctionInternal::matching_arg(), casadi::FunctionInternal::n_out_, and casadi::FunctionInternal::replace_arg().

Referenced by casadi::SXFunction::trace_instruction().

◆ call_forward() [1/2]

void casadi::FunctionInternal::call_forward	(	const std::vector< MX > &	arg,
		const std::vector< MX > &	res,
		const std::vector< std::vector< MX > > &	fseed,
		std::vector< std::vector< MX > > &	fsens,
		bool	always_inline,
		bool	never_inline
	)		const

virtualinherited

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

Definition at line 3275 of file function_internal.cpp.

                                                           {
     casadi_assert(!(always_inline && never_inline), "Inconsistent options");
     casadi_assert(!always_inline, "Class " + class_name() +
                           " cannot be inlined in an MX expression");
  
     // Derivative information must be available
     casadi_assert(has_derivative(),
                           "Derivatives cannot be calculated for " + name_);
  
     // Number of directional derivatives
     casadi_int nfwd = fseed.size();
     fsens.resize(nfwd);
  
     // Quick return if no seeds
     if (nfwd==0) return;
  
     // Check if seeds need to have dimensions corrected
     casadi_int npar = 1;
     for (auto&& r : fseed) {
       if (!matching_arg(r, npar)) {
         FunctionInternal::call_forward(arg, res, replace_fseed(fseed, npar),
                                        fsens, always_inline, never_inline);
         return;
       }
     }
  
     // Calculating full Jacobian and then multiplying
     if (fwdViaJac(nfwd)) {
       // Multiply the Jacobian from the right
       std::vector<MX> darg = arg;
       darg.insert(darg.end(), res.begin(), res.end());
       std::vector<MX> J = jacobian()(darg);
       // Join forward seeds
       std::vector<MX> v(nfwd), all_fseed(n_in_);
       for (size_t i = 0; i < n_in_; ++i) {
         for (size_t d = 0; d < nfwd; ++d) v[d] = vec(fseed.at(d).at(i));
         all_fseed[i] = horzcat(v);
       }
       // Calculate forward sensitivities
       std::vector<MX> all_fsens(n_out_);
       std::vector<MX>::const_iterator J_it = J.begin();
       for (size_t oind = 0; oind < n_out_; ++oind) {
         for (size_t iind = 0; iind < n_in_; ++iind) {
           // Add contribution
           MX a = mtimes(*J_it++, all_fseed[iind]);
           all_fsens[oind] = all_fsens[oind].is_empty(true) ? a : all_fsens[oind] + a;
         }
       }
       // Split forward sensitivities
       for (size_t d = 0; d < nfwd; ++d) fsens[d].resize(n_out_);
       for (size_t i = 0; i < n_out_; ++i) {
         v = horzsplit(all_fsens[i]);
         casadi_assert_dev(v.size() == nfwd);
         for (size_t d = 0; d < nfwd; ++d) fsens[d][i] = reshape(v[d], size_out(i));
       }
     } else {
       // Evaluate in batches
       casadi_assert_dev(enable_forward_ || enable_fd_);
       casadi_int max_nfwd = max_num_dir_;
       if (!enable_fd_) {
         while (!has_forward(max_nfwd)) max_nfwd/=2;
       }
       casadi_int offset = 0;
       while (offset<nfwd) {
         // Number of derivatives, in this batch
         casadi_int nfwd_batch = std::min(nfwd-offset, max_nfwd);
  
         // All inputs and seeds
         std::vector<MX> darg;
         darg.reserve(n_in_ + n_out_ + n_in_);
         darg.insert(darg.end(), arg.begin(), arg.end());
         darg.insert(darg.end(), res.begin(), res.end());
         std::vector<MX> v(nfwd_batch);
         for (casadi_int i=0; i<n_in_; ++i) {
           for (casadi_int d=0; d<nfwd_batch; ++d) v[d] = fseed[offset+d][i];
           darg.push_back(horzcat(v));
         }
  
         // Create the evaluation node
         Function dfcn = self().forward(nfwd_batch);
         std::vector<MX> x = dfcn(darg);
  
         casadi_assert_dev(x.size()==n_out_);
  
         // Retrieve sensitivities
         for (casadi_int d=0; d<nfwd_batch; ++d) fsens[offset+d].resize(n_out_);
         for (casadi_int i=0; i<n_out_; ++i) {
           if (size2_out(i)>0) {
             v = horzsplit(x[i], size2_out(i));
             casadi_assert_dev(v.size()==nfwd_batch);
           } else {
             v = std::vector<MX>(nfwd_batch, MX(size_out(i)));
           }
           for (casadi_int d=0; d<nfwd_batch; ++d) fsens[offset+d][i] = v[d];
         }
  
         // Update offset
         offset += nfwd_batch;
       }
     }
   }

Referenced by casadi::Rootfinder::ad_forward(), casadi::Call::ad_forward(), casadi::MXFunction::ad_forward(), casadi::XFunction< DerivedType, MatType, NodeType >::call_forward(), casadi::MX::forward(), casadi::Integrator::get_forward_dae(), and casadi::Scpgen::init().

◆ call_forward() [2/2]

void casadi::FunctionInternal::call_forward	(	const std::vector< SX > &	arg,
		const std::vector< SX > &	res,
		const std::vector< std::vector< SX > > &	fseed,
		std::vector< std::vector< SX > > &	fsens,
		bool	always_inline,
		bool	never_inline
	)		const

virtualinherited

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

Definition at line 3496 of file function_internal.cpp.

                                                           {
     casadi_assert(!(always_inline && never_inline), "Inconsistent options");
     if (fseed.empty()) { // Quick return if no seeds
       fsens.clear();
       return;
     }
     casadi_error("'forward' (SX) not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ call_gen() [1/2]

void casadi::FunctionInternal::call_gen	(	const MXVector &	arg,
		MXVector &	res,
		casadi_int	npar,
		bool	always_inline,
		bool	never_inline
	)		const

inherited

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

Definition at line 4183 of file function_internal.cpp.

                                                         {
     if (npar==1) {
       eval_mx(arg, res, always_inline, never_inline);
     } else {
       // Split it up arguments
       std::vector<std::vector<MX>> v(npar, arg);
       std::vector<MX> t;
       for (int i=0; i<n_in_; ++i) {
         if (arg[i].size2()!=size2_in(i)) {
           t = horzsplit(arg[i], size2_in(i));
           casadi_assert_dev(t.size()==npar);
           for (int p=0; p<npar; ++p) v[p][i] = t[p];
         }
       }
       // Unroll the loop
       for (int p=0; p<npar; ++p) {
         eval_mx(v[p], t, always_inline, never_inline);
         v[p] = t;
       }
       // Concatenate results
       t.resize(npar);
       res.resize(n_out_);
       for (int i=0; i<n_out_; ++i) {
         for (int p=0; p<npar; ++p) t[p] = v[p][i];
         res[i] = horzcat(t);
       }
     }
   }

References casadi::FunctionInternal::eval_mx(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, and casadi::FunctionInternal::size2_in().

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

◆ call_gen() [2/2]

template<typename D >

void casadi::FunctionInternal::call_gen	(	const std::vector< Matrix< D > > &	arg,
		std::vector< Matrix< D > > &	res,
		casadi_int	npar,
		bool	always_inline,
		bool	never_inline
	)		const

inherited

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

Definition at line 1726 of file function_internal.hpp.

                                                                          {
     std::vector< Matrix<D> > arg2 = project_arg(arg, npar);
  
     // Which arguments require mapped evaluation
     std::vector<bool> mapped(n_in_);
     for (casadi_int i=0; i<n_in_; ++i) {
       mapped[i] = arg[i].size2()!=size2_in(i);
     }
  
     // Allocate results
     res.resize(n_out_);
     for (casadi_int i=0; i<n_out_; ++i) {
       if (!res[i].sparsity().is_stacked(sparsity_out(i), npar)) {
         res[i] = Matrix<D>::zeros(repmat(sparsity_out(i), 1, npar));
       }
     }
  
     // Allocate temporary memory if needed
     std::vector<casadi_int> iw_tmp(sz_iw());
     std::vector<D> w_tmp(sz_w());
  
     // Get pointers to input arguments
     std::vector<const D*> argp(sz_arg());
     for (casadi_int i=0; i<n_in_; ++i) argp[i]=get_ptr(arg2[i]);
  
     // Get pointers to output arguments
     std::vector<D*> resp(sz_res());
     for (casadi_int i=0; i<n_out_; ++i) resp[i]=get_ptr(res[i]);
  
     // For all parallel calls
     for (casadi_int p=0; p<npar; ++p) {
       // Call memory-less
       if (eval_gen(get_ptr(argp), get_ptr(resp),
                    get_ptr(iw_tmp), get_ptr(w_tmp), memory(0),
                    always_inline, never_inline)) {
         if (error_on_fail_) casadi_error("Evaluation failed");
       }
       // Update offsets
       if (p==npar-1) break;
       for (casadi_int i=0; i<n_in_; ++i) if (mapped[i]) argp[i] += nnz_in(i);
       for (casadi_int i=0; i<n_out_; ++i) resp[i] += nnz_out(i);
     }
   }

◆ call_reverse() [1/2]

void casadi::FunctionInternal::call_reverse	(	const std::vector< MX > &	arg,
		const std::vector< MX > &	res,
		const std::vector< std::vector< MX > > &	aseed,
		std::vector< std::vector< MX > > &	asens,
		bool	always_inline,
		bool	never_inline
	)		const

virtualinherited

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

Definition at line 3381 of file function_internal.cpp.

                                                           {
     casadi_assert(!(always_inline && never_inline), "Inconsistent options");
     casadi_assert(!always_inline, "Class " + class_name() +
                           " cannot be inlined in an MX expression");
  
     // Derivative information must be available
     casadi_assert(has_derivative(),
                           "Derivatives cannot be calculated for " + name_);
  
     // Number of directional derivatives
     casadi_int nadj = aseed.size();
     asens.resize(nadj);
  
     // Quick return if no seeds
     if (nadj==0) return;
  
     // Check if seeds need to have dimensions corrected
     casadi_int npar = 1;
     for (auto&& r : aseed) {
       if (!matching_res(r, npar)) {
         FunctionInternal::call_reverse(arg, res, replace_aseed(aseed, npar),
                                        asens, always_inline, never_inline);
         return;
       }
     }
  
     // Calculating full Jacobian and then multiplying likely cheaper
     if (adjViaJac(nadj)) {
       // Multiply the transposed Jacobian from the right
       std::vector<MX> darg = arg;
       darg.insert(darg.end(), res.begin(), res.end());
       std::vector<MX> J = jacobian()(darg);
       // Join adjoint seeds
       std::vector<MX> v(nadj), all_aseed(n_out_);
       for (size_t i = 0; i < n_out_; ++i) {
         for (size_t d = 0; d < nadj; ++d) v[d] = vec(aseed.at(d).at(i));
         all_aseed[i] = horzcat(v);
       }
       // Calculate adjoint sensitivities
       std::vector<MX> all_asens(n_in_);
       std::vector<MX>::const_iterator J_it = J.begin();
       for (size_t oind = 0; oind < n_out_; ++oind) {
         for (size_t iind = 0; iind < n_in_; ++iind) {
           // Add contribution
           MX a = mtimes((*J_it++).T(), all_aseed[oind]);
           all_asens[iind] = all_asens[iind].is_empty(true) ? a : all_asens[iind] + a;
         }
       }
       // Split adjoint sensitivities
       for (size_t d = 0; d < nadj; ++d) asens[d].resize(n_in_);
       for (size_t i = 0; i < n_in_; ++i) {
         v = horzsplit(all_asens[i]);
         casadi_assert_dev(v.size() == nadj);
         for (size_t d = 0; d < nadj; ++d) {
           if (asens[d][i].is_empty(true)) {
             asens[d][i] = reshape(v[d], size_in(i));
           } else {
             asens[d][i] += reshape(v[d], size_in(i));
           }
         }
       }
     } else {
       // Evaluate in batches
       casadi_assert_dev(enable_reverse_);
       casadi_int max_nadj = max_num_dir_;
  
       while (!has_reverse(max_nadj)) max_nadj/=2;
       casadi_int offset = 0;
       while (offset<nadj) {
         // Number of derivatives, in this batch
         casadi_int nadj_batch =  std::min(nadj-offset, max_nadj);
  
         // All inputs and seeds
         std::vector<MX> darg;
         darg.reserve(n_in_ + n_out_ + n_out_);
         darg.insert(darg.end(), arg.begin(), arg.end());
         darg.insert(darg.end(), res.begin(), res.end());
         std::vector<MX> v(nadj_batch);
         for (casadi_int i=0; i<n_out_; ++i) {
           for (casadi_int d=0; d<nadj_batch; ++d) v[d] = aseed[offset+d][i];
           darg.push_back(horzcat(v));
         }
  
         // Create the evaluation node
         Function dfcn = self().reverse(nadj_batch);
         std::vector<MX> x = dfcn(darg);
         casadi_assert_dev(x.size()==n_in_);
  
         // Retrieve sensitivities
         for (casadi_int d=0; d<nadj_batch; ++d) asens[offset+d].resize(n_in_);
         for (casadi_int i=0; i<n_in_; ++i) {
           if (size2_in(i)>0) {
             v = horzsplit(x[i], size2_in(i));
             casadi_assert_dev(v.size()==nadj_batch);
           } else {
             v = std::vector<MX>(nadj_batch, MX(size_in(i)));
           }
           for (casadi_int d=0; d<nadj_batch; ++d) {
             if (asens[offset+d][i].is_empty(true)) {
               asens[offset+d][i] = v[d];
             } else {
               asens[offset+d][i] += v[d];
             }
           }
         }
         // Update offset
         offset += nadj_batch;
       }
     }
   }

Referenced by casadi::Rootfinder::ad_reverse(), casadi::MXFunction::ad_reverse(), casadi::Call::ad_reverse(), casadi::XFunction< DerivedType, MatType, NodeType >::call_reverse(), casadi::Scpgen::init(), and casadi::MX::reverse().

◆ call_reverse() [2/2]

void casadi::FunctionInternal::call_reverse	(	const std::vector< SX > &	arg,
		const std::vector< SX > &	res,
		const std::vector< std::vector< SX > > &	aseed,
		std::vector< std::vector< SX > > &	asens,
		bool	always_inline,
		bool	never_inline
	)		const

virtualinherited

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

Definition at line 3509 of file function_internal.cpp.

                                                           {
     casadi_assert(!(always_inline && never_inline), "Inconsistent options");
     if (aseed.empty()) { // Quick return if no seeds
       asens.clear();
       return;
     }
     casadi_error("'reverse' (SX) not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ change_option()

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

overridevirtual

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

Reimplemented from casadi::ProtoFunction.

Definition at line 191 of file fmu_function.cpp.

                                      {
   if (option_name == "print_progress") {
     print_progress_ = option_value;
   } else if (option_name == "step") {
     step_ = option_value;
   } else if (option_name == "fd_method") {
     fd_method_ = option_value.to_string();
     fd_ = to_enum<FdMode>(fd_method_, "forward");
   } else if (option_name == "uses_directional_derivatives") {
     // Set, if permitted
     bool v = option_value;
     if (v) casadi_assert(fmu_.provides_directional_derivatives(),
       "FMU does not provide support for analytic derivatives");
     uses_directional_derivatives_ = v;
   } else if (option_name == "uses_adjoint_derivatives") {
     // Set, if permitted
     bool v = option_value;
     if (v) casadi_assert(fmu_.provides_adjoint_derivatives(),
       "FMU does not provide support for adjoint derivatives");
     uses_adjoint_derivatives_ = v;
   } else if (option_name == "enable_forward_jacobian") {
     enable_forward_jacobian_ = option_value;
   } else if (option_name == "enable_adjoint_hessian") {
     bool v = option_value;
     if (v) casadi_assert(fmu_.provides_adjoint_derivatives(),
       "FMU does not provide support for adjoint derivatives");
     enable_adjoint_hessian_ = v;
   } else if (option_name == "fd_flip") {
     fd_flip_ = option_value;
   } else if (option_name == "make_symmetric") {
     make_symmetric_ = option_value;
   } else if (option_name == "hessian_coloring") {
     bool v = option_value;
     if (v != hessian_coloring_) {
       casadi_assert(!hess_colors_.is_null() && !hess_uni_colors_.is_null(),
         "Can only change Hessian coloring if both colorings are available");
     }
     hessian_coloring_ = v;
   } else {
     // Option not found - continue to base classes
     FunctionInternal::change_option(option_name, option_value);
   }
 }

References casadi::FunctionInternal::change_option(), enable_adjoint_hessian_, enable_forward_jacobian_, fd_, fd_flip_, casadi::FunctionInternal::fd_method_, fmu_, hess_colors_, hess_uni_colors_, hessian_coloring_, casadi::GenericShared< Shared, Internal >::is_null(), make_symmetric_, print_progress_, casadi::Fmu::provides_adjoint_derivatives(), casadi::Fmu::provides_directional_derivatives(), step_, casadi::GenericType::to_string(), uses_adjoint_derivatives_, and uses_directional_derivatives_.

◆ check_arg()

template<typename M >

void casadi::FunctionInternal::check_arg	(	const std::vector< M > &	arg,
		casadi_int &	npar
	)		const

inherited

Raises errors.

Parameters

	npar[in]	normal usage: 1, disallow pararallel calls: -1
[out]	npar	max number of horizontal repetitions across all arguments (or -1)

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

Definition at line 1773 of file function_internal.hpp.

                                                                                   {
     casadi_assert(arg.size()==n_in_, "Incorrect number of inputs: Expected "
                           + str(n_in_) + ", got " + str(arg.size()));
     for (casadi_int i=0; i<n_in_; ++i) {
       if (!check_mat(arg[i].sparsity(), sparsity_in(i), npar)) {
         // Dimensions
         std::string d_arg = str(arg[i].size1()) + "-by-" + str(arg[i].size2());
         std::string d_in = str(size1_in(i)) + "-by-" + str(size2_in(i));
         std::string e = "Input " + str(i) + " (" + name_in_[i] + ") has mismatching shape. "
                      "Got " + d_arg + ". Allowed dimensions, in general, are:\n"
                      " - The input dimension N-by-M (here " + d_in + ")\n"
                      " - A scalar, i.e. 1-by-1\n"
                      " - M-by-N if N=1 or M=1 (i.e. a transposed vector)\n"
                      " - N-by-M1 if K*M1=M for some K (argument repeated horizontally)\n";
         if (npar!=-1) {
           e += " - N-by-P*M, indicating evaluation with multiple arguments (P must be a "
                      "multiple of " + str(npar) + " for consistency with previous inputs)";
         }
         casadi_error(e);
       }
     }
   }

References casadi::FunctionInternal::check_mat(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::size1_in(), casadi::FunctionInternal::size2_in(), casadi::FunctionInternal::sparsity_in(), and casadi::str().

Referenced by casadi::FunctionInternal::mapsum_mx(), and casadi::FunctionInternal::matching_arg().

◆ check_mat()

bool casadi::FunctionInternal::check_mat	(	const Sparsity &	arg,
		const Sparsity &	inp,
		casadi_int &	npar
	)

staticinherited

Helper function

Parameters

npar[in]	normal usage: 1, disallow pararallel calls: -1
npar[out]	required number of parallel calls (or -1)

Definition at line 3707 of file function_internal.cpp.

                                                                                              {
     // Matching dimensions
     if (arg.size()==inp.size()) return true;
     // Calling with a scalar - set all
     if (arg.is_scalar()) return true;
     // Vectors that are transposes of each other
     if (arg.is_vector() && inp.size()==std::make_pair(arg.size2(), arg.size1())) return true;
     // Horizontal repmat
     if (arg.size1()==inp.size1() && arg.size2()>0 && inp.size2()>0
         && inp.size2()%arg.size2()==0) return true;
     // Evaluate with multiple arguments
     if (npar!=-1 && arg.size1()==inp.size1() && arg.size2()>0 && inp.size2()>0
         && arg.size2()%(npar*inp.size2())==0) {
       npar *= arg.size2()/(npar*inp.size2());
       return true;
     }
     // Calling with empty matrix - set all to zero (after the structured branches above,
     // so that a 0-by-N argument can still be recognised as a parallel/repmat call)
     if (arg.is_empty()) return true;
     // No match
     return false;
   }

References casadi::Sparsity::is_empty(), casadi::Sparsity::is_scalar(), casadi::Sparsity::is_vector(), casadi::Sparsity::size(), casadi::Sparsity::size1(), and casadi::Sparsity::size2().

Referenced by casadi::FunctionInternal::check_arg(), casadi::FunctionInternal::check_res(), and casadi::FunctionInternal::mapsum_mx().

◆ check_mem_count()

void casadi::FmuFunction::check_mem_count ( casadi_int n ) const

overridevirtual

Purpose if to allow more helpful error messages

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

Reimplemented from casadi::ProtoFunction.

Definition at line 51 of file fmu_function.cpp.

                                                     {
   if (fmu_.can_be_instantiated_only_once_per_process() && n>1) {
     casadi_error("FMU '" + fmu_.instance_name() + "' [" + fmu_.class_name() + "] "
       "declares 'canBeInstantiatedOnlyOncePerProcess' to be true. "
       "Regenerate your FMU with this option set to false.");
   }
 }

References casadi::Fmu::can_be_instantiated_only_once_per_process(), casadi::SharedObject::class_name(), fmu_, and casadi::Fmu::instance_name().

◆ check_res()

template<typename M >

void casadi::FunctionInternal::check_res	(	const std::vector< M > &	res,
		casadi_int &	npar
	)		const

inherited

Raises errors.

Parameters

	npar[in]	normal usage: 1, disallow pararallel calls: -1
[out]	npar	max number of horizontal repetitions across all arguments (or -1)

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

Definition at line 1797 of file function_internal.hpp.

                                                                                   {
     casadi_assert(res.size()==n_out_, "Incorrect number of outputs: Expected "
                           + str(n_out_) + ", got " + str(res.size()));
     for (casadi_int i=0; i<n_out_; ++i) {
       casadi_assert(check_mat(res[i].sparsity(), sparsity_out(i), npar),
                     "Output " + str(i) + " (" + name_out_[i] + ") has mismatching shape. "
                     "Expected " + str(size_out(i)) + ", got " + str(res[i].size()));
     }
   }

References casadi::FunctionInternal::check_mat(), casadi::FunctionInternal::n_out_, casadi::FunctionInternal::name_out_, casadi::FunctionInternal::size_out(), casadi::FunctionInternal::sparsity_out(), and casadi::str().

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

◆ checkout()

int casadi::ProtoFunction::checkout ( ) const

inherited

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 casadi::ProtoFunction::alloc_mem(), casadi::ProtoFunction::check_mem_count(), and casadi::ProtoFunction::init_mem().

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

◆ class_name()

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

inlineoverridevirtual

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

Implements casadi::SharedObjectInternal.

Definition at line 199 of file fmu_function.hpp.

199 { return "FmuFunction";}

◆ clear_mem()

void casadi::ProtoFunction::clear_mem ( )

inherited

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 casadi::ProtoFunction::free_mem().

◆ codegen()

void casadi::FunctionInternal::codegen	(	CodeGenerator &	g,
		const std::string &	fname
	)		const

inherited

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

Definition at line 2510 of file function_internal.cpp.

                                                                                {
     // Define function
     g << "/* " << definition() << " */\n";
     g << "static " << signature(fname) << " {\n";
  
     // Reset local variables, flush buffer
     g.flush(g.body);
  
     g.scope_enter();
  
     if (dump_in_ || dump_out_) {
       Function F = shared_from_this<Function>();
       std::string cg_name = codegen_name(g, false);
       std::string dump_counter = g.shorthand(cg_name + "_dump_counter");
       g.auxiliaries << "static int " << dump_counter << " = 0;\n";
       if (g.thread_safe()) {
         g.define_local_mutex(F, cg_name + "_dump_mutex");
         std::string dump_mutex = g.local_mutex(F, cg_name + "_dump_mutex");
         g << "CASADI_MUTEX_LOCK(&" << dump_mutex << ");\n";
         g << "int dump_id_local = " << dump_counter << "++;\n";
         g << "CASADI_MUTEX_UNLOCK(&" << dump_mutex << ");\n";
       } else {
         g << "int dump_id_local = " << dump_counter << "++;\n";
       }
     }
  
     if (dump_in_) g.generate_dump(shared_from_this<Function>(), "arg", true);
     if (print_in_) g.generate_print(shared_from_this<Function>(), "arg", true);
  
     // Generate function body (to buffer)
     codegen_body(g);
  
     if (dump_out_) g.generate_dump(shared_from_this<Function>(), "res", false);
     if (print_out_) g.generate_print(shared_from_this<Function>(), "res", false);
  
     g.scope_exit();
  
     // Finalize the function
     g << "return 0;\n";
     g << "}\n\n";
  
     // Flush to function body
     g.flush(g.body);
   }

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_alloc_mem()

void casadi::FunctionInternal::codegen_alloc_mem ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::External.

Definition at line 2654 of file function_internal.cpp.

                                                                  {
     bool needs_mem = codegen_needs_mem();
     if (needs_mem) {
       std::string name = codegen_name(g, false);
       std::string mem_counter = g.shorthand(name + "_mem_counter");
       g << "return " + mem_counter + "++;\n";
     }
   }

References casadi::FunctionInternal::codegen_name(), casadi::FunctionInternal::codegen_needs_mem(), and casadi::CodeGenerator::shorthand().

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_body()

void casadi::FunctionInternal::codegen_body ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::Sqpmethod, casadi::Qrqp, casadi::LinearInterpolantJac, casadi::LinearInterpolant, casadi::Feasiblesqpmethod, casadi::FastNewton, casadi::BSplineInterpolant, casadi::XpressInterface, casadi::UnoInterface, casadi::OsqpInterface, casadi::OnnxRuntimeInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::IpoptInterface, casadi::HpipmInterface, casadi::HighsInterface, casadi::FatropInterface, casadi::DaqpInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, casadi::SXFunction, casadi::Switch, casadi::MXFunction, casadi::MapSum, casadi::ThreadMap, casadi::OmpMap, casadi::Map, casadi::JitFunction, casadi::FiniteDiff, casadi::External, and casadi::BlazingSplineFunction.

Definition at line 3061 of file function_internal.cpp.

                                                             {
     casadi_warning("The function \"" + name_ + "\", which is of type \""
                    + class_name() + "\" cannot be code generated. The generation "
                    "will proceed, but compilation of the code will not be possible.");
     g << "#error Code generation not supported for " << class_name() << "\n";
   }

References casadi::SharedObjectInternal::class_name(), and casadi::ProtoFunction::name_.

Referenced by casadi::FunctionInternal::codegen(), and casadi::BSplineInterpolant::codegen_body().

◆ codegen_checkout()

void casadi::FunctionInternal::codegen_checkout ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::External.

Definition at line 2663 of file function_internal.cpp.

                                                                 {
     std::string name = codegen_name(g, false);
     std::string stack_counter = g.shorthand(name + "_unused_stack_counter");
     std::string stack = g.shorthand(name + "_unused_stack");
     std::string mem_counter = g.shorthand(name + "_mem_counter");
     std::string mem_array = g.shorthand(name + "_mem");
     std::string alloc_mem = g.shorthand(name + "_alloc_mem");
     std::string init_mem = g.shorthand(name + "_init_mem");
  
  
     g.auxiliaries << "static int " << mem_counter  << " = 0;\n";
     g.auxiliaries << "static int " << stack_counter  << " = -1;\n";
     g.auxiliaries << "static int " << stack << "[CASADI_MAX_NUM_THREADS];\n";
     g.auxiliaries << "static " << codegen_mem_type() <<
                " " << mem_array << "[CASADI_MAX_NUM_THREADS];\n\n";
  
     if (g.thread_safe()) {
       Function F = shared_from_this<Function>();
       g.define_local_mutex(F, name + "_mem_mutex");
       std::string mem_mutex = g.local_mutex(F, name + "_mem_mutex");
       g << "CASADI_MUTEX_LOCK(&" << mem_mutex << ");\n";
       g.scope_add_cleanup("CASADI_MUTEX_UNLOCK(&" + mem_mutex + ");\n");
     }
  
     g.local("mid", "int");
  
     g << "if (" << stack_counter << ">=0) {\n";
     g.scope_return(stack + "[" + stack_counter + "--]");
     g << "} else {\n";
     g << "if (" << mem_counter << "==CASADI_MAX_NUM_THREADS) {\n";
     g.scope_return("-1");
     g << "}\n";
     g << "mid = " << alloc_mem << "();\n";
     g << "if (mid<0) {\n";
     g.scope_return("-1");
     g << "}\n";
     g << "if (" << init_mem << "(mid)) {\n";
     g.scope_return("-1");
     g << "}\n";
     g.scope_return("mid");
     g << "}\n";
   }

References casadi::FunctionInternal::alloc_mem(), casadi::CodeGenerator::auxiliaries, casadi::FunctionInternal::codegen_mem_type(), casadi::FunctionInternal::codegen_name(), casadi::CodeGenerator::define_local_mutex(), casadi::ProtoFunction::init_mem(), casadi::CodeGenerator::local(), casadi::CodeGenerator::local_mutex(), casadi::CodeGenerator::scope_add_cleanup(), casadi::CodeGenerator::scope_return(), casadi::CodeGenerator::shorthand(), and casadi::CodeGenerator::thread_safe().

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_declarations()

void casadi::FunctionInternal::codegen_declarations ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::Sqpmethod, casadi::Feasiblesqpmethod, casadi::FastNewton, casadi::BSplineInterpolant, casadi::UnoInterface, casadi::OnnxRuntimeInterface, casadi::MadnlpInterface, casadi::IpoptInterface, casadi::FatropInterface, casadi::MadmpecInterface, casadi::SXFunction, casadi::Switch, casadi::Nlpsol, casadi::MXFunction, casadi::MapSum, casadi::ThreadMap, casadi::Map, casadi::FiniteDiff, and casadi::External.

Definition at line 3057 of file function_internal.cpp.

                                                                     {
     // Nothing to declare
   }

Referenced by casadi::CodeGenerator::add_dependency(), and casadi::BSplineInterpolant::codegen_declarations().

◆ codegen_decref()

void casadi::FunctionInternal::codegen_decref ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::MXFunction, and casadi::External.

Definition at line 2609 of file function_internal.cpp.

                                                               {
  
     // Treat dependent functions
     std::set<void*> added;
     Function F = shared_from_this<Function>();
     for (const Function& f : F.find_functions(0)) {
       if (f->has_refcount_in_deps_) {
         std::string cg_name = f->codegen_name(g, false);
         auto i = added.insert(f.get());
         if (i.second) { // prevent duplicate calls
           std::string decref = g.shorthand(cg_name + "_decref");
           g << decref << "();\n";
         }
       }
     }
  
     if (has_refcount_) {
       std::string name = codegen_name(g, false);
       std::string ref_counter = g.shorthand(name + "_ref_counter");
       std::string mem_counter = g.shorthand(name + "_mem_counter");
       std::string free_mem = g.shorthand(name + "_free_mem");
       g << ref_counter << "--;\n";
       g << "if (" << ref_counter << "==0) {\n";
       if (codegen_needs_mem())  {
         g << "while (" << mem_counter << ">0) {\n";
         g << free_mem << "(--" << mem_counter << ");\n";
         g << "}\n";
       }
       if (g.thread_safe()) {
         Function F = shared_from_this<Function>();
         for (const auto& m : g.local_mutexes(F)) {
           std::string mtx = g.local_mutex(F, m);
           g << "#if CASADI_MUTEX_USE_STATIC_INIT == 0\n";
           g << "CASADI_MUTEX_DESTROY(&" << mtx << ");\n";
           g << "#endif\n";
         }
       }
       g << "}\n";
     }
   }

References casadi::FunctionInternal::codegen_name(), casadi::FunctionInternal::codegen_needs_mem(), casadi::Function::find_functions(), casadi::FunctionInternal::free_mem(), casadi::FunctionInternal::has_refcount_, casadi::CodeGenerator::local_mutex(), casadi::CodeGenerator::local_mutexes(), casadi::CodeGenerator::shorthand(), and casadi::CodeGenerator::thread_safe().

Referenced by casadi::CodeGenerator::add_dependency(), and casadi::MXFunction::codegen_decref().

◆ codegen_free_mem()

virtual void casadi::FunctionInternal::codegen_free_mem ( CodeGenerator & g ) const

inlinevirtualinherited

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

Reimplemented in casadi::XpressInterface, casadi::UnoInterface, casadi::OsqpInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::IpoptInterface, casadi::HighsInterface, casadi::FatropInterface, casadi::DaqpInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, and casadi::External.

Definition at line 888 of file function_internal.hpp.

888 {}

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_incref()

void casadi::FunctionInternal::codegen_incref ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::MXFunction, and casadi::External.

Definition at line 2576 of file function_internal.cpp.

                                                               {
     if (has_refcount_) {
       std::string name = codegen_name(g, false);
       std::string ref_counter = g.shorthand(name + "_ref_counter");
       g.auxiliaries << "static int " << ref_counter  << " = 0;\n";
  
       Function F = shared_from_this<Function>();
       if (g.thread_safe()) {
         for (const auto& m : g.local_mutexes(F)) {
           std::string mtx = g.local_mutex(F, m);
           g << "#if CASADI_MUTEX_USE_STATIC_INIT == 0\n";
           g << "if (" << ref_counter << "==0) CASADI_MUTEX_INIT(&" << mtx << ");\n";
           g << "#endif\n";
         }
       }
       g << ref_counter << "++;\n";
     }
  
     // Treat dependent functions
     std::set<void*> added;
     Function F = shared_from_this<Function>();
     for (const Function& f : F.find_functions(0)) {
       if (f->has_refcount_in_deps_) {
         std::string cg_name = f->codegen_name(g, false);
         auto i = added.insert(f.get());
         if (i.second) { // prevent duplicate calls
           std::string incref = g.shorthand(cg_name + "_incref");
           g << incref << "();\n";
         }
       }
     }
   }

References casadi::CodeGenerator::auxiliaries, casadi::FunctionInternal::codegen_name(), casadi::Function::find_functions(), casadi::FunctionInternal::has_refcount_, casadi::CodeGenerator::local_mutex(), casadi::CodeGenerator::local_mutexes(), casadi::CodeGenerator::shorthand(), and casadi::CodeGenerator::thread_safe().

Referenced by casadi::CodeGenerator::add_dependency(), and casadi::MXFunction::codegen_incref().

◆ codegen_init_mem()

void casadi::FunctionInternal::codegen_init_mem ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::XpressInterface, casadi::UnoInterface, casadi::OsqpInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::IpoptInterface, casadi::HighsInterface, casadi::FatropInterface, casadi::DaqpInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, and casadi::External.

Definition at line 2650 of file function_internal.cpp.

                                                                 {
     g << "return 0;\n";
   }

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_mem()

std::string casadi::FunctionInternal::codegen_mem	(	CodeGenerator &	g,
		const std::string &	index = `"mem"`
	)		const

inherited

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

Definition at line 3051 of file function_internal.cpp.

                                                                                         {
     std::string name = codegen_name(g, false);
     std::string mem_array = g.shorthand(name + "_mem");
     return mem_array+"[" + index + "]";
   }

References casadi::FunctionInternal::codegen_name(), and casadi::CodeGenerator::shorthand().

◆ codegen_mem_is_opaque()

virtual bool casadi::FunctionInternal::codegen_mem_is_opaque ( ) const

inlinevirtualinherited

without a need for alloc_mem, init_mem, free_mem?

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

Reimplemented in casadi::External.

Definition at line 935 of file function_internal.hpp.

935 { return false; }

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_mem_type()

virtual std::string casadi::FunctionInternal::codegen_mem_type ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::Sqpmethod, casadi::XpressInterface, casadi::UnoInterface, casadi::OsqpInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::IpoptInterface, casadi::HighsInterface, casadi::FatropInterface, casadi::DaqpInterface, casadi::ClarabelInterface, and casadi::MadmpecInterface.

Definition at line 923 of file function_internal.hpp.

923 { return ""; }

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

◆ codegen_meta()

void casadi::FunctionInternal::codegen_meta ( CodeGenerator & g ) const

inherited

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

Definition at line 2726 of file function_internal.cpp.

                                                             {
     bool needs_mem = codegen_needs_mem();
     std::string name = codegen_name(g, false);
  
     // Checkout/release routines
     g << g.declare("int " + name_ + "_checkout(void)") << " {\n";
     if (needs_mem) {
       std::string checkout = g.shorthand(name + "_checkout");
       g << "return " << checkout << "();\n";
     } else {
       g << "return 0;\n";
     }
     g << "}\n\n";
  
     if (needs_mem) {
       g << g.declare("void " + name_ + "_release(int mem)") << " {\n";
       std::string release = g.shorthand(name + "_release");
       g << release << "(mem);\n";
     } else {
       g << g.declare("void " + name_ + "_release(int mem)") << " {\n";
     }
     g << "}\n\n";
  
     // Reference counter routines
     g << g.declare("void " + name_ + "_incref(void)") << " {\n";
     if (has_refcount_in_deps_) {
       std::string incref = g.shorthand(name + "_incref");
       g << incref << "();\n";
     }
     g << "}\n\n"
       << g.declare("void " + name_ + "_decref(void)") << " {\n";
     if (has_refcount_in_deps_) {
       std::string decref = g.shorthand(name + "_decref");
       g << decref << "();\n";
     }
     g << "}\n\n";
  
     // Number of inputs and outptus
     g << g.declare("casadi_int " + name_ + "_n_in(void)")
       << " { return " << n_in_ << ";}\n\n"
       << g.declare("casadi_int " + name_ + "_n_out(void)")
       << " { return " << n_out_ << ";}\n\n";
  
     // Default inputs
     g << g.declare("casadi_real " + name_ + "_default_in(casadi_int i)") << " {\n"
       << "switch (i) {\n";
     for (casadi_int i=0; i<n_in_; ++i) {
       double def = get_default_in(i);
       if (def!=0) g << "case " << i << ": return " << g.constant(def) << ";\n";
     }
     g << "default: return 0;\n}\n"
       << "}\n\n";
  
     // Input names
     g << g.declare("const char* " + name_ + "_name_in(casadi_int i)") << " {\n"
       << "switch (i) {\n";
     for (casadi_int i=0; i<n_in_; ++i) {
       g << "case " << i << ": return \"" << name_in_[i] << "\";\n";
     }
     g << "default: return 0;\n}\n"
       << "}\n\n";
  
     // Output names
     g << g.declare("const char* " + name_ + "_name_out(casadi_int i)") << " {\n"
       << "switch (i) {\n";
     for (casadi_int i=0; i<n_out_; ++i) {
       g << "case " << i << ": return \"" << name_out_[i] << "\";\n";
     }
     g << "default: return 0;\n}\n"
       << "}\n\n";
  
     // Codegen sparsities
     codegen_sparsities(g);
  
     // Function that returns work vector lengths
     g << g.declare(
         "int " + name_ + "_work(casadi_int *sz_arg, casadi_int* sz_res, "
         "casadi_int *sz_iw, casadi_int *sz_w)")
       << " {\n"
       << "if (sz_arg) *sz_arg = " << codegen_sz_arg(g) << ";\n"
       << "if (sz_res) *sz_res = " << codegen_sz_res(g) << ";\n"
       << "if (sz_iw) *sz_iw = " << codegen_sz_iw(g) << ";\n"
       << "if (sz_w) *sz_w = " << codegen_sz_w(g) << ";\n"
       << "return 0;\n"
       << "}\n\n";
  
     // Function that returns work vector lengths in bytes
     g << g.declare(
         "int " + name_ + "_work_bytes(casadi_int *sz_arg, casadi_int* sz_res, "
         "casadi_int *sz_iw, casadi_int *sz_w)")
       << " {\n"
       << "if (sz_arg) *sz_arg = " << codegen_sz_arg(g) << "*sizeof(const casadi_real*);\n"
       << "if (sz_res) *sz_res = " << codegen_sz_res(g) << "*sizeof(casadi_real*);\n"
       << "if (sz_iw) *sz_iw = " << codegen_sz_iw(g) << "*sizeof(casadi_int);\n"
       << "if (sz_w) *sz_w = " << codegen_sz_w(g) << "*sizeof(casadi_real);\n"
       << "return 0;\n"
       << "}\n\n";
  
     // Also add to header file to allow getting
      if (g.with_header) {
       g.header
         << "#define " << name_ << "_SZ_ARG " << codegen_sz_arg(g) << "\n"
         << "#define " << name_ << "_SZ_RES " << codegen_sz_res(g) << "\n"
         << "#define " << name_ << "_SZ_IW " << codegen_sz_iw(g) << "\n"
         << "#define " << name_ << "_SZ_W " << codegen_sz_w(g) << "\n";
      }
  
     // Which inputs are differentiable
     if (!all(is_diff_in_)) {
       g << g.declare("int " + name_ + "_diff_in(casadi_int i)") << " {\n"
         << "switch (i) {\n";
       for (casadi_int i=0; i<n_in_; ++i) {
         g << "case " << i << ": return " << is_diff_in_[i] << ";\n";
       }
       g << "default: return -1;\n}\n"
         << "}\n\n";
     }
  
     // Which outputs are differentiable
     if (!all(is_diff_out_)) {
       g << g.declare("int " + name_ + "_diff_out(casadi_int i)") << " {\n"
         << "switch (i) {\n";
       for (casadi_int i=0; i<n_out_; ++i) {
         g << "case " << i << ": return " << is_diff_out_[i] << ";\n";
       }
       g << "default: return -1;\n}\n"
         << "}\n\n";
     }
  
     // Generate mex gateway for the function
     if (g.mex) {
       // Begin conditional compilation
       g << "#ifdef MATLAB_MEX_FILE\n";
  
       // Declare wrapper
       g << "void mex_" << name_
         << "(int resc, mxArray *resv[], int argc, const mxArray *argv[]) {\n"
         << "casadi_int i;\n";
       g << "int mem;\n";
       // Work vectors, including input and output buffers
       casadi_int i_nnz = nnz_in(), o_nnz = nnz_out();
       size_t sz_w = this->sz_w();
       for (casadi_int i=0; i<n_in_; ++i) {
         const Sparsity& s = sparsity_in_[i];
         sz_w = std::max(sz_w, static_cast<size_t>(s.size1())); // To be able to copy a column
         sz_w = std::max(sz_w, static_cast<size_t>(s.size2())); // To be able to copy a row
       }
       sz_w += i_nnz + o_nnz;
       g << CodeGenerator::array("casadi_real", "w", sz_w);
       g << CodeGenerator::array("casadi_int", "iw", sz_iw());
       std::string fw = "w+" + str(i_nnz + o_nnz);
  
       // Copy inputs to buffers
       casadi_int offset=0;
       g << CodeGenerator::array("const casadi_real*", "arg", sz_arg(), "{0}");
  
       // Allocate output buffers
       g << "casadi_real* res[" << sz_res() << "] = {0};\n";
  
       // Check arguments
       g << "if (argc>" << n_in_ << ") mexErrMsgIdAndTxt(\"Casadi:RuntimeError\","
         << "\"Evaluation of \\\"" << name_ << "\\\" failed. Too many input arguments "
         << "(%d, max " << n_in_ << ")\", argc);\n";
  
       g << "if (resc>" << n_out_ << ") mexErrMsgIdAndTxt(\"Casadi:RuntimeError\","
         << "\"Evaluation of \\\"" << name_ << "\\\" failed. "
         << "Too many output arguments (%d, max " << n_out_ << ")\", resc);\n";
  
       for (casadi_int i=0; i<n_in_; ++i) {
         std::string p = "argv[" + str(i) + "]";
         g << "if (--argc>=0) arg[" << i << "] = "
           << g.from_mex(p, "w", offset, sparsity_in_[i], fw) << "\n";
         offset += nnz_in(i);
       }
  
       for (casadi_int i=0; i<n_out_; ++i) {
         if (i==0) {
           // if i==0, always store output (possibly ans output)
           g << "--resc;\n";
         } else {
           // Store output, if it exists
           g << "if (--resc>=0) ";
         }
         // Create and get pointer
         g << g.res(i) << " = w+" << str(offset) << ";\n";
         offset += nnz_out(i);
       }
       g << name_ << "_incref();\n";
       g << "mem = " << name_ << "_checkout();\n";
  
       // Call the function
       g << "i = " << name_ << "(arg, res, iw, " << fw << ", mem);\n"
         << "if (i) mexErrMsgIdAndTxt(\"Casadi:RuntimeError\",\"Evaluation of \\\"" << name_
         << "\\\" failed.\");\n";
       g << name_ << "_release(mem);\n";
       g << name_ << "_decref();\n";
  
       // Save results
       for (casadi_int i=0; i<n_out_; ++i) {
         g << "if (" << g.res(i) << ") resv[" << i << "] = "
           << g.to_mex(sparsity_out_[i], g.res(i)) << "\n";
       }
  
       // End conditional compilation and function
       g << "}\n"
         << "#endif\n\n";
     }
  
     if (g.main) {
       // Declare wrapper
       g << "casadi_int main_" << name_ << "(casadi_int argc, char* argv[]) {\n";
  
       g << "casadi_int j;\n";
       g << "casadi_real* a;\n";
       g << "const casadi_real* r;\n";
       g << "casadi_int flag;\n";
       if (needs_mem) g << "int mem;\n";
  
  
  
       // Work vectors and input and output buffers
       size_t nr = sz_w() + nnz_in() + nnz_out();
       g << CodeGenerator::array("casadi_int", "iw", sz_iw())
         << CodeGenerator::array("casadi_real", "w", nr);
  
       // Input buffers
       g << "const casadi_real* arg[" << sz_arg() << "];\n";
  
       // Output buffers
       g << "casadi_real* res[" << sz_res() << "];\n";
  
       casadi_int off=0;
       for (casadi_int i=0; i<n_in_; ++i) {
         g << "arg[" << i << "] = w+" << off << ";\n";
         off += nnz_in(i);
       }
       for (casadi_int i=0; i<n_out_; ++i) {
         g << "res[" << i << "] = w+" << off << ";\n";
         off += nnz_out(i);
       }
  
       // TODO(@jaeandersson): Read inputs from file. For now; read from stdin
       g << "a = w;\n"
         << "for (j=0; j<" << nnz_in() << "; ++j) "
         << "if (scanf(\"%lg\", a++)<=0) return 2;\n";
  
       if (has_refcount_in_deps_) {
         g << name_ << "_incref();\n";
       }
  
       if (needs_mem) {
         g << "mem = " << name_ << "_checkout();\n";
       }
  
       // Call the function
       g << "flag = " << name_ << "(arg, res, iw, w+" << off << ", ";
       if (needs_mem) {
         g << "mem";
       } else {
         g << "0";
       }
       g << ");\n";
       if (needs_mem) {
         g << name_ << "_release(mem);\n";
       }
  
       if (has_refcount_in_deps_) {
         g << name_ << "_decref();\n";
       }
  
       g << "if (flag) return flag;\n";
  
       // TODO(@jaeandersson): Write outputs to file. For now: print to stdout
       g << "r = w+" << nnz_in() << ";\n"
         << "for (j=0; j<" << nnz_out() << "; ++j) "
         << g.printf("%.16e ", "*r++") << "\n";
  
       // End with newline
       g << g.printf("\\n") << "\n";
  
       // Finalize function
       g << "return 0;\n"
         << "}\n\n";
     }
  
     if (g.with_mem) {
       // Allocate memory
       g << g.declare("casadi_functions* " + name_ + "_functions(void)") << " {\n"
         << "static casadi_functions fun = {\n"
         << name_ << "_incref,\n"
         << name_ << "_decref,\n"
         << name_ << "_checkout,\n"
         << name_ << "_release,\n"
         << name_ << "_default_in,\n"
         << name_ << "_n_in,\n"
         << name_ << "_n_out,\n"
         << name_ << "_name_in,\n"
         << name_ << "_name_out,\n"
         << name_ << "_sparsity_in,\n"
         << name_ << "_sparsity_out,\n"
         << name_ << "_work,\n"
         << name_ << "\n"
         << "};\n"
         << "return &fun;\n"
         << "}\n";
     }
     // Flush
     g.flush(g.body);
   }

Referenced by casadi::CodeGenerator::add().

◆ codegen_name()

std::string casadi::FunctionInternal::codegen_name	(	const CodeGenerator &	g,
		bool	ns = `true`
	)		const

virtualinherited

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

Definition at line 3036 of file function_internal.cpp.

                                                                                 {
     if (ns) {
       // Get the index of the function
       for (auto&& e : g.added_functions_) {
         if (e.f.get()==this) return e.codegen_name;
       }
     } else {
       for (casadi_int i=0;i<g.added_functions_.size();++i) {
         const auto & e = g.added_functions_[i];
         if (e.f.get()==this) return "f" + str(i);
       }
     }
     casadi_error("Function '" + name_ + "' not found");
   }

References casadi::CodeGenerator::added_functions_, casadi::ProtoFunction::name_, and casadi::str().

Referenced by casadi::FunctionInternal::codegen(), casadi::FunctionInternal::codegen_alloc_mem(), casadi::FatropInterface::codegen_body(), casadi::FunctionInternal::codegen_checkout(), casadi::FunctionInternal::codegen_decref(), casadi::FunctionInternal::codegen_incref(), casadi::FunctionInternal::codegen_mem(), casadi::FunctionInternal::codegen_meta(), casadi::FunctionInternal::codegen_release(), casadi::CodeGenerator::mem(), and casadi::CodeGenerator::operator()().

◆ codegen_needs_mem()

virtual bool casadi::FunctionInternal::codegen_needs_mem ( ) const

inlinevirtualinherited

◆ codegen_release()

void casadi::FunctionInternal::codegen_release ( CodeGenerator & g ) const

virtualinherited

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

Reimplemented in casadi::External.

Definition at line 2706 of file function_internal.cpp.

                                                                {
     std::string name = codegen_name(g, false);
     std::string stack_counter = g.shorthand(name + "_unused_stack_counter");
     std::string stack = g.shorthand(name + "_unused_stack");
  
     if (g.thread_safe()) {
       Function F = shared_from_this<Function>();
       std::string mem_mutex = g.local_mutex(F, name + "_mem_mutex");
       g << "CASADI_MUTEX_LOCK(&" << mem_mutex << ");\n";
       g.scope_add_cleanup("CASADI_MUTEX_UNLOCK(&" + mem_mutex + ");\n");
     }
  
     g << stack << "[++" << stack_counter << "] = mem;\n";
     g.scope_return();
   }

References casadi::FunctionInternal::codegen_name(), casadi::CodeGenerator::local_mutex(), casadi::CodeGenerator::scope_add_cleanup(), casadi::CodeGenerator::scope_return(), casadi::CodeGenerator::shorthand(), and casadi::CodeGenerator::thread_safe().

Referenced by casadi::CodeGenerator::add_dependency().

◆ codegen_sparsities()

void casadi::FunctionInternal::codegen_sparsities ( CodeGenerator & g ) const

inherited

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

Definition at line 2722 of file function_internal.cpp.

                                                                   {
     g.add_io_sparsities(name_, sparsity_in_, sparsity_out_);
   }

References casadi::CodeGenerator::add_io_sparsities(), casadi::ProtoFunction::name_, casadi::FunctionInternal::sparsity_in_, and casadi::FunctionInternal::sparsity_out_.

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

◆ codegen_sz_arg()

size_t casadi::FunctionInternal::codegen_sz_arg ( const CodeGenerator & g ) const

virtualinherited

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

Definition at line 3158 of file function_internal.cpp.

                                                                       {
     return sz_arg();
   }

References casadi::FunctionInternal::sz_arg().

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

◆ codegen_sz_iw()

size_t casadi::FunctionInternal::codegen_sz_iw ( const CodeGenerator & g ) const

virtualinherited

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

Definition at line 3164 of file function_internal.cpp.

                                                                      {
     return sz_iw();
   }

References casadi::FunctionInternal::sz_iw().

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

◆ codegen_sz_res()

size_t casadi::FunctionInternal::codegen_sz_res ( const CodeGenerator & g ) const

virtualinherited

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

Definition at line 3161 of file function_internal.cpp.

                                                                       {
     return sz_res();
   }

References casadi::FunctionInternal::sz_res().

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

◆ codegen_sz_w()

size_t casadi::FunctionInternal::codegen_sz_w ( const CodeGenerator & g ) const

virtualinherited

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

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

Definition at line 3167 of file function_internal.cpp.

                                                                     {
     return sz_w();
   }

References casadi::FunctionInternal::sz_w().

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

◆ construct()

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

inherited

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(), casadi::ProtoFunction::finalize(), casadi::ProtoFunction::get_options(), casadi::ProtoFunction::init(), casadi::Options::is_sane(), casadi::ProtoFunction::name_, and casadi::Options::sanitize().

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

◆ convert_arg() [1/2]

template<typename M >

std::vector< M > casadi::FunctionInternal::convert_arg ( const std::map< std::string, M > & arg ) const

inherited

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

Definition at line 1899 of file function_internal.hpp.

                                                      {
     // Get default inputs
     std::vector<M> arg_v(n_in_);
     for (casadi_int i=0; i<arg_v.size(); ++i) {
       arg_v[i] = get_default_in(i);
     }
  
     // Assign provided inputs
     for (auto&& e : arg) {
       arg_v.at(index_in(e.first)) = e.second;
     }
  
     return arg_v;
   }

References casadi::FunctionInternal::get_default_in(), casadi::FunctionInternal::index_in(), and casadi::FunctionInternal::n_in_.

◆ convert_arg() [2/2]

template<typename M >

std::map< std::string, M > casadi::FunctionInternal::convert_arg ( const std::vector< M > & arg ) const

inherited

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

Definition at line 1887 of file function_internal.hpp.

                                              {
     casadi_assert(arg.size()==n_in_, "Incorrect number of inputs: Expected "
                       + str(n_in_) + ", got " + str(arg.size()));
     std::map<std::string, M> ret;
     for (casadi_int i=0;i<n_in_;++i) {
       ret[name_in_[i]] = arg[i];
     }
     return ret;
   }

References casadi::FunctionInternal::n_in_, casadi::FunctionInternal::name_in_, and casadi::str().

◆ convert_res() [1/2]

template<typename M >

std::vector< M > casadi::FunctionInternal::convert_res ( const std::map< std::string, M > & res ) const

inherited

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

Definition at line 1928 of file function_internal.hpp.

                                                      {
     // Get default inputs
     std::vector<M> res_v(n_out_);
     for (casadi_int i=0; i<res_v.size(); ++i) {
       res_v[i] = std::numeric_limits<double>::quiet_NaN();
     }
  
     // Assign provided inputs
     for (auto&& e : res) {
       M a = e.second;
       res_v.at(index_out(e.first)) = a;
     }
     return res_v;
   }

References casadi::FunctionInternal::index_out(), and casadi::FunctionInternal::n_out_.

◆ convert_res() [2/2]

template<typename M >

std::map< std::string, M > casadi::FunctionInternal::convert_res ( const std::vector< M > & res ) const

inherited

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

Definition at line 1916 of file function_internal.hpp.

                                              {
     casadi_assert(res.size()==n_out_, "Incorrect number of outputs: Expected "
                       + str(n_out_) + ", got " + str(res.size()));
     std::map<std::string, M> ret;
     for (casadi_int i=0;i<n_out_;++i) {
       ret[name_out_[i]] = res[i];
     }
     return ret;
   }

References casadi::FunctionInternal::n_out_, casadi::FunctionInternal::name_out_, and casadi::str().

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

◆ definition()

std::string casadi::FunctionInternal::definition ( ) const

inherited

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

Definition at line 1134 of file function_internal.cpp.

                                                {
     std::stringstream s;
  
     // Print name
     s << name_ << ":(";
     // Print input arguments
     for (casadi_int i=0; i<n_in_; ++i) {
       if (!is_diff_in_.empty() && !is_diff_in_[i]) s << "#";
       s << name_in_[i] << sparsity_in_[i].postfix_dim() << (i==n_in_-1 ? "" : ",");
     }
     s << ")->(";
     // Print output arguments
     for (casadi_int i=0; i<n_out_; ++i) {
       if (!is_diff_out_.empty() && !is_diff_out_[i]) s << "#";
       s << name_out_[i] << sparsity_out_[i].postfix_dim() << (i==n_out_-1 ? "" : ",");
     }
     s << ")";
  
     return s.str();
   }

References casadi::FunctionInternal::is_diff_in_, casadi::FunctionInternal::is_diff_out_, casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, casadi::ProtoFunction::name_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::name_out_, casadi::FunctionInternal::sparsity_in_, and casadi::FunctionInternal::sparsity_out_.

Referenced by casadi::FunctionInternal::codegen(), casadi::FunctionInternal::disp(), casadi::MXFunction::should_inline(), and casadi::SXFunction::should_inline().

◆ deserialize()

static ProtoFunction* casadi::FmuFunction::deserialize ( DeserializingStream & s )

inlinestatic

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

Definition at line 362 of file fmu_function.hpp.

362 { return new FmuFunction(s); }

casadi::FmuFunction::FmuFunction

FmuFunction(const std::string &name, const Fmu &fmu, const std::vector< std::string > &name_in, const std::vector< std::string > &name_out)

Constructor.

Definition: fmu_function.cpp:115

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

◆ diff_prefix()

std::string casadi::FunctionInternal::diff_prefix ( const std::string & prefix ) const

inherited

Definition at line 2242 of file function_internal.cpp.

                                                                        {
     // Highest index found in current inputs and outputs
     casadi_int highest_index = 0;
     // Loop over both input names and output names
     for (const std::vector<std::string>& name_io : {name_in_, name_out_}) {
       for (const std::string& n : name_io) {
         // Find end of prefix, skip if no prefix
         size_t end = n.find('_');
         if (end >= n.size()) continue;
         // Skip if too short
         if (end < prefix.size()) continue;
         // Skip if wrong prefix
         if (n.compare(0, prefix.size(), prefix) != 0) continue;
         // Beginning of index
         size_t begin = prefix.size();
         // Check if any index
         casadi_int this_index;
         if (begin == end) {
           // No prefix, implicitly 1
           this_index = 1;
         } else {
           // Read index from string
           this_index = std::stoi(n.substr(begin, end - begin));
         }
         // Find the highest index
         if (this_index > highest_index) highest_index = this_index;
       }
     }
     // Return one higher index
     if (highest_index == 0) {
       return prefix + "_";
     } else {
       return prefix + std::to_string(highest_index + 1) + "_";
     }
   }

References casadi::FunctionInternal::name_in_, and casadi::FunctionInternal::name_out_.

Referenced by casadi::FunctionInternal::forward(), casadi::OnnxFunction::get_forward(), casadi::OnnxFunction::get_reverse(), casadi::OnnxFunction::has_derivative(), and casadi::FunctionInternal::reverse().

◆ disp()

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

overridevirtualinherited

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

Implements casadi::SharedObjectInternal.

Definition at line 1155 of file function_internal.cpp.

                                                                  {
     stream << definition() << " " << class_name();
     if (more) {
       stream << std::endl;
       disp_more(stream);
     }
   }

References casadi::SharedObjectInternal::class_name(), casadi::FunctionInternal::definition(), and casadi::FunctionInternal::disp_more().

Referenced by casadi::MXFunction::eval(), and casadi::SXFunction::eval().

◆ disp_more()

virtual void casadi::FunctionInternal::disp_more ( std::ostream & stream ) const

inlinevirtualinherited

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

Reimplemented in casadi::SXFunction, casadi::Switch, casadi::Nlpsol, and casadi::MXFunction.

Definition at line 981 of file function_internal.hpp.

981 {}

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

◆ dm_in() [1/2]

const std::vector< DM > casadi::FunctionInternal::dm_in ( ) const

inherited

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

Definition at line 3576 of file function_internal.cpp.

                                                     {
     std::vector<DM> ret(n_in_);
     for (casadi_int i=0; i<ret.size(); ++i) {
       ret[i] = dm_in(i);
     }
     return ret;
   }

References casadi::FunctionInternal::n_in_.

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

◆ dm_in() [2/2]

const DM casadi::FunctionInternal::dm_in ( casadi_int ind ) const

inherited

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

Definition at line 3552 of file function_internal.cpp.

                                                        {
     return DM::zeros(sparsity_in(ind));
   }

References casadi::FunctionInternal::sparsity_in(), and casadi::GenericMatrix< MatType >::zeros().

◆ dm_out() [1/2]

const std::vector< DM > casadi::FunctionInternal::dm_out ( ) const

inherited

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

Definition at line 3584 of file function_internal.cpp.

                                                      {
     std::vector<DM> ret(n_out_);
     for (casadi_int i=0; i<ret.size(); ++i) {
       ret[i] = dm_out(i);
     }
     return ret;
   }

References casadi::FunctionInternal::n_out_.

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

◆ dm_out() [2/2]

const DM casadi::FunctionInternal::dm_out ( casadi_int ind ) const

inherited

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

Definition at line 3556 of file function_internal.cpp.

                                                         {
     return DM::zeros(sparsity_out(ind));
   }

References casadi::FunctionInternal::sparsity_out(), and casadi::GenericMatrix< MatType >::zeros().

◆ ensure_stacked()

template<typename MatType >

MatType casadi::FunctionInternal::ensure_stacked	(	const MatType &	v,
		const Sparsity &	sp,
		casadi_int	n
	)

staticinherited

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

Definition at line 1945 of file function_internal.hpp.

                                                                                              {
     // Check dimensions
     if (v.size1() == sp.size1() && v.size2() == n * sp.size2()) {
       // Ensure that sparsity is a horizontal multiple of original input, or has no entries
       if (v.nnz() != 0 && !v.sparsity().is_stacked(sp, n)) {
         return project(v, repmat(sp, 1, n));
       }
     } else {
       // Correct empty sparsity
       casadi_assert_dev(v.is_empty());
       return MatType(sp.size1(), sp.size2() * n);
     }
     // No correction needed
     return v;
   }

References casadi::Sparsity::size1(), and casadi::Sparsity::size2().

◆ eval()

int casadi::FmuFunction::eval	(	const double **	arg,
		double **	res,
		casadi_int *	iw,
		double *	w,
		void *	mem
	)		const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 944 of file fmu_function.cpp.

                      {
   // Get memory struct
   FmuMemory* m = static_cast<FmuMemory*>(mem);
   casadi_assert(m != nullptr, "Memory is null");
   setup(mem, arg, res, iw, w);
   // Reset timers
   m->n_get_all = m->n_get_directional = m->n_get_adjoint = 0;
   m->t_get_all = m->t_get_directional = m->t_get_adjoint = 0;
   // What blocks are there?
   bool need_jac = false, need_fwd = false, need_adj = false, need_hess = false;
   for (size_t k = 0; k < out_.size(); ++k) {
     if (res[k]) {
       switch (out_[k].type) {
         case OutputType::JAC:
         case OutputType::JAC_TRANS:
           need_jac = true;
           break;
         case OutputType::FWD:
           need_fwd = true;
           break;
         case OutputType::ADJ:
           need_adj = true;
           break;
         case OutputType::HESS:
           need_adj = true;
           need_hess = true;
           break;
         default:
           break;
       }
     }
   }
   // Work vectors, shared between threads
   double *aseed = nullptr, *asens = nullptr, *jac_nz = nullptr, *hess_nz = nullptr;
   if (need_jac) {
     // Jacobian nonzeros, initialize to NaN
     jac_nz = w; w += jac_sp_.nnz();
     std::fill(jac_nz, jac_nz + jac_sp_.nnz(), casadi::nan);
   }
   if (need_adj) {
     // Set up vectors
     aseed = w; w += nadj_ * fmu_.n_out();
     asens = w; w += nadj_ * fmu_.n_in();
     // Clear seed/sensitivity vectors
     std::fill(aseed, aseed + nadj_ * fmu_.n_out(), 0);
     std::fill(asens, asens + nadj_ * fmu_.n_in(), 0);
     // Copy adjoint seeds to aseed
     for (size_t i = 0; i < in_.size(); ++i) {
       if (arg[i] && in_[i].type == InputType::ADJ) {
         const std::vector<size_t>& oind = fmu_.ored(in_[i].ind);
         for (casadi_int d = 0; d < nadj_; ++d) {
           size_t aseed_off = d * fmu_.n_out();
           size_t off = d * size1_in(i);
           for (size_t k = 0; k < oind.size(); ++k) aseed[oind[k] + aseed_off] = arg[i][k + off];
         }
       }
     }
   }
   if (need_hess) {
     // Hessian nonzeros, initialize to NaN
     hess_nz = w; w += hess_sp_.nnz();
     std::fill(hess_nz, hess_nz + hess_sp_.nnz(), casadi::nan);
   }
   // Setup memory for threads
   for (casadi_int task = 0; task < max_n_tasks_; ++task) {
     FmuMemory* s = task == 0 ? m : m->slaves.at(task - 1);
     // Shared memory
     s->arg = arg;
     s->res = res;
     s->aseed = aseed;
     s->asens = asens;
     s->jac_nz = jac_nz;
     s->hess_nz = hess_nz;
     // Thread specific memory
     casadi_jac_init(&jac_prob_, &s->jac_data, &iw, &w);
     if (task < max_hess_tasks_) {
       // Perturbed adjoint sensitivities
       s->pert_asens = w;
       w += fmu_.n_in();
     }
     if (enable_adjoint_jacobian_) {
       // Memory for Jacobian calculation via adjoint mode AD
       casadi_jac_init(&adj_prob_, &s->adj_data, &iw, &w);
     }
   }
   // Evaluate everything except Hessian, possibly in parallel
   if (print_progress_) {
     casadi_message("Evaluating regular outputs, forward sens, extended Jacobian");
   }
   if (eval_all(m, max_jac_tasks_, true, need_jac, need_fwd, need_adj, false)) return 1;
   // Post-process Jacobian
   if (need_jac && !enable_forward_jacobian_) {
     // Copy transpose nonzeros to work vector
     casadi_copy(jac_nz, adj_sp_.nnz(), w);
     // Calculate transpose, store in jac_nz
     casadi_trans(w, adj_sp_, jac_nz, jac_sp_, iw);
   }
   // Evaluate Hessian
   if (need_hess) {
     if (print_progress_) casadi_message("Evaluating extended Hessian");
     if (eval_all(m, max_hess_tasks_, false, false, false, false, true)) return 1;
     // Post-process Hessian
     finalize_hessian(m, hess_nz, iw);
   }
   // Fetch calculated blocks
   for (size_t k = 0; k < out_.size(); ++k) {
     // Get nonzeros, skip if not needed
     double* r = res[k];
     if (!r) continue;
     // Get by type
     switch (out_[k].type) {
       case OutputType::JAC:
         casadi_get_sub(r, jac_sp_, jac_nz,
           out_[k].rbegin, out_[k].rend, out_[k].cbegin, out_[k].cend);
         break;
       case OutputType::JAC_TRANS:
         casadi_get_sub(w, jac_sp_, jac_nz,
           out_[k].rbegin, out_[k].rend, out_[k].cbegin, out_[k].cend);
         casadi_trans(w, sp_trans_[sp_trans_map_[k]], r, sparsity_out(k), iw);
         break;
       case OutputType::ADJ:
         // If adjoint sensitivities have not already been set
         for (casadi_int d = 0; d < nadj_; ++d) {
           size_t asens_off = d * fmu_.n_in();
           for (size_t id : fmu_.ired(out_[k].wrt)) *r++ = asens[id + asens_off];
         }
         break;
       case OutputType::HESS:
         casadi_get_sub(r, hess_sp_, hess_nz,
           out_[k].rbegin, out_[k].rend, out_[k].cbegin, out_[k].cend);
         break;
       default:
         break;
     }
   }
   // Successful return
   return 0;
 }

◆ eval_activity()

int casadi::FunctionInternal::eval_activity	(	const bvec_t **	arg,
		bvec_t **	res,
		casadi_int *	iw,
		bvec_t *	w,
		void *	mem
	)		const

virtualinherited

bvec bit set = active (possibly nonzero), clear = inactive (definitely zero). Unlike sp_forward (a dependency analysis), this respects multiplicative annihilation and nonzero constants. Default is the sound fallback: all active.

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

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

Definition at line 3073 of file function_internal.cpp.

                                                                                               {
     // Sound fallback: we cannot prove any output zero, so mark everything active
     for (casadi_int oind=0; oind<n_out_; ++oind) {
       if (res[oind]==nullptr) continue;
       std::fill_n(res[oind], nnz_out(oind), ~static_cast<bvec_t>(0));
     }
     return 0;
   }

References casadi::FunctionInternal::n_out_, and casadi::FunctionInternal::nnz_out().

◆ eval_all()

int casadi::FmuFunction::eval_all	(	FmuMemory *	m,
		casadi_int	n_task,
		bool	need_nondiff,
		bool	need_jac,
		bool	need_fwd,
		bool	need_adj,
		bool	need_hess
	)		const

Definition at line 1084 of file fmu_function.cpp.

                                                                                           {
   // Return flag
   int flag = 0;
   // Evaluate, serially or in parallel
   if (parallelization_ == Parallelization::SERIAL || n_task == 1
       || (!need_jac && !need_adj && !need_hess)) {
     // Evaluate serially
     flag = eval_task(m, 0, 1, need_nondiff, need_jac, need_fwd, need_adj, need_hess);
   } else if (parallelization_ == Parallelization::OPENMP) {
     #ifdef WITH_OPENMP
     // Parallel region
     #pragma omp parallel reduction(||:flag)
     {
       // Get thread number
       casadi_int task = omp_get_thread_num();
       // Get number of threads in region
       casadi_int num_threads = omp_get_num_threads();
       // Number of threads that are actually used
       casadi_int num_used_threads = std::min(num_threads, n_task);
       // Evaluate in parallel
       if (task < num_used_threads) {
         FmuMemory* s = task == 0 ? m : m->slaves.at(task - 1);
         flag = eval_task(s, task, num_used_threads, need_nondiff && task == 0,
           need_jac, need_fwd && task < nfwd_, need_adj, need_hess);
       } else {
         // Nothing to do for thread
         flag = 0;
       }
     }
     #else   // WITH_OPENMP
     flag = 1;
     #endif  // WITH_OPENMP
   } else if (parallelization_ == Parallelization::THREAD) {
     #ifdef CASADI_WITH_THREAD
     // Return value for each thread
     std::vector<int> flag_task(n_task);
     // Spawn threads
     std::vector<std::thread> threads;
     for (casadi_int task = 0; task < n_task; ++task) {
       threads.emplace_back(
         [&, task](int* fl) {
           FmuMemory* s = task == 0 ? m : m->slaves.at(task - 1);
           *fl = eval_task(s, task, n_task, need_nondiff && task == 0,
             need_jac, need_fwd && task < nfwd_, need_adj, need_hess);
         }, &flag_task[task]);
     }
     // Join threads
     for (auto&& th : threads) th.join();
     // Join return flags
     for (int fl : flag_task) flag = flag || fl;
     #else   // CASADI_WITH_THREAD
     flag = 1;
     #endif  // CASADI_WITH_THREAD
   } else {
     casadi_error("Unknown parallelization: " + to_string(parallelization_));
   }
   // Return combined error flag
   return flag;
 }

References eval_task(), nfwd_, casadi::OPENMP, parallelization_, casadi::SERIAL, casadi::FmuMemory::slaves, casadi::THREAD, and casadi::to_string().

Referenced by eval().

◆ eval_dm()

std::vector< DM > casadi::FunctionInternal::eval_dm ( const std::vector< DM > & arg ) const

virtualinherited

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

Reimplemented in casadi::CallbackInternal.

Definition at line 2225 of file function_internal.cpp.

                                                                         {
     casadi_error("'eval_dm' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

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

◆ eval_gen() [1/3]

int casadi::FunctionInternal::eval_gen	(	const bvec_t **	arg,
		bvec_t **	res,
		casadi_int *	iw,
		bvec_t *	w,
		void *	mem,
		bool	always_inline,
		bool	never_inline
	)		const

inlineinherited

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

Definition at line 448 of file function_internal.hpp.

                                                      {
       return sp_forward(arg, res, iw, w, mem);
     }

◆ eval_gen() [2/3]

int casadi::FunctionInternal::eval_gen	(	const double **	arg,
		double **	res,
		casadi_int *	iw,
		double *	w,
		void *	mem,
		bool	always_inline,
		bool	never_inline
	)		const

inherited

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

Definition at line 1022 of file function_internal.cpp.

                                                    {
     casadi_int dump_id = (dump_in_ || dump_out_ || dump_) ? get_dump_id() : -1;
     if (dump_in_) dump_in(dump_id, arg);
     if (dump_ && dump_id==0) dump();
     if (print_in_) print_in(uout(), arg, false);
     auto *m = static_cast<FunctionMemory*>(mem);
  
     // Avoid memory corruption
     for (casadi_int i=0;i<n_in_;++i) {
       casadi_assert(arg[i]==nullptr || arg[i]+nnz_in(i)<=w || arg[i]>=w+sz_w(),
         "Memory corruption detected for input " + name_in_[i] + ".\n"+
         "arg[" + str(i) + "] " + str(arg[i]) + "-" + str(arg[i]+nnz_in(i)) +
         " intersects with w " + str(w)+"-"+str(w+sz_w())+".");
     }
     for (casadi_int i=0;i<n_out_;++i) {
       casadi_assert(res[i]==nullptr || res[i]+nnz_out(i)<=w || res[i]>=w+sz_w(),
         "Memory corruption detected for output " + name_out_[i]);
     }
     // Reset statistics
     for (auto&& s : m->fstats) s.second.reset();
     if (m->t_total) m->t_total->tic();
     m->dump_id = dump_id;
     int ret;
     if (eval_) {
       auto *m = static_cast<FunctionMemory*>(mem);
       m->stats_available = true;
       int mem_ = 0;
       if (checkout_) {
 #ifdef CASADI_WITH_THREAD
     std::lock_guard<std::mutex> lock(mtx_);
 #endif //CASADI_WITH_THREAD
         mem_ = checkout_();
       }
       ret = eval_(arg, res, iw, w, mem_);
       if (release_) {
 #ifdef CASADI_WITH_THREAD
     std::lock_guard<std::mutex> lock(mtx_);
 #endif //CASADI_WITH_THREAD
         release_(mem_);
       }
     } else {
       ret = eval(arg, res, iw, w, mem);
     }
     if (m->t_total) m->t_total->toc();
     // Show statistics
     print_time(m->fstats);
  
     if (dump_out_) dump_out(dump_id, res);
     if (print_out_) print_out(uout(), res, false);
     // Check all outputs for NaNs
     if (regularity_check_) {
       for (casadi_int i = 0; i < n_out_; ++i) {
         // Skip of not calculated
         if (!res[i]) continue;
         // Loop over nonzeros
         casadi_int nnz = this->nnz_out(i);
         for (casadi_int nz = 0; nz < nnz; ++nz) {
           if (isnan(res[i][nz]) || isinf(res[i][nz])) {
             // Throw readable error message
             casadi_error(str(res[i][nz]) + " detected for output " + name_out_[i] + " at "
               + sparsity_out(i).repr_el(nz));
           }
         }
       }
     }
     return ret;
   }

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

◆ eval_gen() [3/3]

int casadi::FunctionInternal::eval_gen	(	const SXElem **	arg,
		SXElem **	res,
		casadi_int *	iw,
		SXElem *	w,
		void *	mem,
		bool	always_inline,
		bool	never_inline
	)		const

inlineinherited

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

Definition at line 444 of file function_internal.hpp.

                                                      {
       return eval_sx(arg, res, iw, w, mem, always_inline, never_inline);
     }

◆ eval_mx()

void casadi::FunctionInternal::eval_mx	(	const MXVector &	arg,
		MXVector &	res,
		bool	always_inline,
		bool	never_inline
	)		const

virtualinherited

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

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

Definition at line 2444 of file function_internal.cpp.

                                                                               {
  
     always_inline = always_inline || always_inline_;
     never_inline = never_inline || never_inline_;
  
     // The code below creates a call node, to inline, wrap in an MXFunction
     if (always_inline) {
       casadi_assert(!never_inline, "Inconsistent options for " + str(name_));
       wrap().call(arg, res, true);
       return;
     }
  
     // Create a call-node
     res = Call::create(self(), arg);
   }

References casadi::FunctionInternal::always_inline_, casadi::Function::call(), casadi::Call::create(), casadi::ProtoFunction::name_, casadi::FunctionInternal::never_inline_, casadi::str(), and casadi::FunctionInternal::wrap().

Referenced by casadi::FunctionInternal::call_gen(), casadi::MXFunction::eval_mx(), and casadi::SXFunction::eval_mx().

◆ eval_sx()

int casadi::FunctionInternal::eval_sx	(	const SXElem **	arg,
		SXElem **	res,
		casadi_int *	iw,
		SXElem *	w,
		void *	mem,
		bool	always_inline,
		bool	never_inline
	)		const

virtualinherited

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

Reimplemented in casadi::SXFunction, casadi::Switch, casadi::MXFunction, casadi::MapSum, and casadi::Map.

Definition at line 2229 of file function_internal.cpp.

                                                  {
  
     always_inline = always_inline || always_inline_;
     never_inline = never_inline || never_inline_;
  
     casadi_assert(!always_inline, "'eval_sx' not defined for " + class_name() +
     " in combination with always_inline true");
  
     return CallSX::eval_sx(self(), arg, res);
   }

References casadi::FunctionInternal::always_inline_, casadi::SharedObjectInternal::class_name(), casadi::CallSX::eval_sx(), and casadi::FunctionInternal::never_inline_.

Referenced by casadi::MXFunction::eval_sx(), and casadi::SXFunction::eval_sx().

◆ eval_task()

int casadi::FmuFunction::eval_task	(	FmuMemory *	m,
		casadi_int	task,
		casadi_int	n_task,
		bool	need_nondiff,
		bool	need_jac,
		bool	need_fwd,
		bool	need_adj,
		bool	need_hess
	)		const

Definition at line 1145 of file fmu_function.cpp.

                                                                                           {
   // Pass all regular inputs
   for (size_t k = 0; k < in_.size(); ++k) {
     if (in_[k].type == InputType::REG) {
       fmu_.set(m, in_[k].ind, m->arg[k]);
     }
   }
   // Request all regular outputs to be evaluated
   for (size_t k = 0; k < out_.size(); ++k) {
     if (m->res[k] && out_[k].type == OutputType::REG) {
       fmu_.request(m, out_[k].ind);
     }
   }
   // Evaluate
   if (fmu_.eval(m)) return 1;
   // Get regular outputs (master thread only)
   if (need_nondiff) {
     for (size_t k = 0; k < out_.size(); ++k) {
       if (m->res[k] && out_[k].type == OutputType::REG) {
         fmu_.get(m, out_[k].ind, m->res[k]);
       }
     }
   }
   // Forward derivatives
   if (need_fwd) {
     // Selection of forward derivatives to be evaluated for the thread
     casadi_int d_begin = (task * nfwd_) / n_task;
     casadi_int d_end = ((task + 1) * nfwd_) / n_task;
     // Loop over forward derivatives
     for (casadi_int d = d_begin; d < d_end; ++d) {
       // Print progress
       if (print_progress_) print("Forward sensitivities, thread %d/%d: Direction %d/%d\n",
         task + 1, n_task, d - d_begin + 1, d_end - d_begin);
       // Pass all forward seeds
       for (size_t k = 0; k < in_.size(); ++k) {
         if (m->arg[k] && in_[k].type == InputType::FWD) {
           fmu_.set_fwd(m, in_[k].ind, m->arg[k] + d * size1_in(k));
         }
       }
       // Request forward sensitivities
       for (size_t k = 0; k < out_.size(); ++k) {
         if (m->res[k] && out_[k].type == OutputType::FWD) {
           fmu_.request_fwd(m, out_[k].ind);
         }
       }
       // Calculate derivatives
       if (fmu_.eval_fwd(m, false)) return 1;
       // Collect forward sensitivities
       for (size_t k = 0; k < out_.size(); ++k) {
         if (m->res[k] && out_[k].type == OutputType::FWD) {
           fmu_.get_fwd(m, out_[k].ind, m->res[k] + d * size1_out(k));
         }
       }
     }
   }
   // Evalute extended Jacobian and/or adjoint derivatives
   if (need_jac || (need_adj && !uses_adjoint_derivatives_)) {
     if (enable_forward_jacobian_) {
       // Forward Jacobian calculation, possibly with coloring
       // Selection of colors to be evaluated for the thread
       casadi_int c_begin = (task * jac_colors_.size2()) / n_task;
       casadi_int c_end = ((task + 1) * jac_colors_.size2()) / n_task;
       // Loop over colors
       for (casadi_int c = c_begin; c < c_end; ++c) {
         // Print progress
         if (print_progress_) print("Jacobian calculation, thread %d/%d: Seeding variable %d/%d\n",
           task + 1, n_task, c - c_begin + 1, c_end - c_begin);
         // Get derivative directions
         casadi_jac_pre(&jac_prob_, &m->jac_data, c);
         // Calculate derivatives
         fmu_.set_fwd(m, m->jac_data.nseed, m->jac_data.iseed, m->jac_data.seed);
         fmu_.request_fwd(m, m->jac_data.nsens, m->jac_data.isens, m->jac_data.wrt);
         if (fmu_.eval_fwd(m, true)) return 1;
         fmu_.get_fwd(m, m->jac_data.nsens, m->jac_data.isens, m->jac_data.sens);
         // Scale derivatives
         casadi_jac_scale(&jac_prob_, &m->jac_data);
         // Collect Jacobian nonzeros
         if (need_jac) {
           for (casadi_int i = 0; i < m->jac_data.nsens; ++i) {
             m->jac_nz[m->jac_data.nzind[i]] = m->jac_data.sens[i];
           }
         }
         // Propagate adjoint sensitivities
         if (need_adj) {
           for (casadi_int d = 0; d < nadj_; ++d) {
             size_t aseed_off = d * fmu_.n_out();
             size_t asens_off = d * fmu_.n_in();
             for (casadi_int i = 0; i < m->jac_data.nsens; ++i) {
               m->asens[m->jac_data.wrt[i] + asens_off] += m->aseed[m->jac_data.isens[i] + aseed_off]
                 * m->jac_data.sens[i];
             }
           }
         }
       }
     } else {
       // Use adjoint mode
       casadi_assert(enable_adjoint_jacobian_, "Inconsistent options");
       casadi_assert(need_jac, "Inconsistent options");
       // Selection of colors to be evaluated for the thread
       casadi_int c_begin = (task * adj_colors_.size2()) / n_task;
       casadi_int c_end = ((task + 1) * adj_colors_.size2()) / n_task;
       // Loop over colors
       for (casadi_int c = c_begin; c < c_end; ++c) {
         // Print progress
         if (print_progress_) print("Jacobian calculation via adjoint mode, thread %d/%d: "
           "Seeding variable %d/%d\n", task + 1, n_task, c - c_begin + 1, c_end - c_begin);
         // Get derivative directions
         casadi_jac_pre(&adj_prob_, &m->adj_data, c);
         // Calculate derivatives
         fmu_.set_adj(m, m->adj_data.nseed, m->adj_data.iseed, m->adj_data.seed);
         fmu_.request_adj(m, m->adj_data.nsens, m->adj_data.isens, m->adj_data.wrt);
         if (fmu_.eval_adj(m)) return 1;
         fmu_.get_adj(m, m->adj_data.nsens, m->adj_data.isens, m->adj_data.sens);
         // Scale derivatives
         // casadi_jac_scale(&adj_prob_, &m->adj_data);  // can be skipped since factors are 1
         // Collect Jacobian nonzeros
         for (casadi_int i = 0; i < m->adj_data.nsens; ++i) {
           m->jac_nz[m->adj_data.nzind[i]] = m->adj_data.sens[i];
         }
       }
     }
   } else if (need_adj) { // Adjoint derivatives, without forming the extended Jacobian
     // Selection of forward derivatives to be evaluated for the thread
     casadi_int d_begin = (task * nadj_) / n_task;
     casadi_int d_end = ((task + 1) * nadj_) / n_task;
     // Loop over forward derivatives
     for (casadi_int d = d_begin; d < d_end; ++d) {
       // Print progress
       if (print_progress_) print("Adjoint sensitivities, thread %d/%d: Direction %d/%d\n",
         task + 1, n_task, d - d_begin + 1, d_end - d_begin);
       // Pass all adjoint seeds
       for (size_t k = 0; k < in_.size(); ++k) {
         if (m->arg[k] && in_[k].type == InputType::ADJ) {
           fmu_.set_adj(m, in_[k].ind, m->arg[k] + d * size1_in(k));
         }
       }
       // Request adjoint sensitivities
       casadi_int wrt_id = -1;
       for (casadi_int id : jac_in_) {
         fmu_.request_adj(m, 1, &id, &wrt_id);
       }
       // Calculate derivatives
       if (fmu_.eval_adj(m)) return 1;
       // Collect adjoint sensitivities
       for (casadi_int id : jac_in_) {
         fmu_.get_adj(m, 1, &id, &m->asens[id]);
       }
     }
   }
   // Evaluate extended Hessian
   if (need_hess) {
     // Hessian coloring
     const casadi::Sparsity& hc = hessian_coloring_ ? hess_colors_ : hess_uni_colors_;
     casadi_int n_hc = hc.size2();
     const casadi_int *hc_colind = hc.colind(), *hc_row = hc.row();
     // Hessian sparsity
     const casadi_int *hess_colind = hess_sp_.colind(), *hess_row = hess_sp_.row();
     // Selection of colors to be evaluated for the thread
     casadi_int c_begin = (task * n_hc) / n_task;
     casadi_int c_end = ((task + 1) * n_hc) / n_task;
     // Unperturbed values, step size
     std::vector<double> x, h;
     // Loop over colors
     for (casadi_int c = c_begin; c < c_end; ++c) {
       // Print progress
       if (print_progress_) print("Hessian calculation, thread %d/%d: Seeding variable %d/%d\n",
         task + 1, n_task, c - c_begin + 1, c_end - c_begin);
       // Variables being seeded
       casadi_int v_begin = hc_colind[c];
       casadi_int v_end = hc_colind[c + 1];
       casadi_int nv = v_end - v_begin;
       // Loop over variables being seeded for color
       x.resize(nv);
       h.resize(nv);
       for (casadi_int v = 0; v < nv; ++v) {
         // Corresponding input in Fmu
         casadi_int ind1 = hc_row[v_begin + v];
         casadi_int id = jac_in_.at(ind1);
         // Get unperturbed value
         x[v] = m->ibuf_.at(id);
         // Step size
         h[v] = m->self.step_ * fmu_.nominal_in(id);
         // Make sure that (forward) step remains in bounds
         if (x[v] + h[v] > fmu_.max_in(id)) {
           // Flip sign?
           if (fd_flip_ && x[v] - h[v] > fmu_.min_in(id)) {
             // Take reverse step instead?
             h[v] = -h[v];
           } else {
             // Perturbation not permitted
             h[v] = casadi::nan;
           }
         }
         // Perturb the input, unless not permitted
         if (!std::isnan(h[v])) {
           m->ibuf_.at(id) += h[v];
           m->imarked_.at(id) = true;
           // Inverse of step size
           h[v] = 1. / h[v];
         }
       }
       // Request all outputs
       for (size_t i : jac_out_) {
         m->omarked_.at(i) = true;
         m->wrt_.at(i) = -1;
       }
       // Calculate perturbed inputs
       if (fmu_.eval(m)) return 1;
       // Clear perturbed adjoint sensitivities
       std::fill(m->pert_asens, m->pert_asens + fmu_.n_in(), 0);
       // Calculate perturbed adjoints
       if (enable_adjoint_hessian_) {
         // Pass all adjoint seeds
         for (size_t k = 0; k < in_.size(); ++k) {
           if (m->arg[k] && in_[k].type == InputType::ADJ) {
             fmu_.set_adj(m, in_[k].ind, m->arg[k]);
           }
         }
         // Request adjoint sensitivities
         casadi_int wrt_id = -1;
         for (casadi_int id : jac_in_) {
           fmu_.request_adj(m, 1, &id, &wrt_id);
         }
         // Calculate derivatives
         if (fmu_.eval_adj(m)) return 1;
         // Collect adjoint sensitivities
         for (casadi_int id : jac_in_) {
           fmu_.get_adj(m, 1, &id, &m->pert_asens[id]);
         }
       } else {
         // Loop over colors of the Jacobian
         for (casadi_int c1 = 0; c1 < jac_colors_.size2(); ++c1) {
         // Get derivative directions
         casadi_jac_pre(&jac_prob_, &m->jac_data, c1);
         // Calculate derivatives
         fmu_.set_fwd(m, m->jac_data.nseed, m->jac_data.iseed, m->jac_data.seed);
         fmu_.request_fwd(m, m->jac_data.nsens, m->jac_data.isens, m->jac_data.wrt);
         if (fmu_.eval_fwd(m, true)) return 1;
         fmu_.get_fwd(m, m->jac_data.nsens, m->jac_data.isens, m->jac_data.sens);
         // Scale derivatives
         casadi_jac_scale(&jac_prob_, &m->jac_data);
         // Propagate adjoint sensitivities
         for (casadi_int i = 0; i < m->jac_data.nsens; ++i)
           m->pert_asens[m->jac_data.wrt[i]] += m->aseed[m->jac_data.isens[i]] * m->jac_data.sens[i];
         }
       }
       // Loop over variables being seeded for color
       for (casadi_int v = 0; v < nv; ++v) {
         // Corresponding input in Fmu
         casadi_int ind1 = hc_row[v_begin + v];
         casadi_int id = jac_in_.at(ind1);
         // Restore input
         m->ibuf_.at(id) = x[v];
         m->imarked_.at(id) = true;
         // Get column in Hessian
         for (casadi_int k = hess_colind[ind1]; k < hess_colind[ind1 + 1]; ++k) {
           // Save Hessian entry, unless not applicable to color
           if (!hessian_coloring_ || which_hess_color_[k] == c) {
             if (std::isnan(h[v])) {
               // Perturbation was not permitted
               m->hess_nz[k] = casadi::nan;
             } else {
               // Get Hessian nonzeros
               casadi_int id2 = jac_in_.at(hess_row[k]);
               m->hess_nz[k] = h[v] * (m->pert_asens[id2] - m->asens[id2]);
             }
           }
         }
       }
     }
   }
   // Successful return
   return 0;
 }

Referenced by eval_all().

◆ export_code()

void casadi::FunctionInternal::export_code	(	const std::string &	lang,
		std::ostream &	stream,
		const Dict &	options
	)		const

virtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, and casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >.

Definition at line 2404 of file function_internal.cpp.

                                  {
     casadi_error("'export_code' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ factory()

Function casadi::FmuFunction::factory	(	const std::string &	name,
		const std::vector< std::string > &	s_in,
		const std::vector< std::string > &	s_out,
		const Function::AuxOut &	aux,
		const Dict &	opts
	)		const

overridevirtual

Reimplemented from casadi::FunctionInternal.

Definition at line 1558 of file fmu_function.cpp.

                             {
   // Assume we can call constructor directly
   try {
     // Hack: Inherit parallelization, verbosity option
     Dict opts1 = opts;
     opts1["parallelization"] = to_string(parallelization_);
     opts1["verbose"] = verbose_;
     opts1["print_progress"] = print_progress_;
     // Replace ':' with '_' in s_in and s_out
     std::vector<std::string> s_in_mod = s_in, s_out_mod = s_out;
     for (std::string& s : s_in_mod) std::replace(s.begin(), s.end(), ':', '_');
     for (std::string& s : s_out_mod) std::replace(s.begin(), s.end(), ':', '_');
     // New instance of the same class, using the same Fmu instance
     Function ret;
     ret.own(new FmuFunction(name, fmu_, s_in_mod, s_out_mod));
     ret->construct(opts1);
     return ret;
   } catch (std::exception& e) {
     casadi_warning("FmuFunction::factory call for constructing " + name + " from " + name_
       + " failed:\n" + std::string(e.what()) + "\nFalling back to base class implementation");
   }
   // Fall back to base class
   return FunctionInternal::factory(name, s_in, s_out, aux, opts);
 }

References casadi::ProtoFunction::construct(), casadi::FunctionInternal::factory(), fmu_, FmuFunction(), casadi::ProtoFunction::name_, casadi::GenericShared< Shared, Internal >::own(), parallelization_, print_progress_, casadi::to_string(), and casadi::ProtoFunction::verbose_.

◆ finalize()

void casadi::FunctionInternal::finalize ( )

overridevirtualinherited

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

Reimplemented from casadi::ProtoFunction.

Reimplemented in casadi::PiqpInterface, and casadi::OracleFunction.

Definition at line 732 of file function_internal.cpp.

                                   {
     if (codegen_needs_mem()) has_refcount_ = true;
     if (dump_in_ || dump_out_) has_refcount_ = true;
  
     has_refcount_in_deps_ = has_refcount_;
  
     // Does any embedded function have reference counting for codegen?
     for (const Function& f : shared_from_this<Function>().find_functions(0)) {
       if (f->has_refcount_in_deps_) {
         has_refcount_in_deps_ = true;
         break;
       }
     }
  
     if (jit_) {
       jit_name_ = jit_base_name_;
       jit_directory_ = get_jit_directory(jit_options_);
       if (jit_temp_suffix_) {
         jit_name_ = temporary_file(jit_name_, ".c", jit_directory_);
         jit_name_ = std::string(jit_name_.begin()+jit_directory_.size(),
                                 jit_name_.begin()+jit_name_.size()-2);
       }
       if (has_codegen()) {
         if (compiler_.is_null()) {
           if (verbose_) casadi_message("Codegenerating function '" + name_ + "'.");
           // JIT everything
           Dict opts;
           // Override the default to avoid random strings in the generated code
           opts["prefix"] = "jit";
           CodeGenerator gen(jit_name_, opts);
           gen.add(self());
           if (verbose_) casadi_message("Compiling function '" + name_ + "'..");
           compiler_ = Importer(gen.generate(jit_directory_), compiler_plugin_, jit_options_);
           if (verbose_) casadi_message("Compiling function '" + name_ + "' done.");
         }
         // Try to load
         eval_ = (eval_t) compiler_.get_function(name_);
         checkout_ = (casadi_checkout_t) compiler_.get_function(name_ + "_checkout");
         release_ = (casadi_release_t) compiler_.get_function(name_ + "_release");
         incref_ = (signal_t) compiler_.get_function(name_ + "_incref");
         decref_ = (signal_t) compiler_.get_function(name_ + "_decref");
         casadi_assert(eval_!=nullptr, "Cannot load JIT'ed function.");
         if (incref_) incref_();
       } else {
         // Just jit dependencies
         jit_dependencies(jit_name_);
       }
     }
  
     // Finalize base classes
     ProtoFunction::finalize();
  
     // Dump if requested
     if (dump_) dump();
   }

Referenced by casadi::FunctionInternal::deserialize(), casadi::CallbackInternal::finalize(), casadi::Conic::finalize(), and casadi::OracleFunction::finalize().

◆ finalize_hessian()

void casadi::FmuFunction::finalize_hessian	(	FmuMemory *	m,
		double *	hess_nz,
		casadi_int *	iw
	)		const

Definition at line 1421 of file fmu_function.cpp.

                                                                                       {
   // Get Hessian sparsity pattern
   casadi_int n = hess_sp_.size1();
   const casadi_int *colind = hess_sp_.colind(), *row = hess_sp_.row();
   // Nonzero counters for transpose
   casadi_copy(colind, n, iw);
   // Loop over Hessian columns
   for (casadi_int c = 0; c < n; ++c) {
     // Loop over nonzeros for the column
     for (casadi_int k = colind[c]; k < colind[c + 1]; ++k) {
       // Get row of Hessian
       casadi_int r = row[k];
       // Get nonzero of transpose
       casadi_int k_tr = iw[r]++;
       // Only upper triangular part
       if (r < c) {
         if (hessian_coloring_) {
           // Star-coloring: Only half of the entries were calculated
           if (which_hess_color_[k] < 0) {
             // Use nonzero from lower triangular part
             hess_nz[k] = hess_nz[k_tr];
           } else {
             // Use nonzero from upper triangular part
             hess_nz[k_tr] = hess_nz[k];
           }
         } else {
           // An asymmetric Hessian was calculated, (optionally) make symmetric after (optionally)
           // checking symmetry
           if (validate_hessian_) {
             // Get indices
             casadi_int id_c = jac_in_[c], id_r = jac_in_[r];
             // Nonzero
             double nz = hess_nz[k], nz_tr = hess_nz[k_tr];
             // Check if entry is NaN of inf
             if (std::isnan(nz) || std::isinf(nz)) {
               std::stringstream ss;
               ss << "Second derivative w.r.t. " << fmu_.desc_in(m, id_r) << " and "
                 << fmu_.desc_in(m, id_c) << " is " << nz;
               casadi_warning(ss.str());
             } else if (std::isnan(nz_tr) || std::isinf(nz_tr)) {
               std::stringstream ss;
               ss << "Second derivative w.r.t. " << fmu_.desc_in(m, id_c) << " and "
                 << fmu_.desc_in(m, id_r) << " is " << nz_tr;
               casadi_warning(ss.str());
             } else {
               // Normaliation factor to be used for relative tolerance
               double nz_max = std::fmax(std::fabs(nz), std::fabs(nz_tr));
               // Check if above absolute and relative tolerance bounds
               if (nz_max > abstol_ && std::fabs(nz - nz_tr) > nz_max * reltol_) {
                 std::stringstream ss;
                 ss << "Hessian appears nonsymmetric. Got " << nz << " vs. " << nz_tr
                   << " for second derivative w.r.t. " << fmu_.desc_in(m, id_r) << " and "
                   << fmu_.desc_in(m, id_c) << ", hess_nz = " << k << "/" <<  k_tr;
                 casadi_warning(ss.str());
               }
             }
           }
           // Make Hessian symmetric by averaging the upper and lower triangular parts
           if (make_symmetric_) hess_nz[k] = hess_nz[k_tr] = 0.5 * (hess_nz[k] + hess_nz[k_tr]);
         }
       }
     }
   }
 }

References abstol_, casadi::casadi_copy(), casadi::Sparsity::colind(), casadi::Fmu::desc_in(), fmu_, hess_sp_, hessian_coloring_, jac_in_, make_symmetric_, reltol_, casadi::Sparsity::row(), casadi::Sparsity::size1(), validate_hessian_, and which_hess_color_.

Referenced by eval().

◆ find()

void casadi::FunctionInternal::find	(	std::map< FunctionInternal *, std::pair< Function, size_t > > &	all_fun,
		casadi_int	max_depth
	)		const

virtualinherited

Reimplemented in casadi::BSplineInterpolant, casadi::SXFunction, casadi::Switch, casadi::OracleFunction, casadi::MXFunction, casadi::MapSum, and casadi::Map.

Definition at line 3976 of file function_internal.cpp.

                                 {
     for (auto&& f : registered_functions_) {
       add_embedded(all_fun, f, max_depth);
     }
   }

References casadi::FunctionInternal::add_embedded(), and casadi::FunctionInternal::registered_functions_.

Referenced by casadi::FunctionInternal::add_embedded(), casadi::blazing_spline(), casadi::Map::find(), casadi::MapSum::find(), casadi::MXFunction::find(), casadi::OracleFunction::find(), casadi::Switch::find(), casadi::SXFunction::find(), casadi::BSplineInterpolant::find(), casadi::FunctionInternal::from_compact(), and casadi::FunctionInternal::to_compact().

◆ finish_trace()

void casadi::FunctionInternal::finish_trace	(	std::ostream &	trace,
		double **	res,
		int	ret
	)		const

protectedinherited

Definition at line 868 of file function_internal.cpp.

                                                                {
     if (ret == 0) {
       trace << "{\"event\":\"outputs\",\"values\":[";
       for (casadi_int i = 0; i < n_out_; ++i) {
         if (i) trace << ",";
         trace_values(trace, res[i], nnz_out(i));
       }
       trace << "]}\n";
     }
     trace << "{\"event\":\"end\",\"status\":" << ret << "}\n";
     trace.flush();
     casadi_assert(trace.good(), "Failed to write dump_trace for '" + name_ + "'");
   }

References casadi::FunctionInternal::n_out_, casadi::ProtoFunction::name_, casadi::FunctionInternal::nnz_out(), and casadi::FunctionInternal::trace_values().

Referenced by casadi::MXFunction::eval(), and casadi::SXFunction::eval().

◆ format_time()

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

inherited

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 casadi::ProtoFunction::sprint().

Referenced by casadi::ProtoFunction::print_time().

◆ forward()

Function casadi::FunctionInternal::forward ( casadi_int nfwd ) const

inherited

forward(nfwd) returns a cached instance if available, and calls Function get_forward(casadi_int nfwd) if no cached version is available.

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

Definition at line 2278 of file function_internal.cpp.

                                                           {
     casadi_assert_dev(nfwd>=0);
     // Used wrapped function if forward not available
     if (!enable_forward_ && !enable_fd_) {
       // Derivative information must be available
       casadi_assert(has_derivative(), "Derivatives cannot be calculated for " + name_);
       return wrap().forward(nfwd);
     }
     // Retrieve/generate cached
     Function f;
     std::string fname = forward_name(name_, nfwd);
     if (!incache(fname, f)) {
       casadi_int i;
       // Prefix to be used for forward seeds, sensitivities
       std::string pref = diff_prefix("fwd");
       // Names of inputs
       std::vector<std::string> inames;
       for (i=0; i<n_in_; ++i) inames.push_back(name_in_[i]);
       for (i=0; i<n_out_; ++i) inames.push_back("out_" + name_out_[i]);
       for (i=0; i<n_in_; ++i) inames.push_back(pref + name_in_[i]);
       // Names of outputs
       std::vector<std::string> onames;
       for (i=0; i<n_out_; ++i) onames.push_back(pref + name_out_[i]);
       // Options
       Dict opts = combine(forward_options_, der_options_);
       if (enable_forward_) {
         opts = combine(opts, generate_options("forward"));
       } else {
         opts = combine(opts, FunctionInternal::generate_options("forward"));
       }
       opts["derivative_of"] = self();
       // Generate derivative function
       casadi_assert_dev(enable_forward_ || enable_fd_);
       if (enable_forward_) {
         f = get_forward(nfwd, fname, inames, onames, opts);
       } else {
         opts = combine(opts, fd_options_);
         // Get FD method
         if (fd_method_.empty() || fd_method_=="central") {
           f = Function::create(new CentralDiff(fname, nfwd), opts);
         } else if (fd_method_=="forward") {
           f = Function::create(new ForwardDiff(fname, nfwd), opts);
         } else if (fd_method_=="backward") {
           f = Function::create(new BackwardDiff(fname, nfwd), opts);
         } else if (fd_method_=="smoothing") {
           f = Function::create(new Smoothing(fname, nfwd), opts);
         } else {
           casadi_error("Unknown 'fd_method': " + fd_method_);
         }
       }
       // Consistency check for inputs
       casadi_assert_dev(f.n_in()==n_in_ + n_out_ + n_in_);
       casadi_int ind=0;
       for (i=0; i<n_in_; ++i) f.assert_size_in(ind++, size1_in(i), size2_in(i));
       for (i=0; i<n_out_; ++i) f.assert_size_in(ind++, size1_out(i), size2_out(i));
       for (i=0; i<n_in_; ++i) f.assert_size_in(ind++, size1_in(i), nfwd*size2_in(i));
       // Consistency check for outputs
       casadi_assert_dev(f.n_out()==n_out_);
       for (i=0; i<n_out_; ++i) f.assert_sparsity_out(i, sparsity_out(i), nfwd);
       // Save to cache
       tocache_if_missing(f);
     }
     return f;
   }

Referenced by casadi::FunctionInternal::call_forward(), and casadi::Function::forward().

◆ forward_name()

static std::string casadi::FunctionInternal::forward_name	(	const std::string &	fcn,
		casadi_int	nfwd
	)

inlinestaticinherited

Definition at line 651 of file function_internal.hpp.

                                                                          {
       return "fwd" + str(nfwd) + "_" + fcn;
     }

References casadi::str().

◆ free_mem()

void casadi::FmuFunction::free_mem ( void * mem ) const

overridevirtual

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

Reimplemented from casadi::ProtoFunction.

Definition at line 91 of file fmu_function.cpp.

                                           {
   // Consistency check
   casadi_assert(mem != nullptr, "Memory is null");
   FmuMemory* m = static_cast<FmuMemory*>(mem);
   // Free slave memory
   for (FmuMemory*& s : m->slaves) {
     if (!s) continue;
     // Free FMU memory
     if (s->instance) {
       fmu_.free_instance(s->instance);
       s->instance = nullptr;
     }
     // Free the slave
     fmu_.free_mem(s);
   }
   // Free FMI memory
   if (m->instance) {
     fmu_.free_instance(m->instance);
     m->instance = nullptr;
   }
   // Free the memory object
   fmu_.free_mem(m);
 }

References fmu_, casadi::Fmu::free_instance(), casadi::Fmu::free_mem(), casadi::FmuMemory::instance, and casadi::FmuMemory::slaves.

◆ free_mx()

std::vector< MX > casadi::FunctionInternal::free_mx ( ) const

virtualinherited

Reimplemented in casadi::MXFunction.

Definition at line 3624 of file function_internal.cpp.

                                                 {
     casadi_error("'free_mx' only defined for 'MXFunction'");
   }

◆ free_sx()

std::vector< SX > casadi::FunctionInternal::free_sx ( ) const

virtualinherited

Reimplemented in casadi::SXFunction.

Definition at line 3628 of file function_internal.cpp.

                                                 {
     casadi_error("'free_sx' only defined for 'SXFunction'");
   }

◆ from_compact()

Sparsity casadi::FunctionInternal::from_compact	(	casadi_int	oind,
		casadi_int	iind,
		const Sparsity &	sp
	)		const

inherited

Definition at line 2043 of file function_internal.cpp.

                                 {
     // Return value
     Sparsity r = sp;
     // Insert rows if sparse output
     if (numel_out(oind) != r.size1()) {
       casadi_assert_dev(r.size1() == nnz_out(oind));
       r.enlargeRows(numel_out(oind), sparsity_out(oind).find());
     }
     // Insert columns if sparse input
     if (numel_in(iind) != r.size2()) {
       casadi_assert_dev(r.size2() == nnz_in(iind));
       r.enlargeColumns(numel_in(iind), sparsity_in(iind).find());
     }
     // Return non-compact pattern
     return r;
   }

References casadi::Sparsity::enlargeColumns(), casadi::Sparsity::enlargeRows(), casadi::FunctionInternal::find(), casadi::FunctionInternal::nnz_in(), casadi::FunctionInternal::nnz_out(), casadi::FunctionInternal::numel_in(), casadi::FunctionInternal::numel_out(), casadi::Sparsity::size1(), casadi::Sparsity::size2(), casadi::FunctionInternal::sparsity_in(), and casadi::FunctionInternal::sparsity_out().

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

◆ fwd_seed()

template<typename MatType >

std::vector< std::vector< MatType > > casadi::FunctionInternal::fwd_seed ( casadi_int nfwd ) const

inherited

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

Definition at line 1582 of file function_internal.hpp.

                                   {
     std::vector<std::vector<MatType>> fseed(nfwd);
     for (casadi_int dir=0; dir<nfwd; ++dir) {
       fseed[dir].resize(n_in_);
       for (casadi_int iind=0; iind<n_in_; ++iind) {
         std::string n = "f" + str(dir) + "_" +  name_in_[iind];
         Sparsity sp = is_diff_in_[iind] ? sparsity_in(iind) : Sparsity(size_in(iind));
         fseed[dir][iind] = MatType::sym(n, sp);
       }
     }
     return fseed;
   }

References casadi::FunctionInternal::is_diff_in_, casadi::FunctionInternal::n_in_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::size_in(), casadi::FunctionInternal::sparsity_in(), and casadi::str().

◆ fwdViaJac()

bool casadi::FunctionInternal::fwdViaJac ( casadi_int nfwd ) const

virtualinherited

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

Definition at line 3239 of file function_internal.cpp.

                                                         {
     if (!enable_forward_ && !enable_fd_) return true;
     if (jac_penalty_==-1) return false;
  
     // Heuristic 1: Jac calculated via forward mode likely cheaper
     if (jac_penalty_*static_cast<double>(nnz_in())<nfwd) return true;
  
     // Heuristic 2: Jac calculated via reverse mode likely cheaper
     double w = ad_weight();
     if (enable_reverse_ &&
         jac_penalty_*(1-w)*static_cast<double>(nnz_out())<w*static_cast<double>(nfwd))
       return true; // NOLINT
  
     return false;
   }

References casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::enable_fd_, casadi::FunctionInternal::enable_forward_, casadi::FunctionInternal::enable_reverse_, casadi::FunctionInternal::jac_penalty_, casadi::FunctionInternal::nnz_in(), and casadi::FunctionInternal::nnz_out().

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

◆ generate_dependencies()

std::string casadi::FunctionInternal::generate_dependencies	(	const std::string &	fname,
		const Dict &	opts
	)		const

virtualinherited

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

Reimplemented in casadi::OracleFunction.

Definition at line 3068 of file function_internal.cpp.

                                                                         {
     casadi_error("'generate_dependencies' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ generate_in()

void casadi::FunctionInternal::generate_in	(	const std::string &	fname,
		const double **	arg
	)		const

inherited

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

Definition at line 794 of file function_internal.cpp.

                                                                                      {
     // Set up output stream
     auto of_ptr = Filesystem::ofstream_ptr(fname);
     std::ostream& of = *of_ptr;
     normalized_setup(of);
  
     // Encode each input
     for (casadi_int i=0; i<n_in_; ++i) {
       const double* v = arg[i];
       for (casadi_int k=0;k<nnz_in(i);++k) {
         normalized_out(of, v ? v[k] : 0);
         of << std::endl;
       }
     }
   }

References casadi::FunctionInternal::n_in_, casadi::FunctionInternal::nnz_in(), casadi::normalized_out(), casadi::normalized_setup(), and casadi::Filesystem::ofstream_ptr().

◆ generate_lifted()

void casadi::FunctionInternal::generate_lifted	(	Function &	vdef_fcn,
		Function &	vinit_fcn
	)		const

virtualinherited

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

Reimplemented in casadi::MXFunction.

Definition at line 3632 of file function_internal.cpp.

                                                                     {
     casadi_error("'generate_lifted' only defined for 'MXFunction'");
   }

◆ generate_options()

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

overridevirtualinherited

Reimplemented from casadi::ProtoFunction.

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

Definition at line 389 of file function_internal.cpp.

                                                                        {
     Dict opts = ProtoFunction::generate_options(target);
     opts["jac_penalty"] = jac_penalty_;
     opts["user_data"] = user_data_;
     opts["inputs_check"] = inputs_check_;
     if (target!="tmp") opts["jit"] = jit_;
     opts["jit_cleanup"] = jit_cleanup_;
     opts["jit_serialize"] = jit_serialize_;
     opts["compiler"] = compiler_plugin_;
     opts["jit_options"] = jit_options_;
     opts["jit_name"] = jit_base_name_;
     opts["jit_temp_suffix"] = jit_temp_suffix_;
     opts["ad_weight"] = ad_weight_;
     opts["ad_weight_sp"] = ad_weight_sp_;
     opts["always_inline"] = always_inline_;
     opts["never_inline"] = never_inline_;
     opts["max_num_dir"] = max_num_dir_;
     if (target=="clone" || target=="tmp") {
       opts["enable_forward"] = enable_forward_op_;
       opts["enable_reverse"] = enable_reverse_op_;
       opts["enable_jacobian"] = enable_jacobian_op_;
       opts["enable_fd"] = enable_fd_op_;
       opts["reverse_options"] = reverse_options_;
       opts["forward_options"] = forward_options_;
       opts["jacobian_options"] = jacobian_options_;
       opts["der_options"] = der_options_;
       opts["derivative_of"] = derivative_of_;
     }
     opts["fd_options"] = fd_options_;
     opts["fd_method"] = fd_method_;
     opts["print_in"] = print_in_;
     opts["print_out"] = print_out_;
     opts["print_canonical"] = print_canonical_;
     opts["max_io"] = max_io_;
     opts["dump_in"] = dump_in_;
     opts["dump_out"] = dump_out_;
     opts["dump_dir"] = dump_dir_;
     opts["dump_format"] = dump_format_;
     opts["dump"] = dump_;
     if (target=="clone") {
       opts["is_diff_in"] = is_diff_in_;
       opts["is_diff_out"] = is_diff_out_;
     }
     if (target=="forward") {
       opts["is_diff_in"] = join(is_diff_in_, is_diff_out_, is_diff_in_);
       opts["is_diff_out"] = is_diff_out_;
     }
     if (target=="reverse") {
       opts["is_diff_in"] = join(is_diff_in_, is_diff_out_, is_diff_out_);
       opts["is_diff_out"] = is_diff_in_;
     }
     return opts;
   }

Referenced by casadi::Function::expand(), casadi::FunctionInternal::forward(), casadi::MXFunction::generate_options(), casadi::SXFunction::generate_options(), casadi::BlazingSplineFunction::get_jacobian(), and casadi::FunctionInternal::reverse().

◆ generate_out()

void casadi::FunctionInternal::generate_out	(	const std::string &	fname,
		double **	res
	)		const

inherited

Definition at line 810 of file function_internal.cpp.

                                                                                 {
     // Set up output stream
     auto of_ptr = Filesystem::ofstream_ptr(fname);
     std::ostream& of = *of_ptr;
     normalized_setup(of);
  
     // Encode each input
     for (casadi_int i=0; i<n_out_; ++i) {
       const double* v = res[i];
       for (casadi_int k=0;k<nnz_out(i);++k) {
         normalized_out(of, v ? v[k] : std::numeric_limits<double>::quiet_NaN());
         of << std::endl;
       }
     }
   }

References casadi::FunctionInternal::n_out_, casadi::FunctionInternal::nnz_out(), casadi::normalized_out(), casadi::normalized_setup(), and casadi::Filesystem::ofstream_ptr().

◆ get_abstol()

virtual double casadi::FunctionInternal::get_abstol ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::SundialsInterface, casadi::Smoothing, casadi::CentralDiff, and casadi::ForwardDiff.

Definition at line 1135 of file function_internal.hpp.

                                       {
       return eps;
     }

References casadi::eps.

Referenced by casadi::FiniteDiff::init().

◆ get_default_in()

virtual double casadi::FunctionInternal::get_default_in ( casadi_int ind ) const

inlinevirtualinherited

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

Reimplemented in casadi::SXFunction, casadi::Nlpsol, casadi::MXFunction, casadi::MapSum, casadi::Map, casadi::FiniteDiff, casadi::Conic, and casadi::External.

Definition at line 1099 of file function_internal.hpp.

                                                         {
       return 0;
     }

Referenced by casadi::FunctionInternal::codegen_meta(), casadi::FunctionInternal::convert_arg(), and casadi::External::get_default_in().

◆ get_diff_in()

virtual bool casadi::FunctionInternal::get_diff_in ( casadi_int i )

inlinevirtualinherited

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

Reimplemented in casadi::BSplineInterpolant, casadi::Interpolant, casadi::GenericExternal, casadi::Expm, and casadi::BlazingSplineFunction.

Definition at line 1152 of file function_internal.hpp.

1152 { return true; }

Referenced by casadi::GenericExternal::get_diff_in(), and casadi::FunctionInternal::init().

◆ get_diff_out()

virtual bool casadi::FunctionInternal::get_diff_out ( casadi_int i )

inlinevirtualinherited

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

Reimplemented in casadi::GenericExternal.

Definition at line 1157 of file function_internal.hpp.

1157 { return true; }

Referenced by casadi::GenericExternal::get_diff_out(), and casadi::FunctionInternal::init().

◆ get_forward()

Function casadi::FmuFunction::get_forward	(	casadi_int	nfwd,
		const std::string &	name,
		const std::vector< std::string > &	inames,
		const std::vector< std::string > &	onames,
		const Dict &	opts
	)		const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1617 of file fmu_function.cpp.

                             {
   // Only implemented if "new_forward" is enabled
   if (!new_forward_) return FunctionInternal::get_forward(nfwd, name, inames, onames, opts);
   // Pass options
   Dict opts1 = opts;
   opts1["parallelization"] = to_string(parallelization_);
   opts1["verbose"] = verbose_;
   opts1["print_progress"] = print_progress_;
   opts1["nfwd"] = nfwd;
   // Return new instance of class
   Function ret;
   ret.own(new FmuFunction(name, fmu_, inames, onames));
   ret->construct(opts1);
   return ret;
 }

References casadi::ProtoFunction::construct(), fmu_, FmuFunction(), casadi::FunctionInternal::get_forward(), new_forward_, casadi::GenericShared< Shared, Internal >::own(), parallelization_, print_progress_, casadi::to_string(), and casadi::ProtoFunction::verbose_.

◆ get_free()

std::vector< std::string > casadi::FunctionInternal::get_free ( ) const

virtualinherited

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

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

Definition at line 1129 of file function_internal.cpp.

                                                         {
     casadi_assert_dev(!has_free());
     return std::vector<std::string>();
   }

References casadi::FunctionInternal::has_free().

◆ get_function() [1/2]

std::vector< std::string > casadi::FunctionInternal::get_function ( ) const

virtualinherited

Reimplemented in casadi::SXFunction, casadi::OracleFunction, casadi::MXFunction, casadi::MapSum, and casadi::Map.

Definition at line 3953 of file function_internal.cpp.

                                                             {
     // No functions
     return std::vector<std::string>();
   }

◆ get_function() [2/2]

const Function & casadi::FunctionInternal::get_function ( const std::string & name ) const

virtualinherited

Reimplemented in casadi::SXFunction, casadi::OracleFunction, casadi::MXFunction, casadi::MapSum, and casadi::Map.

Definition at line 3958 of file function_internal.cpp.

                                                                             {
     casadi_error("'get_function' not defined for " + class_name());
     static Function singleton;
     return singleton;
   }

References casadi::SharedObjectInternal::class_name().

◆ get_jac_sparsity()

Sparsity casadi::FmuFunction::get_jac_sparsity	(	casadi_int	oind,
		casadi_int	iind,
		bool	symmetric
	)		const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1671 of file fmu_function.cpp.

                           {
   // Available in the FMU meta information
   if (out_.at(oind).type == OutputType::REG) {
     if (in_.at(iind).type == InputType::REG) {
       return fmu_.jac_sparsity(out_.at(oind).ind, in_.at(iind).ind);
     } else if (in_.at(iind).type == InputType::ADJ) {
       return Sparsity(nnz_out(oind), nnz_in(iind));
     }
   } else if (out_.at(oind).type == OutputType::ADJ) {
     if (in_.at(iind).type == InputType::REG) {
       return fmu_.hess_sparsity(out_.at(oind).wrt, in_.at(iind).ind);
     } else if (in_.at(iind).type == InputType::ADJ) {
       return fmu_.jac_sparsity(in_.at(iind).ind, out_.at(oind).wrt).T();
     }
   }
   // Not available
   casadi_error("Implementation error");
   return Sparsity();
 }

References casadi::ADJ, fmu_, casadi::Fmu::hess_sparsity(), in_, casadi::Fmu::jac_sparsity(), casadi::FunctionInternal::nnz_in(), casadi::FunctionInternal::nnz_out(), out_, casadi::REG, and casadi::Sparsity::T().

◆ get_jac_sparsity_gen()

template<bool fwd>

Sparsity casadi::FunctionInternal::get_jac_sparsity_gen	(	casadi_int	oind,
		casadi_int	iind
	)		const

inherited

Definition at line 1331 of file function_internal.cpp.

                                                                                         {
     // Number of nonzero inputs and outputs
     casadi_int nz_in = nnz_in(iind);
     casadi_int nz_out = nnz_out(oind);
  
     // Evaluation buffers
     std::vector<typename JacSparsityTraits<fwd>::arg_t> arg(sz_arg(), nullptr);
     std::vector<bvec_t*> res(sz_res(), nullptr);
     std::vector<casadi_int> iw(sz_iw());
     std::vector<bvec_t> w(sz_w(), 0);
  
     // Seeds and sensitivities
     std::vector<bvec_t> seed(nz_in, 0);
     arg[iind] = get_ptr(seed);
     std::vector<bvec_t> sens(nz_out, 0);
     res[oind] = get_ptr(sens);
     if (!fwd) std::swap(seed, sens);
  
     // Number of forward sweeps we must make
     casadi_int nsweep = seed.size() / bvec_size;
     if (seed.size() % bvec_size) nsweep++;
  
     // Print
     if (verbose_) {
       casadi_message(str(nsweep) + std::string(fwd ? " forward" : " reverse") + " sweeps "
                      "needed for " + str(seed.size()) + " directions");
     }
  
     // Progress
     casadi_int progress = -10;
  
     // Temporary vectors
     std::vector<casadi_int> jcol, jrow;
  
     // Loop over the variables, bvec_size variables at a time
     for (casadi_int s=0; s<nsweep; ++s) {
  
       // Print progress
       if (verbose_) {
         casadi_int progress_new = (s*100)/nsweep;
         // Print when entering a new decade
         if (progress_new / 10 > progress / 10) {
           progress = progress_new;
           casadi_message(str(progress) + " %");
         }
       }
  
       // Nonzero offset
       casadi_int offset = s*bvec_size;
  
       // Number of local seed directions
       casadi_int ndir_local = seed.size()-offset;
       ndir_local = std::min(static_cast<casadi_int>(bvec_size), ndir_local);
  
       for (casadi_int i=0; i<ndir_local; ++i) {
         seed[offset+i] |= bvec_t(1)<<i;
       }
  
       // Propagate the dependencies
       JacSparsityTraits<fwd>::sp(this, get_ptr(arg), get_ptr(res),
                                   get_ptr(iw), get_ptr(w), memory(0));
  
       // Loop over the nonzeros of the output
       for (casadi_int el=0; el<sens.size(); ++el) {
  
         // Get the sparsity sensitivity
         bvec_t spsens = sens[el];
  
         if (!fwd) {
           // Clear the sensitivities for the next sweep
           sens[el] = 0;
         }
  
         // If there is a dependency in any of the directions
         if (spsens!=0) {
  
           // Loop over seed directions
           for (casadi_int i=0; i<ndir_local; ++i) {
  
             // If dependents on the variable
             if ((bvec_t(1) << i) & spsens) {
               // Add to pattern
               jcol.push_back(el);
               jrow.push_back(i+offset);
             }
           }
         }
       }
  
       // Remove the seeds
       for (casadi_int i=0; i<ndir_local; ++i) {
         seed[offset+i] = 0;
       }
     }
  
     // Construct sparsity pattern and return
     if (!fwd) swap(jrow, jcol);
     Sparsity ret = Sparsity::triplet(nz_out, nz_in, jcol, jrow);
     if (verbose_) {
       casadi_message("Formed Jacobian sparsity pattern (dimension " + str(ret.size()) + ", "
           + str(ret.nnz()) + " (" + str(ret.density()) + " %) nonzeros.");
     }
     return ret;
   }

◆ get_jac_sparsity_hierarchical()

Sparsity casadi::FunctionInternal::get_jac_sparsity_hierarchical	(	casadi_int	oind,
		casadi_int	iind
	)		const

inherited

Decide which ad_mode to take

Definition at line 1671 of file function_internal.cpp.

                                                                                                  {
     // Number of nonzero inputs
     casadi_int nz_in = nnz_in(iind);
  
     // Number of nonzero outputs
     casadi_int nz_out = nnz_out(oind);
  
     // Seeds and sensitivities
     std::vector<bvec_t> s_in(nz_in, 0);
     std::vector<bvec_t> s_out(nz_out, 0);
  
     // Evaluation buffers
     std::vector<const bvec_t*> arg_fwd(sz_arg(), nullptr);
     std::vector<bvec_t*> arg_adj(sz_arg(), nullptr);
     arg_fwd[iind] = arg_adj[iind] = get_ptr(s_in);
     std::vector<bvec_t*> res(sz_res(), nullptr);
     res[oind] = get_ptr(s_out);
     std::vector<casadi_int> iw(sz_iw());
     std::vector<bvec_t> w(sz_w());
  
     // Sparsity triplet accumulator
     std::vector<casadi_int> jcol, jrow;
  
     // Cols of the coarse blocks
     std::vector<casadi_int> coarse_col(2, 0); coarse_col[1] = nz_out;
     // Rows of the coarse blocks
     std::vector<casadi_int> coarse_row(2, 0); coarse_row[1] = nz_in;
  
     // Cols of the fine blocks
     std::vector<casadi_int> fine_col;
  
     // Rows of the fine blocks
     std::vector<casadi_int> fine_row;
  
     // In each iteration, subdivide each coarse block in this many fine blocks
     casadi_int subdivision = bvec_size;
  
     Sparsity r = Sparsity::dense(1, 1);
  
     // The size of a block
     casadi_int granularity_row = nz_in;
     casadi_int granularity_col = nz_out;
  
     bool use_fwd = true;
  
     casadi_int nsweeps = 0;
  
     bool hasrun = false;
  
     // Get weighting factor
     double sp_w = sp_weight();
  
     // Lookup table for bvec_t
     std::vector<bvec_t> bvec_lookup;
     bvec_lookup.reserve(bvec_size);
     for (casadi_int i=0;i<bvec_size;++i) {
       bvec_lookup.push_back(bvec_t(1) << i);
     }
  
     while (!hasrun || coarse_col.size()!=nz_out+1 || coarse_row.size()!=nz_in+1) {
       if (verbose_) {
         casadi_message("Block size: " + str(granularity_col) + " x " + str(granularity_row));
       }
  
       // Clear the sparsity triplet acccumulator
       jcol.clear();
       jrow.clear();
  
       // Clear the fine block structure
       fine_row.clear();
       fine_col.clear();
  
       // r transpose will be needed in the algorithm
       Sparsity rT = r.T();
  
       // Forward mode
       Sparsity D1 = rT.uni_coloring(r);
       // Adjoint mode
       Sparsity D2 = r.uni_coloring(rT);
       if (verbose_) {
         casadi_message("Coloring on " + str(r.dim()) + " (fwd seeps: " + str(D1.size2()) +
                  " , adj sweeps: " + str(D2.size1()) + ")");
       }
  
       // Use whatever required less colors if we tried both (with preference to forward mode)
       double fwd_cost = static_cast<double>(use_fwd ? granularity_row : granularity_col) *
         sp_w*static_cast<double>(D1.size2());
       double adj_cost = static_cast<double>(use_fwd ? granularity_col : granularity_row) *
         (1-sp_w)*static_cast<double>(D2.size2());
       use_fwd = fwd_cost <= adj_cost;
       if (verbose_) {
         casadi_message(std::string(use_fwd ? "Forward" : "Reverse") + " mode chosen "
             "(fwd cost: " + str(fwd_cost) + ", adj cost: " + str(adj_cost) + ")");
       }
  
       // Get seeds and sensitivities
       bvec_t* seed_v = use_fwd ? get_ptr(s_in) : get_ptr(s_out);
       bvec_t* sens_v = use_fwd ? get_ptr(s_out) : get_ptr(s_in);
  
       // The number of zeros in the seed and sensitivity directions
       casadi_int nz_seed = use_fwd ? nz_in  : nz_out;
       casadi_int nz_sens = use_fwd ? nz_out : nz_in;
  
       // Clear the seeds
       for (casadi_int i=0; i<nz_seed; ++i) seed_v[i]=0;
  
       // Choose the active jacobian coloring scheme
       Sparsity D = use_fwd ? D1 : D2;
  
       // Adjoint mode amounts to swapping
       if (!use_fwd) {
         std::swap(coarse_col, coarse_row);
         std::swap(granularity_col, granularity_row);
         std::swap(r, rT);
       }
  
       // Subdivide the coarse block cols
       for (casadi_int k=0;k<coarse_col.size()-1;++k) {
         casadi_int diff = coarse_col[k+1]-coarse_col[k];
         casadi_int new_diff = diff/subdivision;
         if (diff%subdivision>0) new_diff++;
         std::vector<casadi_int> temp = range(coarse_col[k], coarse_col[k+1], new_diff);
         fine_col.insert(fine_col.end(), temp.begin(), temp.end());
       }
       // Subdivide the coarse block rows
       for (casadi_int k=0;k<coarse_row.size()-1;++k) {
         casadi_int diff = coarse_row[k+1]-coarse_row[k];
         casadi_int new_diff = diff/subdivision;
         if (diff%subdivision>0) new_diff++;
         std::vector<casadi_int> temp = range(coarse_row[k], coarse_row[k+1], new_diff);
         fine_row.insert(fine_row.end(), temp.begin(), temp.end());
       }
       if (fine_row.back()!=coarse_row.back()) fine_row.push_back(coarse_row.back());
       if (fine_col.back()!=coarse_col.back()) fine_col.push_back(coarse_col.back());
  
       granularity_col = fine_col[1] - fine_col[0];
       granularity_row = fine_row[1] - fine_row[0];
  
       // The index into the bvec bit vector
       casadi_int bvec_i = 0;
  
       // Create lookup tables for the fine blocks
       std::vector<casadi_int> fine_col_lookup = lookupvector(fine_col, nz_sens+1);
       std::vector<casadi_int> fine_row_lookup = lookupvector(fine_row, nz_seed+1);
  
       // Triplet data used as a lookup table
       std::vector<casadi_int> lookup_col;
       std::vector<casadi_int> lookup_row;
       std::vector<casadi_int> lookup_value;
  
  
       // The maximum number of fine blocks contained in one coarse block
       casadi_int n_fine_blocks_max = 0;
       for (casadi_int i=0;i<coarse_row.size()-1;++i) {
         casadi_int del = fine_row_lookup[coarse_row[i+1]]-fine_row_lookup[coarse_row[i]];
         n_fine_blocks_max = std::max(n_fine_blocks_max, del);
       }
  
       // Loop over all coarse seed directions from the coloring
       for (casadi_int csd=0; csd<D.size2(); ++csd) {
  
         casadi_int fci_offset = 0;
         casadi_int fci_cap = bvec_size-bvec_i;
  
         // Flag to indicate if all fine blocks have been handled
         bool f_finished = false;
  
         // Loop while not finished
         while (!f_finished) {
  
           // Loop over all coarse rows that are found in the coloring for this coarse seed direction
           for (casadi_int k=D.colind(csd); k<D.colind(csd+1); ++k) {
             casadi_int cci = D.row(k);
  
             // The first and last rows of the fine block
             casadi_int fci_start = fine_row_lookup[coarse_row[cci]];
             casadi_int fci_end   = fine_row_lookup[coarse_row[cci+1]];
  
             // Local counter that modifies index into bvec
             casadi_int bvec_i_mod = 0;
  
             casadi_int value = -bvec_i + fci_offset + fci_start;
  
             // Loop over the rows of the fine block
             for (casadi_int fci = fci_offset; fci < std::min(fci_end-fci_start, fci_cap); ++fci) {
  
               // Loop over the coarse block cols that appear in the coloring
               // for the current coarse seed direction
               for (casadi_int cri=rT.colind(cci);cri<rT.colind(cci+1);++cri) {
                 lookup_col.push_back(rT.row(cri));
                 lookup_row.push_back(bvec_i+bvec_i_mod);
                 lookup_value.push_back(value);
               }
  
               // Toggle on seeds
               bvec_toggle(seed_v, fine_row[fci+fci_start], fine_row[fci+fci_start+1],
                           bvec_i+bvec_i_mod);
               bvec_i_mod++;
             }
           }
  
           // Bump bvec_i for next major coarse direction
           bvec_i+= std::min(n_fine_blocks_max, fci_cap);
  
           // Check if bvec buffer is full
           if (bvec_i==bvec_size || csd==D.size2()-1) {
             // Calculate sparsity for bvec_size directions at once
  
             // Statistics
             nsweeps+=1;
  
             // Construct lookup table
             IM lookup = IM::triplet(lookup_row, lookup_col, lookup_value, bvec_size,
                                     coarse_col.size());
  
             // Propagate the dependencies
             if (use_fwd) {
               JacSparsityTraits<true>::sp(this, get_ptr(arg_fwd), get_ptr(res),
                 get_ptr(iw), get_ptr(w), memory(0));
             } else {
               std::fill(w.begin(), w.end(), 0);
               JacSparsityTraits<false>::sp(this, get_ptr(arg_adj), get_ptr(res),
                 get_ptr(iw), get_ptr(w), memory(0));
             }
  
             // Temporary bit work vector
             bvec_t spsens;
  
             // Loop over the cols of coarse blocks
             for (casadi_int cri=0;cri<coarse_col.size()-1;++cri) {
  
               // Loop over the cols of fine blocks within the current coarse block
               for (casadi_int fri=fine_col_lookup[coarse_col[cri]];
                    fri<fine_col_lookup[coarse_col[cri+1]];++fri) {
                 // Lump individual sensitivities together into fine block
                 bvec_or(sens_v, spsens, fine_col[fri], fine_col[fri+1]);
  
                 // Next iteration if no sparsity
                 if (!spsens) continue;
  
                 // Loop over all bvec_bits
                 for (casadi_int bvec_i=0;bvec_i<bvec_size;++bvec_i) {
                   if (spsens & bvec_lookup[bvec_i]) {
                     // if dependency is found, add it to the new sparsity pattern
                     casadi_int ind = lookup.sparsity().get_nz(bvec_i, cri);
                     if (ind==-1) continue;
                     jrow.push_back(bvec_i+lookup->at(ind));
                     jcol.push_back(fri);
                   }
                 }
               }
             }
  
             // Clear the forward seeds/adjoint sensitivities, ready for next bvec sweep
             std::fill(s_in.begin(), s_in.end(), 0);
  
             // Clear the adjoint seeds/forward sensitivities, ready for next bvec sweep
             std::fill(s_out.begin(), s_out.end(), 0);
  
             // Clean lookup table
             lookup_col.clear();
             lookup_row.clear();
             lookup_value.clear();
           }
  
           if (n_fine_blocks_max>fci_cap) {
             fci_offset += std::min(n_fine_blocks_max, fci_cap);
             bvec_i = 0;
             fci_cap = bvec_size;
           } else {
             f_finished = true;
           }
  
         }
  
       }
  
       // Swap results if adjoint mode was used
       if (use_fwd) {
         // Construct fine sparsity pattern
         r = Sparsity::triplet(fine_row.size()-1, fine_col.size()-1, jrow, jcol);
         coarse_col = fine_col;
         coarse_row = fine_row;
       } else {
         // Construct fine sparsity pattern
         r = Sparsity::triplet(fine_col.size()-1, fine_row.size()-1, jcol, jrow);
         coarse_col = fine_row;
         coarse_row = fine_col;
       }
       hasrun = true;
     }
     if (verbose_) {
       casadi_message("Number of sweeps: " + str(nsweeps));
       casadi_message("Formed Jacobian sparsity pattern (dimension " + str(r.size()) + ", " +
           str(r.nnz()) + " (" + str(r.density()) + " %) nonzeros.");
     }
  
     return r.T();
   }

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

◆ get_jac_sparsity_hierarchical_symm()

Sparsity casadi::FunctionInternal::get_jac_sparsity_hierarchical_symm	(	casadi_int	oind,
		casadi_int	iind
	)		const

inherited

A flavor of get_jac_sparsity_gen that does hierarchical block structure recognition for symmetric Jacobians

Definition at line 1436 of file function_internal.cpp.

                              {
     casadi_assert_dev(has_spfwd());
  
     // Number of nonzero inputs
     casadi_int nz = nnz_in(iind);
     casadi_assert_dev(nz==nnz_out(oind));
  
     // Evaluation buffers
     std::vector<const bvec_t*> arg(sz_arg(), nullptr);
     std::vector<bvec_t*> res(sz_res(), nullptr);
     std::vector<casadi_int> iw(sz_iw());
     std::vector<bvec_t> w(sz_w());
  
     // Seeds
     std::vector<bvec_t> seed(nz, 0);
     arg[iind] = get_ptr(seed);
  
     // Sensitivities
     std::vector<bvec_t> sens(nz, 0);
     res[oind] = get_ptr(sens);
  
     // Sparsity triplet accumulator
     std::vector<casadi_int> jcol, jrow;
  
     // Cols/rows of the coarse blocks
     std::vector<casadi_int> coarse(2, 0); coarse[1] = nz;
  
     // Cols/rows of the fine blocks
     std::vector<casadi_int> fine;
  
     // In each iteration, subdivide each coarse block in this many fine blocks
     casadi_int subdivision = bvec_size;
  
     Sparsity r = Sparsity::dense(1, 1);
  
     // The size of a block
     casadi_int granularity = nz;
  
     casadi_int nsweeps = 0;
  
     bool hasrun = false;
  
     while (!hasrun || coarse.size()!=nz+1) {
       if (verbose_) casadi_message("Block size: " + str(granularity));
  
       // Clear the sparsity triplet acccumulator
       jcol.clear();
       jrow.clear();
  
       // Clear the fine block structure
       fine.clear();
  
       Sparsity D = r.star_coloring();
  
       if (verbose_) {
         casadi_message("Star coloring on " + str(r.dim()) + ": "
           + str(D.size2()) + " <-> " + str(D.size1()));
       }
  
       // Clear the seeds
       std::fill(seed.begin(), seed.end(), 0);
  
       // Subdivide the coarse block
       for (casadi_int k=0; k<coarse.size()-1; ++k) {
         casadi_int diff = coarse[k+1]-coarse[k];
         casadi_int new_diff = diff/subdivision;
         if (diff%subdivision>0) new_diff++;
         std::vector<casadi_int> temp = range(coarse[k], coarse[k+1], new_diff);
         fine.insert(fine.end(), temp.begin(), temp.end());
       }
       if (fine.back()!=coarse.back()) fine.push_back(coarse.back());
  
       granularity = fine[1] - fine[0];
  
       // The index into the bvec bit vector
       casadi_int bvec_i = 0;
  
       // Create lookup tables for the fine blocks
       std::vector<casadi_int> fine_lookup = lookupvector(fine, nz+1);
  
       // Triplet data used as a lookup table
       std::vector<casadi_int> lookup_col;
       std::vector<casadi_int> lookup_row;
       std::vector<casadi_int> lookup_value;
  
       // The maximum number of fine blocks contained in one coarse block
       casadi_int n_fine_blocks_max = 0;
       for (casadi_int i=0;i<coarse.size()-1;++i) {
         casadi_int del = fine_lookup[coarse[i+1]]-fine_lookup[coarse[i]];
         n_fine_blocks_max = std::max(n_fine_blocks_max, del);
       }
  
       // Loop over all coarse seed directions from the coloring
       for (casadi_int csd=0; csd<D.size2(); ++csd) {
  
  
         casadi_int fci_offset = 0;
         casadi_int fci_cap = bvec_size-bvec_i;
  
         // Flag to indicate if all fine blocks have been handled
         bool f_finished = false;
  
         // Loop while not finished
         while (!f_finished) {
  
           // Loop over all coarse rows that are found in the coloring for this coarse seed direction
           for (casadi_int k=D.colind(csd); k<D.colind(csd+1); ++k) {
             casadi_int cci = D.row(k);
  
             // The first and last rows of the fine block
             casadi_int fci_start = fine_lookup[coarse[cci]];
             casadi_int fci_end   = fine_lookup[coarse[cci+1]];
  
             // Local counter that modifies index into bvec
             casadi_int bvec_i_mod = 0;
  
             casadi_int value = -bvec_i + fci_offset + fci_start;
  
             //casadi_assert_dev(value>=0);
  
             // Loop over the rows of the fine block
             for (casadi_int fci = fci_offset; fci<std::min(fci_end-fci_start, fci_cap); ++fci) {
  
               // Loop over the coarse block cols that appear in the
               // coloring for the current coarse seed direction
               for (casadi_int cri=r.colind(cci);cri<r.colind(cci+1);++cri) {
                 lookup_col.push_back(r.row(cri));
                 lookup_row.push_back(bvec_i+bvec_i_mod);
                 lookup_value.push_back(value);
               }
  
               // Toggle on seeds
               bvec_toggle(get_ptr(seed), fine[fci+fci_start], fine[fci+fci_start+1],
                           bvec_i+bvec_i_mod);
               bvec_i_mod++;
             }
           }
  
           // Bump bvec_i for next major coarse direction
           bvec_i += std::min(n_fine_blocks_max, fci_cap);
  
           // Check if bvec buffer is full
           if (bvec_i==bvec_size || csd==D.size2()-1) {
             // Calculate sparsity for bvec_size directions at once
  
             // Statistics
             nsweeps+=1;
  
             // Construct lookup table
             IM lookup = IM::triplet(lookup_row, lookup_col, lookup_value,
                                     bvec_size, coarse.size());
  
             std::reverse(lookup_col.begin(), lookup_col.end());
             std::reverse(lookup_row.begin(), lookup_row.end());
             std::reverse(lookup_value.begin(), lookup_value.end());
             IM duplicates =
               IM::triplet(lookup_row, lookup_col, lookup_value, bvec_size, coarse.size())
               - lookup;
             duplicates = sparsify(duplicates);
             lookup(duplicates.sparsity()) = -bvec_size;
  
             // Propagate the dependencies
             JacSparsityTraits<true>::sp(this, get_ptr(arg), get_ptr(res),
               get_ptr(iw), get_ptr(w), nullptr);
  
             // Temporary bit work vector
             bvec_t spsens;
  
             // Loop over the cols of coarse blocks
             for (casadi_int cri=0; cri<coarse.size()-1; ++cri) {
  
               // Loop over the cols of fine blocks within the current coarse block
               for (casadi_int fri=fine_lookup[coarse[cri]];fri<fine_lookup[coarse[cri+1]];++fri) {
                 // Lump individual sensitivities together into fine block
                 bvec_or(get_ptr(sens), spsens, fine[fri], fine[fri+1]);
  
                 // Loop over all bvec_bits
                 for (casadi_int bvec_i=0;bvec_i<bvec_size;++bvec_i) {
                   if (spsens & (bvec_t(1) << bvec_i)) {
                     // if dependency is found, add it to the new sparsity pattern
                     casadi_int ind = lookup.sparsity().get_nz(bvec_i, cri);
                     if (ind==-1) continue;
                     casadi_int lk = lookup->at(ind);
                     if (lk>-bvec_size) {
                       jrow.push_back(bvec_i+lk);
                       jcol.push_back(fri);
                       jrow.push_back(fri);
                       jcol.push_back(bvec_i+lk);
                     }
                   }
                 }
               }
             }
  
             // Clear the forward seeds/adjoint sensitivities, ready for next bvec sweep
             std::fill(seed.begin(), seed.end(), 0);
  
             // Clean lookup table
             lookup_col.clear();
             lookup_row.clear();
             lookup_value.clear();
           }
  
           if (n_fine_blocks_max>fci_cap) {
             fci_offset += std::min(n_fine_blocks_max, fci_cap);
             bvec_i = 0;
             fci_cap = bvec_size;
           } else {
             f_finished = true;
           }
         }
       }
  
       // Construct fine sparsity pattern
       r = Sparsity::triplet(fine.size()-1, fine.size()-1, jrow, jcol);
  
       // There may be false positives here that are not present
       // in the reverse mode that precedes it.
       // This can lead to an assymetrical result
       //  cf. #1522
       r=r*r.T();
  
       coarse = fine;
       hasrun = true;
     }
     if (verbose_) {
       casadi_message("Number of sweeps: " + str(nsweeps));
       casadi_message("Formed Jacobian sparsity pattern (dimension " + str(r.size()) +
           ", " + str(r.nnz()) + " (" + str(r.density()) + " %) nonzeros.");
     }
  
     return r.T();
   }

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

◆ get_jacobian()

Function casadi::FmuFunction::get_jacobian	(	const std::string &	name,
		const std::vector< std::string > &	inames,
		const std::vector< std::string > &	onames,
		const Dict &	opts
	)		const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1594 of file fmu_function.cpp.

                                                                 {
   // Hack: Inherit parallelization, verbosity option
   Dict opts1 = opts;
   opts1["parallelization"] = to_string(parallelization_);
   opts1["verbose"] = verbose_;
   opts1["print_progress"] = print_progress_;
   // Return new instance of class
   Function ret;
   ret.own(new FmuFunction(name, fmu_, inames, onames));
   ret->construct(opts1);
   return ret;
 }

References casadi::ProtoFunction::construct(), fmu_, FmuFunction(), casadi::GenericShared< Shared, Internal >::own(), parallelization_, print_progress_, casadi::to_string(), and casadi::ProtoFunction::verbose_.

◆ get_jit_directory()

std::string casadi::FunctionInternal::get_jit_directory ( const Dict & jit_options )

staticinherited

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

Definition at line 710 of file function_internal.cpp.

                                                                        {
     // Start with default temp work dir
     std::string jit_directory = GlobalOptions::getTempWorkDir();
  
     // Get user-specified directory
     std::string directory;
     directory = get_from_dict(jit_options, "directory", std::string(""));
  
     // What if directory itself is absolute?
     if (Filesystem::is_absolute(directory)) {
       // Override
       jit_directory = directory;
     } else {
       jit_directory = jit_directory + directory;
       if (Filesystem::is_enabled()) {
         jit_directory = Filesystem::absolute(jit_directory);
       }
     }
  
     return Filesystem::ensure_trailing_slash(jit_directory);
   }

References casadi::Filesystem::absolute(), casadi::Filesystem::ensure_trailing_slash(), casadi::get_from_dict(), casadi::GlobalOptions::getTempWorkDir(), casadi::Filesystem::is_absolute(), and casadi::Filesystem::is_enabled().

Referenced by casadi::FunctionInternal::finalize(), and casadi::ShellCompiler::init().

◆ get_max_in()

virtual double casadi::FunctionInternal::get_max_in ( casadi_int ind ) const

inlinevirtualinherited

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

Definition at line 1106 of file function_internal.hpp.

                                                     {
       return inf;
     }

References casadi::inf.

◆ get_min_in()

virtual double casadi::FunctionInternal::get_min_in ( casadi_int ind ) const

inlinevirtualinherited

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

Definition at line 1113 of file function_internal.hpp.

                                                     {
       return -inf;
     }

References casadi::inf.

◆ get_n_in()

size_t casadi::FmuFunction::get_n_in ( )

inlineoverridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 241 of file fmu_function.hpp.

241 { return in_.size();}

◆ get_n_out()

size_t casadi::FmuFunction::get_n_out ( )

inlineoverridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 242 of file fmu_function.hpp.

242 {return out_.size();}

◆ get_name_in()

std::string casadi::FunctionInternal::get_name_in ( casadi_int i )

virtualinherited

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

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

Definition at line 673 of file function_internal.cpp.

                                                       {
     if (!derivative_of_.is_null()) {
       std::string n = derivative_of_.name();
       if (name_ == "jac_" + n || name_ == "adj1_" + n) {
         if (i < derivative_of_.n_in()) {
           // Same as nondifferentiated function
           return derivative_of_.name_in(i);
         } else if (i < derivative_of_.n_in() + derivative_of_.n_out()) {
           // Nondifferentiated output
           return "out_" + derivative_of_.name_out(i - derivative_of_.n_in());
         } else {
           // Adjoint seed
           return "adj_" + derivative_of_.name_out(i - derivative_of_.n_in()
             - derivative_of_.n_out());
         }
       }
     }
     // Default name
     return "i" + str(i);
   }

References casadi::FunctionInternal::derivative_of_, casadi::GenericShared< Shared, Internal >::is_null(), casadi::Function::n_in(), casadi::Function::n_out(), casadi::Function::name(), casadi::ProtoFunction::name_, casadi::Function::name_in(), casadi::Function::name_out(), and casadi::str().

Referenced by casadi::External::get_name_in(), and casadi::FunctionInternal::init().

◆ get_name_out()

std::string casadi::FunctionInternal::get_name_out ( casadi_int i )

virtualinherited

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

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

Definition at line 694 of file function_internal.cpp.

                                                        {
     if (!derivative_of_.is_null()) {
       std::string n = derivative_of_.name();
       if (name_ == "jac_" + n) {
         // Jacobian block
         casadi_int oind = i / derivative_of_.n_in(), iind = i % derivative_of_.n_in();
         return "jac_" + derivative_of_.name_out(oind) + "_" + derivative_of_.name_in(iind);
       } else if (name_ == "adj1_" + n) {
         // Adjoint sensitivity
         return "adj_" + derivative_of_.name_in(i);
       }
     }
     // Default name
     return "o" + str(i);
   }

References casadi::FunctionInternal::derivative_of_, casadi::GenericShared< Shared, Internal >::is_null(), casadi::Function::n_in(), casadi::Function::name(), casadi::ProtoFunction::name_, casadi::Function::name_in(), casadi::Function::name_out(), and casadi::str().

Referenced by casadi::External::get_name_out(), and casadi::FunctionInternal::init().

◆ get_nominal_in()

std::vector< double > casadi::FmuFunction::get_nominal_in ( casadi_int i ) const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 902 of file fmu_function.cpp.

                                                                 {
   switch (in_.at(i).type) {
     case InputType::REG:
       return fmu_.all_nominal_in(in_.at(i).ind);
     case InputType::FWD:
     case InputType::ADJ:
     case InputType::ADJ_OUT:
       break;
     case InputType::OUT:
       return fmu_.all_nominal_out(in_.at(i).ind);
   }
   // Default: Base class
   return FunctionInternal::get_nominal_in(i);
 }

References casadi::ADJ, casadi::ADJ_OUT, casadi::Fmu::all_nominal_in(), casadi::Fmu::all_nominal_out(), fmu_, casadi::FWD, casadi::FunctionInternal::get_nominal_in(), in_, casadi::OUT, and casadi::REG.

◆ get_nominal_out()

std::vector< double > casadi::FmuFunction::get_nominal_out ( casadi_int i ) const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 917 of file fmu_function.cpp.

                                                                  {
   switch (out_.at(i).type) {
     case OutputType::REG:
       return fmu_.all_nominal_out(out_.at(i).ind);
     case OutputType::FWD:
     case OutputType::ADJ:
       break;
     case OutputType::JAC:
       casadi_warning("FmuFunction::get_nominal_out not implemented for OutputType::JAC");
       break;
     case OutputType::JAC_TRANS:
       casadi_warning("FmuFunction::get_nominal_out not implemented for OutputType::JAC_TRANS");
       break;
     case OutputType::JAC_ADJ_OUT:
       casadi_warning("FmuFunction::get_nominal_out not implemented for OutputType::JAC_ADJ_OUT");
       break;
     case OutputType::JAC_REG_ADJ:
       casadi_warning("FmuFunction::get_nominal_out not implemented for OutputType::JAC_REG_ADJ");
       break;
     case OutputType::HESS:
       casadi_warning("FmuFunction::get_nominal_out not implemented for OutputType::HESS");
       break;
   }
   // Default: Base class
   return FunctionInternal::get_nominal_out(i);
 }

References casadi::ADJ, casadi::Fmu::all_nominal_out(), fmu_, casadi::FWD, casadi::FunctionInternal::get_nominal_out(), casadi::HESS, casadi::JAC, casadi::JAC_ADJ_OUT, casadi::JAC_REG_ADJ, casadi::JAC_TRANS, out_, and casadi::REG.

◆ get_options()

const Options& casadi::FmuFunction::get_options ( ) const

inlineoverridevirtual

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

Reimplemented from casadi::ProtoFunction.

Definition at line 206 of file fmu_function.hpp.

206 { return options_;}

casadi::FmuFunction::options_

static const Options options_

Options.

Definition: fmu_function.hpp:205

◆ get_partition()

void casadi::FunctionInternal::get_partition	(	casadi_int	iind,
		casadi_int	oind,
		Sparsity &	D1,
		Sparsity &	D2,
		bool	compact,
		bool	symmetric,
		bool	allow_forward,
		bool	allow_reverse
	)		const

inherited

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

Definition at line 2126 of file function_internal.cpp.

                                                                                      {
     if (verbose_) casadi_message(name_ + "::get_partition");
     casadi_assert(allow_forward || allow_reverse, "Inconsistent options");
  
     // Sparsity pattern with transpose
     Sparsity &AT = jac_sparsity(oind, iind, compact, symmetric);
     Sparsity A = symmetric ? AT : AT.T();
  
     // Get seed matrices by graph coloring
     if (symmetric) {
       casadi_assert_dev(enable_forward_ || enable_fd_);
       casadi_assert_dev(allow_forward);
  
       // Star coloring if symmetric
       if (verbose_) casadi_message("FunctionInternal::getPartition star_coloring");
       D1 = A.star_coloring();
       if (verbose_) {
         casadi_message("Star coloring completed: " + str(D1.size2())
           + " directional derivatives needed ("
                  + str(A.size1()) + " without coloring).");
       }
  
     } else {
       casadi_assert_dev(enable_forward_ || enable_fd_ || enable_reverse_);
       // Get weighting factor
       double w = ad_weight();
  
       // Which AD mode?
       if (w==1) allow_forward = false;
       if (w==0) allow_reverse = false;
       casadi_assert(allow_forward || allow_reverse, "Conflicting ad weights");
  
       // Best coloring encountered so far (relatively tight upper bound)
       double best_coloring = std::numeric_limits<double>::infinity();
  
       // Test forward mode first?
       bool test_fwd_first = allow_forward && w*static_cast<double>(A.size1()) <=
         (1-w)*static_cast<double>(A.size2());
       casadi_int mode_fwd = test_fwd_first ? 0 : 1;
  
       // Test both coloring modes
       for (casadi_int mode=0; mode<2; ++mode) {
         // Is this the forward mode?
         bool fwd = mode==mode_fwd;
  
         // Skip?
         if (!allow_forward && fwd) continue;
         if (!allow_reverse && !fwd) continue;
  
         // Perform the coloring
         if (fwd) {
           if (verbose_) casadi_message("Unidirectional coloring (forward mode)");
           bool d = best_coloring>=w*static_cast<double>(A.size1());
           casadi_int max_colorings_to_test =
             d ? A.size1() : static_cast<casadi_int>(floor(best_coloring/w));
           D1 = AT.uni_coloring(A, max_colorings_to_test);
           if (D1.is_null()) {
             if (verbose_) {
               casadi_message("Forward mode coloring interrupted (more than "
                              + str(max_colorings_to_test) + " needed).");
             }
           } else {
             if (verbose_) {
               casadi_message("Forward mode coloring completed: "
                              + str(D1.size2()) + " directional derivatives needed ("
                              + str(A.size1()) + " without coloring).");
             }
             D2 = Sparsity();
             best_coloring = w*static_cast<double>(D1.size2());
           }
         } else {
           if (verbose_) casadi_message("Unidirectional coloring (adjoint mode)");
           bool d = best_coloring>=(1-w)*static_cast<double>(A.size2());
           casadi_int max_colorings_to_test =
             d ? A.size2() : static_cast<casadi_int>(floor(best_coloring/(1-w)));
  
           D2 = A.uni_coloring(AT, max_colorings_to_test);
           if (D2.is_null()) {
             if (verbose_) {
               casadi_message("Adjoint mode coloring interrupted (more than "
                             + str(max_colorings_to_test) + " needed).");
             }
           } else {
             if (verbose_) {
               casadi_message("Adjoint mode coloring completed: "
                              + str(D2.size2()) + " directional derivatives needed ("
                              + str(A.size2()) + " without coloring).");
             }
             D1 = Sparsity();
             best_coloring = (1-w)*static_cast<double>(D2.size2());
           }
         }
       }
  
     }
   }

References casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::enable_fd_, casadi::FunctionInternal::enable_forward_, casadi::FunctionInternal::enable_reverse_, casadi::GenericShared< Shared, Internal >::is_null(), casadi::FunctionInternal::jac_sparsity(), casadi::ProtoFunction::name_, casadi::Sparsity::size1(), casadi::Sparsity::size2(), casadi::Sparsity::star_coloring(), casadi::str(), casadi::Sparsity::T(), casadi::Sparsity::uni_coloring(), and casadi::ProtoFunction::verbose_.

◆ get_reltol()

virtual double casadi::FunctionInternal::get_reltol ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::SundialsInterface.

Definition at line 1128 of file function_internal.hpp.

                                       {
       return eps;
     }

References casadi::eps.

Referenced by casadi::FiniteDiff::init().

◆ get_reverse()

Function casadi::FmuFunction::get_reverse	(	casadi_int	nadj,
		const std::string &	name,
		const std::vector< std::string > &	inames,
		const std::vector< std::string > &	onames,
		const Dict &	opts
	)		const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1643 of file fmu_function.cpp.

                             {
   // Hack: Inherit parallelization option
   Dict opts1 = opts;
   opts1["parallelization"] = to_string(parallelization_);
   opts1["verbose"] = verbose_;
   opts1["new_jacobian"] = new_hessian_;
   opts1["print_progress"] = print_progress_;
   opts1["nadj"] = nadj;
   // Return new instance of class
   Function ret;
   ret.own(new FmuFunction(name, fmu_, inames, onames));
   ret->construct(opts1);
   return ret;
 }

References casadi::ProtoFunction::construct(), fmu_, FmuFunction(), new_hessian_, casadi::GenericShared< Shared, Internal >::own(), parallelization_, print_progress_, casadi::to_string(), and casadi::ProtoFunction::verbose_.

◆ get_sparsity_in()

Sparsity casadi::FmuFunction::get_sparsity_in ( casadi_int i )

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 863 of file fmu_function.cpp.

                                                   {
   switch (in_.at(i).type) {
     case InputType::REG:
       return Sparsity::dense(fmu_.ired(in_.at(i).ind).size(), 1);
     case InputType::FWD:
       return Sparsity::dense(fmu_.ired(in_.at(i).ind).size(), nfwd_);
     case InputType::ADJ:
       return Sparsity::dense(fmu_.ored(in_.at(i).ind).size(), nadj_);
     case InputType::OUT:
       return Sparsity(fmu_.ored(in_.at(i).ind).size(), 1);
     case InputType::ADJ_OUT:
       return Sparsity(fmu_.ired(in_.at(i).ind).size(), 1);
   }
   return Sparsity();
 }

References casadi::ADJ, casadi::ADJ_OUT, casadi::Sparsity::dense(), fmu_, casadi::FWD, in_, casadi::Fmu::ired(), nadj_, nfwd_, casadi::Fmu::ored(), casadi::OUT, and casadi::REG.

◆ get_sparsity_out()

Sparsity casadi::FmuFunction::get_sparsity_out ( casadi_int i )

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 879 of file fmu_function.cpp.

                                                    {
   const OutputStruct& s = out_.at(i);
   switch (out_.at(i).type) {
     case OutputType::REG:
       return Sparsity::dense(fmu_.ored(s.ind).size(), 1);
     case OutputType::FWD:
       return Sparsity::dense(fmu_.ored(s.ind).size(), nfwd_);
     case OutputType::ADJ:
       return Sparsity::dense(fmu_.ired(s.wrt).size(), nadj_);
     case OutputType::JAC:
       return fmu_.jac_sparsity(s.ind, s.wrt);
     case OutputType::JAC_TRANS:
       return fmu_.jac_sparsity(s.ind, s.wrt).T();
     case OutputType::JAC_ADJ_OUT:
       return Sparsity(fmu_.ired(s.ind).size(), fmu_.ored(s.wrt).size());
     case OutputType::JAC_REG_ADJ:
       return Sparsity(fmu_.ored(s.ind).size(), fmu_.ored(s.wrt).size());
     case OutputType::HESS:
       return fmu_.hess_sparsity(s.ind, s.wrt);
   }
   return Sparsity();
 }

References casadi::ADJ, casadi::Sparsity::dense(), fmu_, casadi::FWD, casadi::HESS, casadi::Fmu::hess_sparsity(), casadi::OutputStruct::ind, casadi::Fmu::ired(), casadi::JAC, casadi::JAC_ADJ_OUT, casadi::JAC_REG_ADJ, casadi::Fmu::jac_sparsity(), casadi::JAC_TRANS, nadj_, nfwd_, casadi::Fmu::ored(), out_, casadi::REG, casadi::Sparsity::T(), and casadi::OutputStruct::wrt.

◆ get_stats()

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

overridevirtual

Reimplemented from casadi::ProtoFunction.

Definition at line 1692 of file fmu_function.cpp.

                                            {
   // Get the stats from the base classes
   Dict stats = FunctionInternal::get_stats(mem);
   // Get memory object
   FmuMemory* m = static_cast<FmuMemory*>(mem);
   // Get auxilliary variables from Fmu
   fmu_.get_stats(m, &stats, name_in_, get_ptr(in_));
   // Return stats
   return stats;
 }

References fmu_, casadi::get_ptr(), casadi::Fmu::get_stats(), casadi::FunctionInternal::get_stats(), in_, and casadi::FunctionInternal::name_in_.

◆ getAdaptorSolverName()

virtual std::string casadi::FunctionInternal::getAdaptorSolverName ( ) const

inlinevirtualinherited

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

Definition at line 306 of file function_internal.hpp.

306 { return ""; }

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

virtual bool casadi::FunctionInternal::has_codegen ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::LinearInterpolantJac, casadi::LinearInterpolant, casadi::BSplineInterpolant, casadi::OnnxRuntimeInterface, casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::Switch, casadi::MapSum, casadi::Map, casadi::JitFunction, casadi::FiniteDiff, and casadi::BlazingSplineFunction.

Definition at line 945 of file function_internal.hpp.

945 { return false;}

Referenced by casadi::External::External(), and casadi::FunctionInternal::finalize().

◆ has_derivative()

bool casadi::FunctionInternal::has_derivative ( ) const

inherited

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

Definition at line 3235 of file function_internal.cpp.

                                               {
     return enable_forward_ || enable_reverse_ || enable_jacobian_ || enable_fd_;
   }

References casadi::FunctionInternal::enable_fd_, casadi::FunctionInternal::enable_forward_, casadi::FunctionInternal::enable_jacobian_, and casadi::FunctionInternal::enable_reverse_.

Referenced by casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::call_reverse(), casadi::FunctionInternal::forward(), casadi::OnnxFunction::has_forward(), casadi::OnnxFunction::has_jacobian(), casadi::OnnxFunction::has_reverse(), casadi::FunctionInternal::jacobian(), casadi::FunctionInternal::reverse(), and casadi::OnnxFunction::wrap_derivative().

◆ has_eval_dm()

virtual bool casadi::FunctionInternal::has_eval_dm ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::CallbackInternal.

Definition at line 437 of file function_internal.hpp.

437 { return false;}

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

◆ has_forward()

bool casadi::FmuFunction::has_forward ( casadi_int nfwd ) const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1608 of file fmu_function.cpp.

                                                    {
   // Only implemented if "new_forward" is enabled
   if (!new_forward_) return FunctionInternal::has_forward(nfwd);
   // Only first order analytic derivative possible
   if (!all_regular()) return false;
   // Use analytic forward derivatives
   return true;
 }

References all_regular(), casadi::FunctionInternal::has_forward(), and new_forward_.

◆ has_free()

virtual bool casadi::FunctionInternal::has_free ( ) const

inlinevirtualinherited

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

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

Definition at line 756 of file function_internal.hpp.

756 { return false;}

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

◆ has_function()

virtual bool casadi::FunctionInternal::has_function ( const std::string & fname ) const

inlinevirtualinherited

Reimplemented in casadi::OracleFunction, casadi::MapSum, and casadi::Map.

Definition at line 371 of file function_internal.hpp.

371 {return false;}

◆ has_jac_sparsity()

bool casadi::FmuFunction::has_jac_sparsity	(	casadi_int	oind,
		casadi_int	iind
	)		const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1661 of file fmu_function.cpp.

                                                                          {
   // Available in the FMU meta information
   if ((out_.at(oind).type == OutputType::REG || out_.at(oind).type == OutputType::ADJ)
       && (in_.at(iind).type == InputType::REG || in_.at(iind).type == InputType::ADJ)) {
     return true;
   }
   // Not available
   return false;
 }

References casadi::ADJ, in_, out_, and casadi::REG.

◆ has_jacobian()

bool casadi::FmuFunction::has_jacobian ( ) const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1587 of file fmu_function.cpp.

                                      {
   // Calculation of Hessian inside FmuFunction (in development)
   if (new_jacobian_ && all_vectors()) return true;
   // Only first order
   return all_regular();
 }

References all_regular(), all_vectors(), and new_jacobian_.

◆ has_memory()

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

inherited

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

inherited

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 casadi::ProtoFunction::get_options().

◆ has_reverse()

bool casadi::FmuFunction::has_reverse ( casadi_int nadj ) const

overridevirtual

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

Reimplemented from casadi::FunctionInternal.

Definition at line 1636 of file fmu_function.cpp.

                                                    {
   // Only first order analytic derivative possible
   if (!all_regular()) return false;
   // Use analytic adjoint derivatives
   return true;
 }

References all_regular().

◆ has_spfwd()

virtual bool casadi::FunctionInternal::has_spfwd ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::Rootfinder, casadi::MapSum, casadi::Map, and casadi::Integrator.

Definition at line 406 of file function_internal.hpp.

406 { return false;}

Referenced by casadi::FunctionInternal::get_jac_sparsity(), casadi::FunctionInternal::get_jac_sparsity_hierarchical_symm(), casadi::FunctionInternal::jac_sparsity(), and casadi::FunctionInternal::sp_weight().

◆ has_sprev()

virtual bool casadi::FunctionInternal::has_sprev ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::Rootfinder, casadi::MapSum, casadi::Map, and casadi::Integrator.

Definition at line 407 of file function_internal.hpp.

407 { return false;}

Referenced by casadi::FunctionInternal::get_jac_sparsity(), casadi::FunctionInternal::jac_sparsity(), and casadi::FunctionInternal::sp_weight().

◆ identify_io()

void casadi::FmuFunction::identify_io	(	std::vector< std::string > *	scheme_in,
		std::vector< std::string > *	scheme_out,
		const std::vector< std::string > &	name_in,
		const std::vector< std::string > &	name_out
	)

static

Definition at line 684 of file fmu_function.cpp.

                                           {
   // Clear returns
   if (scheme_in) scheme_in->clear();
   if (scheme_out) scheme_out->clear();
   // Parse FmuFunction inputs
   for (const std::string& n : name_in) {
     try {
       (void)InputStruct::parse(n, nullptr, scheme_in, scheme_out);
     } catch (std::exception& e) {
       casadi_error("Cannot process input " + n + ": " + std::string(e.what()));
     }
   }
   // Parse FmuFunction outputs
   for (const std::string& n : name_out) {
     try {
       (void)OutputStruct::parse(n, nullptr, scheme_in, scheme_out);
     } catch (std::exception& e) {
       casadi_error("Cannot process output " + n + ": " + std::string(e.what()));
     }
   }
   // Remove duplicates in scheme_in, also sorts alphabetically
   if (scheme_in) {
     std::set<std::string> s(scheme_in->begin(), scheme_in->end());
     scheme_in->assign(s.begin(), s.end());
   }
   // Remove duplicates in scheme_out, also sorts alphabetically
   if (scheme_out) {
     std::set<std::string> s(scheme_out->begin(), scheme_out->end());
     scheme_out->assign(s.begin(), s.end());
   }
 }

References casadi::InputStruct::parse(), and casadi::OutputStruct::parse().

Referenced by casadi::DaeBuilderInternal::fmu_fun().

◆ incache()

bool casadi::FunctionInternal::incache	(	const std::string &	fname,
		Function &	f,
		const std::string &	suffix = `""`
	)		const

inherited

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

Definition at line 1187 of file function_internal.cpp.

                                      {
     return cache_.incache(fname + ":" + suffix, f);
   }

References casadi::FunctionInternal::cache_.

Referenced by casadi::MapSum::create(), casadi::OracleFunction::create_function(), casadi::FunctionInternal::forward(), casadi::BlazingSplineFunction::get_jacobian(), casadi::FunctionInternal::jacobian(), casadi::FunctionInternal::map(), casadi::FunctionInternal::reverse(), and casadi::FunctionInternal::wrap().

◆ index_in()

casadi_int casadi::FunctionInternal::index_in ( const std::string & name ) const

inlineinherited

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

Definition at line 1162 of file function_internal.hpp.

                                                      {
       for (casadi_int i=0; i<name_in_.size(); ++i) {
         if (name_in_[i]==name) return i;
       }
       casadi_error("FunctionInternal::index_in: could not find entry \""
                    + name + "\". Available names are: " + str(name_in_) + ".");
       return -1;
     }

References casadi::str().

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

◆ index_out()

casadi_int casadi::FunctionInternal::index_out ( const std::string & name ) const

inlineinherited

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

Definition at line 1174 of file function_internal.hpp.

                                                       {
       for (casadi_int i=0; i<name_out_.size(); ++i) {
         if (name_out_[i]==name) return i;
       }
       casadi_error("FunctionInternal::index_out: could not find entry \""
                    + name + "\". Available names are: " + str(name_out_) + ".");
       return -1;
     }

References casadi::str().

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

◆ info()

Dict casadi::FunctionInternal::info ( ) const

virtualinherited

Obtain information about function

Reimplemented in casadi::Switch, casadi::OnnxFunction, and casadi::Map.

Definition at line 3271 of file function_internal.cpp.

                                     {
     return Dict();
   }

Referenced by casadi::MXFunction::export_code_body(), casadi::Blocksqp::feasibilityRestorationPhase(), casadi::Blocksqp::filterLineSearch(), casadi::Blocksqp::fullstep(), casadi::OnnxFunction::info(), casadi::BSplineInterpolant::init(), casadi::Blocksqp::kktErrorReduction(), casadi::Feasiblesqpmethod::print_iteration(), casadi::Sqpmethod::print_iteration(), casadi::Blocksqp::secondOrderCorrection(), casadi::SnoptInterface::solve(), casadi::Feasiblesqpmethod::solve(), casadi::Sqpmethod::solve(), and casadi::Sqpmethod::solve_elastic_mode().

◆ init()

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

overridevirtual

Reimplemented from casadi::ProtoFunction.

Definition at line 336 of file fmu_function.cpp.

                                        {
   // Read options
   for (auto&& op : opts) {
     if (op.first=="enable_ad") {
       casadi_warning("Option 'enable_ad' has been renamed 'uses_directional_derivatives'");
       uses_directional_derivatives_ = op.second;
     } else if (op.first=="uses_directional_derivatives") {
       uses_directional_derivatives_ = op.second;
     } else if (op.first=="nfwd") {
       nfwd_ = op.second;
     } else if (op.first=="nadj") {
       nadj_ = op.second;
     } else if (op.first=="uses_adjoint_derivatives") {
       uses_adjoint_derivatives_ = op.second;
     } else if (op.first=="validate_forward") {
       validate_forward_ = op.second;
     } else if (op.first=="validate_hessian") {
       validate_hessian_ = op.second;
     } else if (op.first=="validate_ad") {
       casadi_warning("Option 'validate_ad' has been renamed 'validate_forward'");
       validate_forward_ = op.second;
     } else if (op.first=="check_hessian") {
       casadi_warning("Option 'check_hessian' has been renamed 'validate_hessian'");
       validate_hessian_ = op.second;
     } else if (op.first=="validate_ad_file") {
       validate_ad_file_ = op.second.to_string();
     } else if (op.first=="make_symmetric") {
       make_symmetric_ = op.second;
     } else if (op.first=="step") {
       step_ = op.second;
     } else if (op.first=="fd_flip") {
       fd_flip_ = op.second;
     } else if (op.first=="abstol") {
       abstol_ = op.second;
     } else if (op.first=="reltol") {
       reltol_ = op.second;
     } else if (op.first=="parallelization") {
       parallelization_ = to_enum<Parallelization>(op.second, "serial");
     } else if (op.first=="print_progress") {
       print_progress_ = op.second;
     } else if (op.first=="new_forward") {
       new_forward_ = op.second;
     } else if (op.first=="new_jacobian") {
       new_jacobian_ = op.second;
     } else if (op.first=="new_hessian") {
       new_hessian_ = op.second;
     } else if (op.first=="hessian_coloring") {
       hessian_coloring_ = op.second;
     } else if (op.first=="asymmetric_hessian_coloring") {
       asymmetric_hessian_coloring_ = op.second;
     } else if (op.first=="enable_forward_jacobian") {
       enable_forward_jacobian_ = op.second;
     } else if (op.first=="enable_adjoint_jacobian") {
       enable_adjoint_jacobian_ = op.second;
     } else if (op.first=="enable_adjoint_hessian") {
       enable_adjoint_hessian_ = op.second;
     }
   }
  
   // Call the initialization method of the base class
   FunctionInternal::init(opts);
  
   // Read FD mode
   fd_ = to_enum<FdMode>(fd_method_, "forward");
  
   // Consistency checks
   if (uses_directional_derivatives_) casadi_assert(fmu_.provides_directional_derivatives(),
     "FMU does not provide support for analytic derivatives");
   if (validate_forward_ && !uses_directional_derivatives_) casadi_error("Inconsistent options");
   if (uses_adjoint_derivatives_) casadi_assert(fmu_.provides_adjoint_derivatives(),
     "FMU does not provide support for adjoint derivatives");
   if (enable_adjoint_jacobian_) casadi_assert(uses_adjoint_derivatives_, "Inconsistent options");
  
   // New AD validation file, if any
   if (!validate_ad_file_.empty()) {
     auto valfile_ptr = Filesystem::ofstream_ptr(validate_ad_file_);
     std::ostream& valfile = *valfile_ptr;
     valfile << "Output Input Value Nominal Min Max AD FD Step Offset Stencil" << std::endl;
   }
  
   // Quick return if no Jacobian calculation
   if (!has_jac_ && !has_adj_ && !has_hess_) return;
  
   // Parallelization
   switch (parallelization_) {
     case Parallelization::SERIAL:
       if (verbose_) casadi_message("Serial evaluation");
       break;
 #ifdef WITH_OPENMP
     case Parallelization::OPENMP:
       max_n_tasks_ = omp_get_max_threads();
       if (verbose_) casadi_message("OpenMP using at most " + str(max_n_tasks_) + " threads");
       break;
 #endif // WITH_OPENMP
 #ifdef CASADI_WITH_THREAD
     case Parallelization::THREAD:
       max_n_tasks_ = std::thread::hardware_concurrency();
       if (verbose_) casadi_message("std::thread using at most " + str(max_n_tasks_) + " threads");
       break;
 #endif // CASADI_WITH_THREAD
     default:
       casadi_warning("Parallelization " + to_string(parallelization_)
         + " not enabled during compilation. Falling back to serial evaluation");
       parallelization_ = Parallelization::SERIAL;
       break;
   }
  
   // Collect all inputs in any Jacobian, Hessian or adjoint block
   std::vector<size_t> in_jac(fmu_.n_in(), 0);
   jac_in_.clear();
   jac_nom_in_.clear();
   for (auto&& i : out_) {
     if (i.type == OutputType::JAC || i.type == OutputType::JAC_TRANS
         || i.type == OutputType::ADJ || i.type == OutputType::HESS) {
       // Get input indices
       const std::vector<size_t>& iind = fmu_.ired(i.wrt);
       // Skip if no entries
       if (iind.empty()) continue;
       // Consistency check
       bool exists = in_jac[iind.front()] > 0;
       for (size_t j : iind) casadi_assert((in_jac[j] > 0) == exists, "Jacobian not a block");
       // Add selection
       if (!exists) {
         for (size_t j : iind) {
           jac_in_.push_back(j);
           jac_nom_in_.push_back(fmu_.nominal_in(j));
           in_jac[j] = jac_in_.size();
         }
       }
       // Add column interval
       i.cbegin = in_jac[iind.front()] - 1;
       i.cend = i.cbegin + iind.size();
       // Also rows for Hessian blocks
       if (i.type == OutputType::HESS) {
         // Get input indices
         const std::vector<size_t>& iind = fmu_.ired(i.ind);
         // Skip if no entries
         if (iind.empty()) continue;
         // Consistency check
         bool exists = in_jac[iind.front()] > 0;
         for (size_t j : iind) casadi_assert((in_jac[j] > 0) == exists, "Hessian not a block");
         // Add selection
         if (!exists) {
           for (size_t j : iind) {
             jac_in_.push_back(j);
             jac_nom_in_.push_back(fmu_.nominal_in(j));
             in_jac[j] = jac_in_.size();
           }
         }
         // Add column interval
         i.rbegin = in_jac[iind.front()] - 1;
         i.rend = i.rbegin + iind.size();
       }
     }
   }
  
   // Transpose of Jacobian sparsity
   sp_trans_map_.resize(out_.size(), -1);
   sp_trans_.clear();
  
   // Collect all outputs in any Jacobian or adjoint block
   in_jac.resize(fmu_.n_out());
   std::fill(in_jac.begin(), in_jac.end(), 0);
   jac_out_.clear();
   for (size_t k = 0; k < out_.size(); ++k) {
     OutputStruct& i = out_[k];
     if (i.type == OutputType::JAC || i.type == OutputType::JAC_TRANS) {
       // Get output indices
       const std::vector<size_t>& oind = fmu_.ored(i.ind);
       // Skip if no entries
       if (oind.empty()) continue;
       // Consistency check
       bool exists = in_jac[oind.front()] > 0;
       for (size_t j : oind) casadi_assert((in_jac[j] > 0) == exists, "Jacobian not a block");
       // Add selection
       if (!exists) {
         for (size_t j : oind) {
           jac_out_.push_back(j);
           in_jac[j] = jac_out_.size();
         }
       }
       // Add row interval
       i.rbegin = in_jac[oind.front()] - 1;
       i.rend = i.rbegin + oind.size();
       // Additional memory for transpose
       if (i.type == OutputType::JAC_TRANS) {
         // Retrieve the sparsity pattern
         const Sparsity& sp = sparsity_out(k);
         // Save transpose of sparsity pattern
         sp_trans_map_.at(k) = sp_trans_.size();
         sp_trans_.push_back(sp.T());
         // Work vectors for casadi_trans
         alloc_w(sp.nnz());
         alloc_iw(sp.size2());
       }
     }
   }
   // NOTE(@jaeandersson): Make conditional !need_jac && uses_adjoint_derivatives_?
   for (auto&& i : in_) {
     if (i.type == InputType::ADJ) {
       // Get output indices
       const std::vector<size_t>& oind = fmu_.ored(i.ind);
       // Skip if no entries
       if (oind.empty()) continue;
       // Consistency check
       bool exists = in_jac[oind.front()] > 0;
       for (size_t j : oind) casadi_assert((in_jac[j] > 0) == exists, "Jacobian not a block");
       // Add selection
       if (!exists) {
         for (size_t j : oind) {
           jac_out_.push_back(j);
           in_jac[j] = jac_out_.size();
         }
       }
     }
   }
  
   // Get sparsity pattern for extended Jacobian
   jac_sp_ = fmu_.jac_sparsity(jac_out_, jac_in_);
  
   // Calculate graph coloring
   jac_colors_ = jac_sp_.uni_coloring();
   if (verbose_) casadi_message("Jacobian graph coloring: " + str(jac_sp_.size2())
     + " -> " + str(jac_colors_.size2()) + " directions");
  
   // Setup Jacobian memory
   casadi_jac_setup(&jac_prob_, jac_sp_, jac_colors_);
   jac_prob_.nom_in = get_ptr(jac_nom_in_);
   jac_prob_.map_out = get_ptr(jac_out_);
   jac_prob_.map_in = get_ptr(jac_in_);
  
   // Do not use more threads than there are colors in the Jacobian
   max_jac_tasks_ = std::min(max_n_tasks_, jac_colors_.size2());
  
   // Graph coloring for Jacobian via adjoint derivatives
   if (enable_adjoint_jacobian_) {
     // Graph coloring of the transpose of the Jacobian
     adj_sp_ = jac_sp_.T();
     adj_colors_ = adj_sp_.uni_coloring();
     if (verbose_) casadi_message("Jacobian graph coloring via adjoint derivatives: "
       + str(adj_sp_.size2()) + " -> " + str(adj_colors_.size2()) + " directions");
     // Setup Jacobian memory
     casadi_jac_setup(&adj_prob_, adj_sp_, adj_colors_);
     adj_prob_.nom_in = nullptr;  // default value (1) probably fine since no FD is used
     adj_prob_.map_out = get_ptr(jac_in_);
     adj_prob_.map_in = get_ptr(jac_out_);
     // Do not use more threads than there are colors in the Jacobian
     max_jac_tasks_ = std::max(max_jac_tasks_, std::min(max_n_tasks_, adj_colors_.size2()));
   }
  
   // Work vector for storing extended Jacobian, shared between threads
   if (has_jac_) {
     alloc_w(jac_sp_.nnz(), true);  // jac_nz
   }
  
   // Work vectors for adjoint derivative calculation, shared between threads
   if (has_adj_) {
     alloc_w(nadj_ * fmu_.n_out(), true);  // aseed
     alloc_w(nadj_ * fmu_.n_in(), true);  // asens
   }
  
   // If Hessian calculation is needed
   if (has_hess_) {
     // Get sparsity pattern for extended Hessian
     hess_sp_ = fmu_.hess_sparsity(jac_in_, jac_in_);
     casadi_assert(hess_sp_.size1() == jac_in_.size(), "Inconsistent Hessian dimensions");
     casadi_assert(hess_sp_.size2() == jac_in_.size(), "Inconsistent Hessian dimensions");
     const casadi_int *hess_row = hess_sp_.row();
     casadi_int hess_nnz = hess_sp_.nnz();
  
     // Get linearly and nonlinearly entering variables
     std::vector<bool> is_nonlin(jac_in_.size(), false);
     for (casadi_int k = 0; k < hess_nnz; ++k) is_nonlin[hess_row[k]] = true;
     nonlin_.clear();
     std::vector<casadi_int> lin;
     for (casadi_int c = 0; c < jac_in_.size(); ++c) {
       if (is_nonlin[c]) {
         nonlin_.push_back(c);
       } else {
         lin.push_back(c);
       }
     }
     // Star-coloring to calculate Hessian
     casadi_int max_hessian_colors = 0;
     if (hessian_coloring_) {
       // Star coloring
       hess_colors_ = hess_sp_.star_coloring_new(which_hess_color_);
       max_hessian_colors = hess_colors_.size2();
       if (verbose_) casadi_message("Hessian graph coloring: " + str(nonlin_.size())
         + " -> " + str(max_hessian_colors) + " directions");
       // Zero out corresponding rows (should be handled in star_coloring call)
       hess_colors_.erase(lin, range(hess_colors_.size2()));
     }
     // Unidirectional coloring to calculate Hessian
     if (asymmetric_hessian_coloring_) {
       // Both symmetric and asymmetric coloring supported
       hess_uni_colors_ = hess_sp_.uni_coloring();
       max_hessian_colors = std::max(max_hessian_colors, hess_uni_colors_.size2());
       if (verbose_) casadi_message("Hessian unidirectional coloring with "
         + str(hess_uni_colors_.size2()) + " directions");
       // Zero out corresponding rows (should be handled in uni_coloring call)
       hess_uni_colors_.erase(lin, range(hess_uni_colors_.size2()));
     }
     // Dummy coloring: One color for each nonlinear variable
     if (!hessian_coloring_ && !asymmetric_hessian_coloring_) {
       hess_uni_colors_ = Sparsity(jac_in_.size(), nonlin_.size(),
         range(nonlin_.size() + 1), nonlin_);
       max_hessian_colors = hess_uni_colors_.size2();
       if (verbose_) {
         casadi_message("Hessian calculation for " + str(nonlin_.size()) + " variables");
       }
     }
  
     // Number of threads to be used for Hessian calculation
     max_hess_tasks_ = std::min(max_n_tasks_, max_hessian_colors);
  
     // Work vector for storing extended Hessian, shared between threads
     alloc_w(hess_sp_.nnz(), true);  // hess_nz
  
     // Work vector for perturbed adjoint sensitivities
     alloc_w(max_hess_tasks_ * fmu_.n_in(), true);  // pert_asens
  
     // Work vector for making symmetric or checking symmetry
     alloc_iw(hess_sp_.size2());
   }
  
   // Total number of threads used for Jacobian/adjoint calculation
   // Note: Jacobian calculation also used for Hessian
   max_n_tasks_ = std::max(max_jac_tasks_, max_hess_tasks_);
   if (verbose_) casadi_message("Allocated memory for " + str(max_n_tasks_) + " threads");
  
   // Work vectors for Jacobian/adjoint/Hessian calculation, for each thread
   casadi_int jac_iw, jac_w;
   casadi_jac_work(&jac_prob_, &jac_iw, &jac_w);
   alloc_iw(max_n_tasks_ * jac_iw, true);
   alloc_w(max_n_tasks_ * jac_w, true);
  
   // Work vectors for Jacobian calculation via adjoint derivatives, for each thread
   if (enable_adjoint_jacobian_) {
     casadi_jac_work(&adj_prob_, &jac_iw, &jac_w);
     alloc_iw(max_n_tasks_ * jac_iw, true);
     alloc_w(max_n_tasks_ * jac_w, true);
     // Work vectors for casadi_trans
     alloc_w(jac_sp_.nnz());
     alloc_iw(jac_sp_.size2());
   }
 }

References abstol_, casadi::ADJ, adj_colors_, adj_prob_, adj_sp_, casadi::FunctionInternal::alloc_iw(), casadi::FunctionInternal::alloc_w(), asymmetric_hessian_coloring_, enable_adjoint_hessian_, enable_adjoint_jacobian_, enable_forward_jacobian_, casadi::Sparsity::erase(), fd_, fd_flip_, casadi::FunctionInternal::fd_method_, fmu_, casadi::get_ptr(), has_adj_, has_hess_, has_jac_, casadi::HESS, hess_colors_, hess_sp_, casadi::Fmu::hess_sparsity(), hess_uni_colors_, hessian_coloring_, in_, casadi::OutputStruct::ind, casadi::FunctionInternal::init(), casadi::Fmu::ired(), casadi::JAC, jac_colors_, jac_in_, jac_nom_in_, jac_out_, jac_prob_, jac_sp_, casadi::Fmu::jac_sparsity(), casadi::JAC_TRANS, make_symmetric_, casadi_jac_prob< T1 >::map_in, casadi_jac_prob< T1 >::map_out, max_hess_tasks_, max_jac_tasks_, max_n_tasks_, casadi::Fmu::n_in(), casadi::Fmu::n_out(), nadj_, new_forward_, new_hessian_, new_jacobian_, nfwd_, casadi::Sparsity::nnz(), casadi_jac_prob< T1 >::nom_in, casadi::Fmu::nominal_in(), nonlin_, casadi::Filesystem::ofstream_ptr(), casadi::OPENMP, casadi::Fmu::ored(), out_, parallelization_, print_progress_, casadi::Fmu::provides_adjoint_derivatives(), casadi::Fmu::provides_directional_derivatives(), casadi::range(), casadi::OutputStruct::rbegin, reltol_, casadi::OutputStruct::rend, casadi::Sparsity::row(), casadi::SERIAL, casadi::Sparsity::size1(), casadi::Sparsity::size2(), sp_trans_, sp_trans_map_, casadi::FunctionInternal::sparsity_out(), casadi::Sparsity::star_coloring_new(), step_, casadi::str(), casadi::Sparsity::T(), casadi::THREAD, casadi::to_string(), casadi::OutputStruct::type, casadi::Sparsity::uni_coloring(), uses_adjoint_derivatives_, uses_directional_derivatives_, validate_ad_file_, validate_forward_, validate_hessian_, casadi::ProtoFunction::verbose_, and which_hess_color_.

◆ init_mem()

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

overridevirtual

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

Reimplemented from casadi::ProtoFunction.

Definition at line 59 of file fmu_function.cpp.

                                          {
   casadi_assert(mem != nullptr, "Memory is null");
   // Instantiate base classes
   if (FunctionInternal::init_mem(mem)) return 1;
   // Number of memory instances needed
   casadi_int n_mem = std::max(static_cast<casadi_int>(1),
     std::max(max_jac_tasks_, max_hess_tasks_));
   // Initialize master and all slaves
   FmuMemory* m = static_cast<FmuMemory*>(mem);
   for (casadi_int i = 0; i < n_mem; ++i) {
     // Initialize the memory object itself or a slave
     FmuMemory* m1 = i == 0 ? m : m->slaves.at(i - 1);
     if (fmu_.init_mem(m1)) return 1;
   }
   // Reset timers
   m->n_get_all = m->n_get_directional = m->n_get_adjoint = 0;
   m->t_get_all = m->t_get_directional = m->t_get_adjoint = 0;
   // Make sure we can query stats, even before numerical evaluation
   m->stats_available = true;
   return 0;
 }

References fmu_, casadi::Fmu::init_mem(), casadi::ProtoFunction::init_mem(), max_hess_tasks_, max_jac_tasks_, casadi::FmuMemory::n_get_adjoint, casadi::FmuMemory::n_get_all, casadi::FmuMemory::n_get_directional, casadi::FmuMemory::slaves, casadi::FunctionMemory::stats_available, casadi::FmuMemory::t_get_adjoint, casadi::FmuMemory::t_get_all, and casadi::FmuMemory::t_get_directional.

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

◆ instruction_constant()

double casadi::FunctionInternal::instruction_constant ( casadi_int k ) const

virtualinherited

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

Reimplemented in casadi::SXFunction.

Definition at line 3649 of file function_internal.cpp.

                                                                   {
     casadi_error("'instruction_constant' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ instruction_id()

casadi_int casadi::FunctionInternal::instruction_id ( casadi_int k ) const

virtualinherited

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

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

Definition at line 3641 of file function_internal.cpp.

                                                                 {
     casadi_error("'instruction_id' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ instruction_input()

std::vector< casadi_int > casadi::FunctionInternal::instruction_input ( casadi_int k ) const

virtualinherited

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

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

Definition at line 3645 of file function_internal.cpp.

                                                                               {
     casadi_error("'instruction_input' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ instruction_MX()

MX casadi::FunctionInternal::instruction_MX ( casadi_int k ) const

virtualinherited

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

Reimplemented in casadi::MXFunction.

Definition at line 3657 of file function_internal.cpp.

                                                         {
     casadi_error("'instruction_MX' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ instruction_output()

std::vector< casadi_int > casadi::FunctionInternal::instruction_output ( casadi_int k ) const

virtualinherited

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

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

Definition at line 3653 of file function_internal.cpp.

                                                                                {
     casadi_error("'instruction_output' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ instructions_sx()

SX casadi::FunctionInternal::instructions_sx ( ) const

virtualinherited

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

Reimplemented in casadi::SXFunction.

Definition at line 3661 of file function_internal.cpp.

                                              {
     casadi_error("'instructions_sx' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ is_a()

bool casadi::FunctionInternal::is_a	(	const std::string &	type,
		bool	recursive
	)		const

virtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >, casadi::SXFunction, casadi::Nlpsol, casadi::MXFunction, casadi::ThreadMap, casadi::OmpMap, casadi::Map, and casadi::Conic.

Definition at line 3616 of file function_internal.cpp.

                                                                          {
     return type == "FunctionInternal";
   }

Referenced by casadi::Conic::is_a(), casadi::Map::is_a(), casadi::Nlpsol::is_a(), and casadi::XFunction< DerivedType, MatType, NodeType >::is_a().

◆ jac_is_symm()

bool casadi::FunctionInternal::jac_is_symm	(	casadi_int	oind,
		casadi_int	iind
	)		const

virtualinherited

Definition at line 1973 of file function_internal.cpp.

                                                                            {
     // If derivative expression
     if (!derivative_of_.is_null()) {
       std::string n = derivative_of_.name();
       // Reverse move
       if (name_ == "adj1_" + n) {
         if (iind == oind) return true;
       }
     }
     // Not symmetric by default
     return false;
   }

References casadi::FunctionInternal::derivative_of_, casadi::GenericShared< Shared, Internal >::is_null(), casadi::Function::name(), and casadi::ProtoFunction::name_.

◆ jac_sparsity()

Sparsity & casadi::FunctionInternal::jac_sparsity	(	casadi_int	oind,
		casadi_int	iind,
		bool	compact,
		bool	symmetric
	)		const

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_kz Get, if necessary generate, the sparsity of a Jacobian block

Definition at line 2061 of file function_internal.cpp.

                             {
 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
     // Safe access to jac_sparsity_
     std::lock_guard<std::mutex> lock(jac_sparsity_mtx_);
 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
     // If first call, allocate cache
     for (bool c : {false, true}) {
       if (jac_sparsity_[c].empty()) jac_sparsity_[c].resize(n_in_ * n_out_);
     }
     // Flat index
     casadi_int ind = iind + oind * n_in_;
     // Reference to the block
     Sparsity& jsp = jac_sparsity_[compact].at(ind);
     // If null, generate
     if (jsp.is_null()) {
       // Use (non)-compact pattern, if given
       Sparsity& jsp_other = jac_sparsity_[!compact].at(ind);
       if (!jsp_other.is_null()) {
         jsp = compact ? to_compact(oind, iind, jsp_other) : from_compact(oind, iind, jsp_other);
       } else {
         // Generate pattern
         Sparsity sp;
         bool sp_is_compact;
         if (!is_diff_out_.at(oind) || !is_diff_in_.at(iind)) {
           // All-zero sparse
           sp = Sparsity(nnz_out(oind), nnz_in(iind));
           sp_is_compact = true;
         } else {
           // Use internal routine to determine sparsity
           if (has_spfwd() || has_sprev() || has_jac_sparsity(oind, iind)) {
             sp = get_jac_sparsity(oind, iind, symmetric);
           }
           // If null, dense
           if (sp.is_null()) sp = Sparsity::dense(nnz_out(oind), nnz_in(iind));
           // Is the return the compact pattern?
           sp_is_compact = sp.size1() == nnz_out(oind) && sp.size2() == nnz_in(iind);
         }
         // Save to cache and convert if needed
         if (sp_is_compact == compact) {
           jsp = sp;
         } else {
           jsp_other = sp;
           jsp = compact ? to_compact(oind, iind, sp) : from_compact(oind, iind, sp);
         }
       }
     }
  
     // Make sure the Jacobian is symmetric if requested, cf. #1522, #3074, #3134
     if (symmetric) {
       if (compact) {
         Sparsity sp = from_compact(oind, iind, jsp);
         if (!sp.is_symmetric()) {
           sp = sp * sp.T();
           jsp = to_compact(oind, iind, sp);
         }
       } else {
         if (!jsp.is_symmetric()) jsp = jsp * jsp.T();
       }
     }
  
     // Return a reference to the block
     return jsp;
   }

Referenced by casadi::FunctionInternal::get_partition(), casadi::FunctionInternal::sp_forward_block(), and casadi::FunctionInternal::sp_reverse().

◆ jacobian()

Function casadi::FunctionInternal::jacobian ( ) const

inherited

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

Definition at line 2461 of file function_internal.cpp.

                                             {
     // Used wrapped function if jacobian not available
     if (!has_jacobian()) {
       // Derivative information must be available
       casadi_assert(has_derivative(),
                             "Derivatives cannot be calculated for " + name_);
       return wrap().jacobian();
     }
     // Retrieve/generate cached
     Function f;
     std::string fname = "jac_" + name_;
     if (!incache(fname, f)) {
       // Names of inputs
       std::vector<std::string> inames;
       for (casadi_int i=0; i<n_in_; ++i) inames.push_back(name_in_[i]);
       for (casadi_int i=0; i<n_out_; ++i) inames.push_back("out_" + name_out_[i]);
       // Names of outputs
       std::vector<std::string> onames;
       onames.reserve(n_in_ * n_out_);
       for (size_t oind = 0; oind < n_out_; ++oind) {
         for (size_t iind = 0; iind < n_in_; ++iind) {
           onames.push_back("jac_" + name_out_[oind] + "_" + name_in_[iind]);
         }
       }
       // Options
       Dict opts = combine(jacobian_options_, der_options_);
       opts["derivative_of"] = self();
       // Generate derivative function
       casadi_assert_dev(enable_jacobian_);
       f = get_jacobian(fname, inames, onames, opts);
       // Consistency checks
       casadi_assert(f.n_in() == inames.size(),
         "Mismatching input signature, expected " + str(inames));
       casadi_assert(f.n_out() == onames.size(),
         "Mismatching output signature, expected " + str(onames));
       // Save to cache
       tocache_if_missing(f);
     }
     return f;
   }

Referenced by casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::call_reverse(), and casadi::Function::jacobian().

◆ jit_dependencies()

virtual void casadi::FunctionInternal::jit_dependencies ( const std::string & fname )

inlinevirtualinherited

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

Reimplemented in casadi::OracleFunction.

Definition at line 950 of file function_internal.hpp.

950 {}

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

◆ map()

Function casadi::FunctionInternal::map	(	casadi_int	n,
		const std::string &	parallelization
	)		const

inherited

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

Definition at line 1200 of file function_internal.cpp.

                                                                                      {
     Function f;
     if (parallelization=="serial") {
       // Serial maps are cached
       std::string fname = "map" + str(n) + "_" + name_;
       if (!incache(fname, f)) {
         // Create new serial map
         f = Map::create(parallelization, self(), n);
         casadi_assert_dev(f.name()==fname);
         // Save in cache
         tocache_if_missing(f);
       }
     } else {
       // Non-serial maps are not cached
       f = Map::create(parallelization, self(), n);
     }
     return f;
   }

References casadi::Map::create(), casadi::FunctionInternal::incache(), casadi::Function::name(), casadi::ProtoFunction::name_, casadi::str(), and casadi::FunctionInternal::tocache_if_missing().

Referenced by casadi::Dple::get_forward(), casadi::Dple::get_reverse(), and casadi::FunctionInternal::mapsum_mx().

◆ mapsum_mx()

std::vector< MX > casadi::FunctionInternal::mapsum_mx	(	const std::vector< MX > &	arg,
		const std::string &	parallelization
	)

inherited

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

Definition at line 3670 of file function_internal.cpp.

                                                                 {
     if (x.empty()) return x;
     // Check number of arguments
     casadi_assert(x.size()==n_in_, "mapsum_mx: Wrong number_i of arguments");
     // Number of parallel calls
     casadi_int npar = 1;
     // Check/replace arguments
     std::vector<MX> x_mod(x.size());
     for (casadi_int i=0; i<n_in_; ++i) {
       if (check_mat(x[i].sparsity(), sparsity_in_[i], npar)) {
         x_mod[i] = replace_mat(x[i], sparsity_in_[i], npar);
       } else {
         // Mismatching sparsity: The following will throw an error message
         npar = 0;
         check_arg(x, npar);
       }
     }
  
     casadi_int n = 1;
     for (casadi_int i=0; i<x_mod.size(); ++i) {
       n = std::max(x_mod[i].size2() / size2_in(i), n);
     }
  
     std::vector<casadi_int> reduce_in;
     for (casadi_int i=0; i<x_mod.size(); ++i) {
       if (x_mod[i].size2()/size2_in(i)!=n) {
         reduce_in.push_back(i);
       }
     }
  
     Function ms = self().map("mapsum", parallelization, n, reduce_in, range(n_out_));
  
     // Call the internal function
     return ms(x_mod);
   }

References casadi::FunctionInternal::check_arg(), casadi::FunctionInternal::check_mat(), casadi::FunctionInternal::map(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, casadi::range(), casadi::replace_mat(), casadi::FunctionInternal::size2_in(), and casadi::FunctionInternal::sparsity_in_.

◆ matching_arg()

template<typename M >

bool casadi::FunctionInternal::matching_arg	(	const std::vector< M > &	arg,
		casadi_int &	npar
	)		const

inherited

Raises errors

Parameters

	npar[in]	normal usage: 1, disallow pararallel calls: -1
[out]	npar	max number of horizontal repetitions across all arguments (or -1)

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

Definition at line 1808 of file function_internal.hpp.

                                                                                      {
     check_arg(arg, npar);
     for (casadi_int i=0; i<n_in_; ++i) {
       if (arg.at(i).size1()!=size1_in(i)) return false;
       if (arg.at(i).size2()!=size2_in(i) && arg.at(i).size2()!=npar*size2_in(i)) return false;
     }
     return true;
   }

References casadi::FunctionInternal::check_arg(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::size1_in(), and casadi::FunctionInternal::size2_in().

Referenced by casadi::MXFunction::ad_forward(), casadi::SXFunction::ad_forward(), casadi::FunctionInternal::call(), casadi::FunctionInternal::call_forward(), and casadi::FunctionInternal::nz_in().

◆ matching_res()

template<typename M >

bool casadi::FunctionInternal::matching_res	(	const std::vector< M > &	arg,
		casadi_int &	npar
	)		const

inherited

Raises errors

Parameters

	npar[in]	normal usage: 1, disallow pararallel calls: -1
[out]	npar	max number of horizontal repetitions across all arguments (or -1)

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

Definition at line 1818 of file function_internal.hpp.

                                                                                      {
     check_res(res, npar);
     for (casadi_int i=0; i<n_out_; ++i) {
       if (res.at(i).size1()!=size1_out(i)) return false;
       if (res.at(i).size2()!=size2_out(i) && res.at(i).size2()!=npar*size2_out(i)) return false;
     }
     return true;
   }

References casadi::FunctionInternal::check_res(), casadi::FunctionInternal::n_out_, casadi::FunctionInternal::size1_out(), and casadi::FunctionInternal::size2_out().

Referenced by casadi::MXFunction::ad_reverse(), casadi::SXFunction::ad_reverse(), casadi::FunctionInternal::call_reverse(), and casadi::FunctionInternal::nz_out().

◆ memory()

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

inherited

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

◆ merge()

void casadi::FunctionInternal::merge	(	const std::vector< MX > &	arg,
		std::vector< MX > &	subs_from,
		std::vector< MX > &	subs_to
	)		const

virtualinherited

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

Reimplemented in casadi::BlazingSplineFunction.

Definition at line 3620 of file function_internal.cpp.

3621 {

3622 }

◆ mx_in() [1/2]

const std::vector< MX > casadi::FunctionInternal::mx_in ( ) const

virtualinherited

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

Reimplemented in casadi::MXFunction.

Definition at line 3600 of file function_internal.cpp.

                                                     {
     std::vector<MX> ret(n_in_);
     for (casadi_int i=0; i<ret.size(); ++i) {
       ret[i] = mx_in(i);
     }
     return ret;
   }

References casadi::FunctionInternal::n_in_.

Referenced by casadi::Nlpsol::get_forward(), casadi::LinearInterpolantJac::get_jacobian(), casadi::Nlpsol::get_reverse(), casadi::FunctionInternal::wrap(), and casadi::FunctionInternal::wrap_as_needed().

◆ mx_in() [2/2]

const MX casadi::FunctionInternal::mx_in ( casadi_int ind ) const

virtualinherited

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

Reimplemented in casadi::MXFunction.

Definition at line 3592 of file function_internal.cpp.

                                                        {
     return MX::sym(name_in_.at(ind), sparsity_in(ind));
   }

References casadi::FunctionInternal::name_in_, casadi::FunctionInternal::sparsity_in(), and casadi::GenericMatrix< MX >::sym().

◆ mx_out() [1/2]

const std::vector< MX > casadi::FunctionInternal::mx_out ( ) const

virtualinherited

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

Definition at line 3608 of file function_internal.cpp.

                                                      {
     std::vector<MX> ret(n_out_);
     for (casadi_int i=0; i<ret.size(); ++i) {
       ret[i] = mx_out(i);
     }
     return ret;
   }

References casadi::FunctionInternal::n_out_.

Referenced by casadi::Nlpsol::get_forward(), and casadi::Nlpsol::get_reverse().

◆ mx_out() [2/2]

const MX casadi::FunctionInternal::mx_out ( casadi_int ind ) const

virtualinherited

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

Definition at line 3596 of file function_internal.cpp.

                                                         {
     return MX::sym(name_out_.at(ind), sparsity_out(ind));
   }

References casadi::FunctionInternal::name_out_, casadi::FunctionInternal::sparsity_out(), and casadi::GenericMatrix< MX >::sym().

◆ n_instructions()

casadi_int casadi::FunctionInternal::n_instructions ( ) const

virtualinherited

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

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

Definition at line 3637 of file function_internal.cpp.

                                                     {
     casadi_error("'n_instructions' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ n_nodes()

casadi_int casadi::FunctionInternal::n_nodes ( ) const

virtualinherited

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

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

Definition at line 3665 of file function_internal.cpp.

                                              {
     casadi_error("'n_nodes' not defined for " + class_name());
   }

References casadi::SharedObjectInternal::class_name().

◆ nnz_in() [1/2]

casadi_int casadi::FunctionInternal::nnz_in ( ) const

inherited

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

Definition at line 2420 of file function_internal.cpp.

                                             {
     casadi_int ret=0;
     for (casadi_int iind=0; iind<n_in_; ++iind) ret += nnz_in(iind);
     return ret;
   }

References casadi::FunctionInternal::n_in_.

◆ nnz_in() [2/2]

casadi_int casadi::FunctionInternal::nnz_in ( casadi_int ind ) const

inlineinherited

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

Definition at line 1010 of file function_internal.hpp.

1010 { return sparsity_in(ind).nnz(); }

◆ nnz_out() [1/2]

casadi_int casadi::FunctionInternal::nnz_out ( ) const

inherited

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

Definition at line 2426 of file function_internal.cpp.

                                              {
     casadi_int ret=0;
     for (casadi_int oind=0; oind<n_out_; ++oind) ret += nnz_out(oind);
     return ret;
   }

References casadi::FunctionInternal::n_out_.

◆ nnz_out() [2/2]

casadi_int casadi::FunctionInternal::nnz_out ( casadi_int ind ) const

inlineinherited

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

Definition at line 1012 of file function_internal.hpp.

1012 { return sparsity_out(ind).nnz(); }

◆ numel_in() [1/2]

casadi_int casadi::FunctionInternal::numel_in ( ) const

inherited

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

Definition at line 2432 of file function_internal.cpp.

                                               {
     casadi_int ret=0;
     for (casadi_int iind=0; iind<n_in_; ++iind) ret += numel_in(iind);
     return ret;
   }

References casadi::FunctionInternal::n_in_.

Referenced by casadi::FunctionInternal::from_compact(), and casadi::Integrator::get_reverse().

◆ numel_in() [2/2]

casadi_int casadi::FunctionInternal::numel_in ( casadi_int ind ) const

inlineinherited

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

Definition at line 1020 of file function_internal.hpp.

1020 { return sparsity_in(ind).numel(); }

casadi::Sparsity::numel

casadi_int numel() const

The total number of elements, including structural zeros, i.e. size2()*size1()

Definition: sparsity.cpp:132

◆ numel_out() [1/2]

casadi_int casadi::FunctionInternal::numel_out ( ) const

inherited

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

Definition at line 2438 of file function_internal.cpp.

                                                {
     casadi_int ret=0;
     for (casadi_int oind=0; oind<n_out_; ++oind) ret += numel_out(oind);
     return ret;
   }

References casadi::FunctionInternal::n_out_.

Referenced by casadi::FunctionInternal::from_compact(), and casadi::Integrator::get_reverse().

◆ numel_out() [2/2]

casadi_int casadi::FunctionInternal::numel_out ( casadi_int ind ) const

inlineinherited

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

Definition at line 1021 of file function_internal.hpp.

1021 { return sparsity_out(ind).numel(); }

◆ nz_in() [1/2]

std::vector< double > casadi::FunctionInternal::nz_in ( const std::vector< DM > & arg ) const

inherited

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

Definition at line 3760 of file function_internal.cpp.

                                                                           {
     // Disallow parallel inputs
     casadi_int npar = -1;
     if (!matching_arg(arg, npar)) {
       return nz_in(replace_arg(arg, npar));
     }
  
     std::vector<DM> arg2 = project_arg(arg, 1);
     std::vector<double> ret(nnz_in());
     casadi_int offset = 0;
     for (casadi_int i=0;i<n_in_;++i) {
       const double* e = arg2.at(i).ptr();
       std::copy(e, e+nnz_in(i), ret.begin()+offset);
       offset+= nnz_in(i);
     }
     return ret;
   }

References casadi::FunctionInternal::matching_arg(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::nnz_in(), casadi::FunctionInternal::project_arg(), and casadi::FunctionInternal::replace_arg().

Referenced by casadi::SXFunction::call_activity(), casadi::SXFunction::call_fwd(), casadi::SXFunction::call_rev(), casadi::SXFunction::call_setup(), casadi::FunctionInternal::get_jac_sparsity(), casadi::FunctionInternal::get_jac_sparsity_gen(), and casadi::FunctionInternal::get_jac_sparsity_hierarchical().

◆ nz_in() [2/2]

std::vector< DM > casadi::FunctionInternal::nz_in ( const std::vector< double > & arg ) const

inherited

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

Definition at line 3730 of file function_internal.cpp.

                                                                           {
     casadi_assert(nnz_in()==arg.size(),
       "Dimension mismatch. Expecting " + str(nnz_in()) +
       ", got " + str(arg.size()) + " instead.");
  
     std::vector<DM> ret = dm_in();
     casadi_int offset = 0;
     for (casadi_int i=0;i<n_in_;++i) {
       DM& r = ret.at(i);
       std::copy(arg.begin()+offset, arg.begin()+offset+nnz_in(i), r.ptr());
       offset+= nnz_in(i);
     }
     return ret;
   }

References casadi::FunctionInternal::dm_in(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::nnz_in(), casadi::Matrix< Scalar >::ptr(), and casadi::str().

◆ nz_out() [1/2]

std::vector< double > casadi::FunctionInternal::nz_out ( const std::vector< DM > & res ) const

inherited

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

Definition at line 3778 of file function_internal.cpp.

                                                                            {
     // Disallow parallel inputs
     casadi_int npar = -1;
     if (!matching_res(res, npar)) {
       return nz_out(replace_res(res, npar));
     }
  
     std::vector<DM> res2 = project_res(res, 1);
     std::vector<double> ret(nnz_out());
     casadi_int offset = 0;
     for (casadi_int i=0;i<n_out_;++i) {
       const double* e = res2.at(i).ptr();
       std::copy(e, e+nnz_out(i), ret.begin()+offset);
       offset+= nnz_out(i);
     }
     return ret;
   }

References casadi::FunctionInternal::matching_res(), casadi::FunctionInternal::n_out_, casadi::FunctionInternal::nnz_out(), casadi::FunctionInternal::project_res(), and casadi::FunctionInternal::replace_res().

Referenced by casadi::SXFunction::call_activity(), casadi::SXFunction::call_fwd(), casadi::SXFunction::call_rev(), casadi::SXFunction::call_setup(), casadi::FunctionInternal::get_jac_sparsity(), casadi::FunctionInternal::get_jac_sparsity_gen(), and casadi::FunctionInternal::get_jac_sparsity_hierarchical().

◆ nz_out() [2/2]

std::vector< DM > casadi::FunctionInternal::nz_out ( const std::vector< double > & res ) const

inherited

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

Definition at line 3745 of file function_internal.cpp.

                                                                            {
     casadi_assert(nnz_out()==res.size(),
       "Dimension mismatch. Expecting " + str(nnz_out()) +
       ", got " + str(res.size()) + " instead.");
  
     std::vector<DM> ret = dm_out();
     casadi_int offset = 0;
     for (casadi_int i=0;i<n_out_;++i) {
       DM& r = ret.at(i);
       std::copy(res.begin()+offset, res.begin()+offset+nnz_out(i), r.ptr());
       offset+= nnz_out(i);
     }
     return ret;
   }

References casadi::FunctionInternal::dm_out(), casadi::FunctionInternal::n_out_, casadi::FunctionInternal::nnz_out(), casadi::Matrix< Scalar >::ptr(), and casadi::str().

◆ open_trace()

std::unique_ptr< std::ostream > casadi::FunctionInternal::open_trace	(	const double **	arg,
		casadi_int	dump_id
	)		const

protectedinherited

Definition at line 847 of file function_internal.cpp.

                                                            {
     if (dump_id < 0) dump_id = get_dump_id();
     std::stringstream filename;
     filename << dump_dir_ << filesep() << name_ << "." << std::setfill('0')
              << std::setw(6) << dump_id << ".trace.jsonl";
     auto output = Filesystem::ofstream_ptr(filename.str());
     std::ostream& trace = *output;
     normalized_setup(trace);
     trace << "{\"event\":\"header\",\"format\":\"casadi_trace\",\"version\":1,"
           << "\"function\":\"" << name_ << "\",\"type\":\"" << class_name()
           << "\",\"dump_id\":" << dump_id << "}\n";
     trace << "{\"event\":\"inputs\",\"values\":[";
     for (casadi_int i = 0; i < n_in_; ++i) {
       if (i) trace << ",";
       trace_values(trace, arg[i], nnz_in(i));
     }
     trace << "]}\n";
     return output;
   }

References casadi::SharedObjectInternal::class_name(), casadi::FunctionInternal::dump_dir_, casadi::filename(), casadi::filesep(), casadi::FunctionInternal::n_in_, casadi::ProtoFunction::name_, casadi::FunctionInternal::nnz_in(), casadi::normalized_setup(), casadi::Filesystem::ofstream_ptr(), and casadi::FunctionInternal::trace_values().

Referenced by casadi::MXFunction::eval(), and casadi::SXFunction::eval().

◆ oracle()

const Function & casadi::FunctionInternal::oracle ( ) const

virtualinherited

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

Reimplemented in casadi::OracleFunction.

Definition at line 3997 of file function_internal.cpp.

                                                  {
     casadi_error("'oracle' not defined for " + class_name());
     static Function singleton;
     return singleton;
   }

References casadi::SharedObjectInternal::class_name().

Referenced by casadi::Function::oracle(), and casadi::DaeBuilder::oracle().

◆ print()

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

inherited

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

◆ print_canonical() [1/3]

void casadi::FunctionInternal::print_canonical	(	std::ostream &	stream,
		casadi_int	sz,
		const double *	nz
	)

staticinherited

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

Definition at line 966 of file function_internal.cpp.

                                                                                             {
     StreamStateGuard backup(stream);
     normalized_setup(stream);
     if (nz) {
       stream << "[";
       for (casadi_int i=0; i<sz; ++i) {
         if (i>0) stream << ", ";
         normalized_out(stream, nz[i]);
       }
       stream << "]";
     } else {
       stream << "NULL";
     }
   }

References casadi::normalized_out(), and casadi::normalized_setup().

◆ print_canonical() [2/3]

void casadi::FunctionInternal::print_canonical	(	std::ostream &	stream,
		const Sparsity &	sp,
		const double *	nz
	)

staticinherited

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

Definition at line 981 of file function_internal.cpp.

                                             {
     StreamStateGuard backup(stream);
     normalized_setup(stream);
     if (nz) {
       if (!sp.is_scalar(true)) {
         stream << sp.dim(false) << ": ";
         stream << "[";
       }
       for (casadi_int i=0; i<sp.nnz(); ++i) {
         if (i>0) stream << ", ";
         normalized_out(stream, nz[i]);
       }
       if (!sp.is_scalar(true)) {
         stream << "]";
         if (!sp.is_dense()) {
           stream << ", colind: [";
           for (casadi_int i=0; i<sp.size2()+1; ++i) {
             if (i>0) stream << ", ";
             stream << sp.colind()[i];
           }
           stream << "]";
           stream << ", row: [";
           for (casadi_int i=0; i<sp.nnz(); ++i) {
             if (i>0) stream << ", ";
             stream << sp.row()[i];
           }
           stream << "]";
         }
       }
     } else {
       stream << "NULL";
     }
   }

References casadi::Sparsity::colind(), casadi::Sparsity::dim(), casadi::Sparsity::is_dense(), casadi::Sparsity::is_scalar(), casadi::Sparsity::nnz(), casadi::normalized_out(), casadi::normalized_setup(), casadi::Sparsity::row(), and casadi::Sparsity::size2().

Referenced by casadi::Monitor::eval(), casadi::MXFunction::print_arg(), casadi::SXFunction::print_arg(), casadi::FunctionInternal::print_in(), casadi::FunctionInternal::print_out(), casadi::MXFunction::print_res(), and casadi::SXFunction::print_res().

◆ print_canonical() [3/3]

void casadi::FunctionInternal::print_canonical	(	std::ostream &	stream,
		double	a
	)

staticinherited

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

Definition at line 1016 of file function_internal.cpp.

                                                                      {
     StreamStateGuard backup(stream);
     normalized_setup(stream);
     normalized_out(stream, a);
   }

References casadi::normalized_out(), and casadi::normalized_setup().

◆ print_dimensions()

void casadi::FunctionInternal::print_dimensions ( std::ostream & stream ) const

inherited

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

Definition at line 1092 of file function_internal.cpp.

                                                                   {
     stream << " Number of inputs: " << n_in_ << std::endl;
     for (casadi_int i=0; i<n_in_; ++i) {
       stream << "  Input " << i  << " (\"" << name_in_[i] << "\"): "
              << sparsity_in_[i].dim() << std::endl;
     }
     stream << " Number of outputs: " << n_out_ << std::endl;
     for (casadi_int i=0; i<n_out_; ++i) {
       stream << "  Output " << i  << " (\"" << name_out_[i] << "\"): "
              << sparsity_out_[i].dim() << std::endl;
     }
   }

References casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::name_out_, casadi::FunctionInternal::sparsity_in_, and casadi::FunctionInternal::sparsity_out_.

◆ print_in()

void casadi::FunctionInternal::print_in	(	std::ostream &	stream,
		const double **	arg,
		bool	truncate
	)		const

inherited

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

Definition at line 932 of file function_internal.cpp.

                                                                                              {
     stream << "Function " << name_ << " (" << this << ")" << std::endl;
     for (casadi_int i=0; i<n_in_; ++i) {
       stream << "Input " << i << " (" << name_in_[i] << "): ";
       if (arg[i]) {
         if (print_canonical_) {
           print_canonical(stream, sparsity_in_[i], arg[i]);
         } else {
           DM::print_default(stream, sparsity_in_[i], arg[i], truncate);
         }
         stream << std::endl;
       } else {
         stream << "NULL" << std::endl;
       }
     }
   }

References casadi::FunctionInternal::n_in_, casadi::ProtoFunction::name_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::print_canonical(), casadi::FunctionInternal::print_canonical_, casadi::Matrix< double >::print_default(), and casadi::FunctionInternal::sparsity_in_.

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

◆ print_option()

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

inherited

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 casadi::ProtoFunction::get_options(), and casadi::Options::print_one().

◆ print_options()

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

inherited

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 casadi::ProtoFunction::get_options(), and casadi::Options::print_all().

◆ print_out()

void casadi::FunctionInternal::print_out	(	std::ostream &	stream,
		double **	res,
		bool	truncate
	)		const

inherited

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

Definition at line 949 of file function_internal.cpp.

                                                                                         {
     stream << "Function " << name_ << " (" << this << ")" << std::endl;
     for (casadi_int i=0; i<n_out_; ++i) {
       stream << "Output " << i << " (" << name_out_[i] << "): ";
       if (res[i]) {
         if (print_canonical_) {
           print_canonical(stream, sparsity_out_[i], res[i]);
         } else {
           DM::print_default(stream, sparsity_out_[i], res[i], truncate);
         }
         stream << std::endl;
       } else {
         stream << "NULL" << std::endl;
       }
     }
   }

References casadi::FunctionInternal::n_out_, casadi::ProtoFunction::name_, casadi::FunctionInternal::name_out_, casadi::FunctionInternal::print_canonical(), casadi::FunctionInternal::print_canonical_, casadi::Matrix< double >::print_default(), and casadi::FunctionInternal::sparsity_out_.

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

◆ print_time()

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

inherited

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 casadi::ProtoFunction::format_time(), casadi::ProtoFunction::name_, casadi::ProtoFunction::print(), casadi::ProtoFunction::print_time_, and casadi::ProtoFunction::sprint().

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

◆ project_arg()

template<typename M >

std::vector< M > casadi::FunctionInternal::project_arg	(	const std::vector< M > &	arg,
		casadi_int	npar
	)		const

inherited

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

Definition at line 1680 of file function_internal.hpp.

                                                               {
     casadi_assert_dev(arg.size()==n_in_);
  
     // Which arguments require mapped evaluation
     std::vector<bool> mapped(n_in_);
     for (casadi_int i=0; i<n_in_; ++i) {
       mapped[i] = arg[i].size2()!=size2_in(i);
     }
  
     // Check if matching input sparsity
     std::vector<bool> matching(n_in_);
     bool any_mismatch = false;
     for (casadi_int i=0; i<n_in_; ++i) {
       if (mapped[i]) {
         matching[i] = arg[i].sparsity().is_stacked(sparsity_in(i), npar);
       } else {
         matching[i] = arg[i].sparsity()==sparsity_in(i);
       }
       any_mismatch = any_mismatch || !matching[i];
     }
  
     // Correct input sparsity
     if (any_mismatch) {
       std::vector<M> arg2(arg);
       for (casadi_int i=0; i<n_in_; ++i) {
         if (!matching[i]) {
           if (mapped[i]) {
             arg2[i] = project(arg2[i], repmat(sparsity_in(i), 1, npar));
           } else {
             arg2[i] = project(arg2[i], sparsity_in(i));
           }
         }
       }
       return arg2;
     }
     return arg;
   }

References casadi::FunctionInternal::n_in_, casadi::FunctionInternal::size2_in(), and casadi::FunctionInternal::sparsity_in().

Referenced by casadi::FunctionInternal::call_gen(), and casadi::FunctionInternal::nz_in().

◆ project_res()

template<typename M >

std::vector< M > casadi::FunctionInternal::project_res	(	const std::vector< M > &	arg,
		casadi_int	npar
	)		const

inherited

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

Definition at line 1720 of file function_internal.hpp.

                                                                 {
       return arg;
   }

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

◆ purgable()

template<typename MatType >

bool casadi::FunctionInternal::purgable ( const std::vector< MatType > & seed )

staticinherited

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

Definition at line 1573 of file function_internal.hpp.

                                                              {
     for (auto i=v.begin(); i!=v.end(); ++i) {
       if (!i->is_zero()) return false;
     }
     return true;
   }

Referenced by casadi::MXFunction::ad_forward(), and casadi::MXFunction::ad_reverse().

◆ release()

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

inherited

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

◆ replace_arg()

template<typename M >

std::vector< M > casadi::FunctionInternal::replace_arg	(	const std::vector< M > &	arg,
		casadi_int	npar
	)		const

inherited

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

Definition at line 1855 of file function_internal.hpp.

                                                               {
     std::vector<M> r(arg.size());
     for (casadi_int i=0; i<r.size(); ++i) r[i] = replace_mat(arg[i], sparsity_in(i), npar);
     return r;
   }

References casadi::replace_mat(), and casadi::FunctionInternal::sparsity_in().

Referenced by casadi::FunctionInternal::call(), casadi::FunctionInternal::nz_in(), and casadi::FunctionInternal::replace_fseed().

◆ replace_aseed() [1/2]

template<typename M >

std::vector<std::vector<M> > casadi::FunctionInternal::replace_aseed	(	const std::vector< std::vector< M > > &	aseed,
		casadi_int	npar
	)		const

inherited

Definition at line 1879 of file function_internal.hpp.

                                                                               {
     std::vector<std::vector<M> > r(aseed.size());
     for (casadi_int d=0; d<r.size(); ++d) r[d] = replace_res(aseed[d], npar);
     return r;
   }

References casadi::FunctionInternal::replace_res().

◆ replace_aseed() [2/2]

template<typename M >

std::vector<std::vector<M> > casadi::FunctionInternal::replace_aseed	(	const std::vector< std::vector< M >> &	aseed,
		casadi_int	npar
	)		const

inherited

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

Referenced by casadi::MXFunction::ad_reverse(), casadi::SXFunction::ad_reverse(), and casadi::FunctionInternal::call_reverse().

◆ replace_fseed() [1/2]

template<typename M >

std::vector<std::vector<M> > casadi::FunctionInternal::replace_fseed	(	const std::vector< std::vector< M > > &	fseed,
		casadi_int	npar
	)		const

inherited

Definition at line 1871 of file function_internal.hpp.

                                                                               {
     std::vector<std::vector<M> > r(fseed.size());
     for (casadi_int d=0; d<r.size(); ++d) r[d] = replace_arg(fseed[d], npar);
     return r;
   }

References casadi::FunctionInternal::replace_arg().

◆ replace_fseed() [2/2]

template<typename M >

std::vector<std::vector<M> > casadi::FunctionInternal::replace_fseed	(	const std::vector< std::vector< M >> &	fseed,
		casadi_int	npar
	)		const

inherited

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

Referenced by casadi::MXFunction::ad_forward(), casadi::SXFunction::ad_forward(), and casadi::FunctionInternal::call_forward().

◆ replace_res()

template<typename M >

std::vector< M > casadi::FunctionInternal::replace_res	(	const std::vector< M > &	res,
		casadi_int	npar
	)		const

inherited

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

Definition at line 1863 of file function_internal.hpp.

                                                               {
     std::vector<M> r(res.size());
     for (casadi_int i=0; i<r.size(); ++i) r[i] = replace_mat(res[i], sparsity_out(i), npar);
     return r;
   }

References casadi::replace_mat(), and casadi::FunctionInternal::sparsity_out().

Referenced by casadi::FunctionInternal::nz_out(), and casadi::FunctionInternal::replace_aseed().

◆ reset_dump_count()

void casadi::FunctionInternal::reset_dump_count ( )

inherited

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

Definition at line 471 of file function_internal.cpp.

                                           {
     dump_count_ = 0;
   }

References casadi::FunctionInternal::dump_count_.

◆ reverse()

Function casadi::FunctionInternal::reverse ( casadi_int nadj ) const

inherited

reverse(nadj) returns a cached instance if available, and calls Function get_reverse(casadi_int nadj) if no cached version is available.

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

Definition at line 2343 of file function_internal.cpp.

                                                           {
     casadi_assert_dev(nadj>=0);
     // Used wrapped function if reverse not available
     if (!enable_reverse_) {
       // Derivative information must be available
       casadi_assert(has_derivative(), "Derivatives cannot be calculated for " + name_);
       return wrap().reverse(nadj);
     }
     // Retrieve/generate cached
     Function f;
     std::string fname = reverse_name(name_, nadj);
     if (!incache(fname, f)) {
       casadi_int i;
       // Prefix to be used for adjoint seeds, sensitivities
       std::string pref = diff_prefix("adj");
       // Names of inputs
       std::vector<std::string> inames;
       for (i=0; i<n_in_; ++i) inames.push_back(name_in_[i]);
       for (i=0; i<n_out_; ++i) inames.push_back("out_" + name_out_[i]);
       for (i=0; i<n_out_; ++i) inames.push_back(pref + name_out_[i]);
       // Names of outputs
       std::vector<std::string> onames;
       for (casadi_int i=0; i<n_in_; ++i) onames.push_back(pref + name_in_[i]);
       // Options
       Dict opts = combine(reverse_options_, der_options_);
       opts = combine(opts, generate_options("reverse"));
       opts["derivative_of"] = self();
       // Generate derivative function
       casadi_assert_dev(enable_reverse_);
       f = get_reverse(nadj, fname, inames, onames, opts);
       // Consistency check for inputs
       casadi_assert_dev(f.n_in()==n_in_ + n_out_ + n_out_);
       casadi_int ind=0;
       for (i=0; i<n_in_; ++i) f.assert_size_in(ind++, size1_in(i), size2_in(i));
       for (i=0; i<n_out_; ++i) f.assert_size_in(ind++, size1_out(i), size2_out(i));
       for (i=0; i<n_out_; ++i) f.assert_size_in(ind++, size1_out(i), nadj*size2_out(i));
       // Consistency check for outputs
       casadi_assert_dev(f.n_out()==n_in_);
       for (i=0; i<n_in_; ++i) f.assert_sparsity_out(i, sparsity_in(i), nadj);
       // Save to cache
       tocache_if_missing(f);
     }
     return f;
   }

Referenced by casadi::FunctionInternal::call_reverse(), and casadi::Function::reverse().

◆ reverse_name()

static std::string casadi::FunctionInternal::reverse_name	(	const std::string &	fcn,
		casadi_int	nadj
	)

inlinestaticinherited

Definition at line 675 of file function_internal.hpp.

                                                                          {
       return "adj" + str(nadj) + "_" + fcn;
     }

References casadi::str().

Referenced by casadi::FunctionInternal::reverse(), and casadi::FixedStepIntegrator::stepB().

◆ self()

Function casadi::FunctionInternal::self ( ) const

inlineinherited

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

Definition at line 355 of file function_internal.hpp.

355 { return shared_from_this<Function>();}

Referenced by casadi::casadi_uno_term_cb_cpp(), casadi::ConoptInterface::cb_2dlagrstr(), casadi::ConoptInterface::cb_2dlagrval(), casadi::ConoptInterface::cb_fd_eval(), casadi::ConoptInterface::cb_fdevalini(), casadi::ConoptInterface::cb_progress(), and casadi::ConoptInterface::cb_read_matrix().

◆ serialize()

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

inherited

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 casadi::ProtoFunction::serialize_body(), and casadi::ProtoFunction::serialize_type().

◆ serialize_base_function()

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

inlinevirtualinherited

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::FmuFunction::serialize_body ( SerializingStream & s ) const

overridevirtual

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

Reimplemented from casadi::ProtoFunction.

Definition at line 1703 of file fmu_function.cpp.

                                                            {
   FunctionInternal::serialize_body(s);
   s.version("FmuFunction", 6);
  
   s.pack("FmuFunction::Fmu", fmu_);
  
   casadi_assert_dev(in_.size()==n_in_);
   for (const InputStruct& e : in_) {
     s.pack("FmuFunction::in::type", static_cast<int>(e.type));
     s.pack("FmuFunction::in::ind", e.ind);
   }
   casadi_assert_dev(out_.size()==n_out_);
   for (const OutputStruct& e : out_) {
     s.pack("FmuFunction::out::type", static_cast<int>(e.type));
     s.pack("FmuFunction::out::ind", e.ind);
     s.pack("FmuFunction::out::wrt", e.wrt);
     s.pack("FmuFunction::out::rbegin", e.rbegin);
     s.pack("FmuFunction::out::rend", e.rend);
     s.pack("FmuFunction::out::cbegin", e.cbegin);
     s.pack("FmuFunction::out::cend", e.cend);
   }
   s.pack("FmuFunction::jac_in", jac_in_);
   s.pack("FmuFunction::jac_out", jac_out_);
   s.pack("FmuFunction::jac_nom_in", jac_nom_in_);
   s.pack("FmuFunction::sp_trans", sp_trans_);
   s.pack("FmuFunction::sp_trans_map", sp_trans_map_);
  
   s.pack("FmuFunction::has_jac", has_jac_);
   s.pack("FmuFunction::has_fwd", has_fwd_);
   s.pack("FmuFunction::has_adj", has_adj_);
   s.pack("FmuFunction::has_hess", has_hess_);
  
   s.pack("FmuFunction::uses_directional_derivatives", uses_directional_derivatives_);
   s.pack("FmuFunction::uses_adjoint_derivatives", uses_adjoint_derivatives_);
   s.pack("FmuFunction::nfwd", nfwd_);
   s.pack("FmuFunction::nadj", nadj_);
   s.pack("FmuFunction::validate_forward", validate_forward_);
   s.pack("FmuFunction::validate_hessian", validate_hessian_);
   s.pack("FmuFunction::make_symmetric", make_symmetric_);
   s.pack("FmuFunction::step", step_);
   s.pack("FmuFunction::fd_flip", fd_flip_);
   s.pack("FmuFunction::abstol", abstol_);
   s.pack("FmuFunction::reltol", reltol_);
   s.pack("FmuFunction::print_progress", print_progress_);
   s.pack("FmuFunction::new_jacobian", new_jacobian_);
   s.pack("FmuFunction::new_forward", new_forward_);
   s.pack("FmuFunction::new_hessian", new_hessian_);
   s.pack("FmuFunction::hessian_coloring", hessian_coloring_);
   s.pack("FmuFunction::asymmetric_hessian_coloring", asymmetric_hessian_coloring_);
   s.pack("FmuFunction::enable_forward_jacobian", enable_forward_jacobian_);
   s.pack("FmuFunction::enable_adjoint_jacobian", enable_adjoint_jacobian_);
   s.pack("FmuFunction::enable_adjoint_hessian", enable_adjoint_hessian_);
   s.pack("FmuFunction::validate_ad_file", validate_ad_file_);
  
   s.pack("FmuFunction::fd", static_cast<int>(fd_));
   s.pack("FmuFunction::parallelization", static_cast<int>(parallelization_));
   s.pack("FmuFunction::init_stats", init_stats_);
  
   s.pack("FmuFunction::jac_sp", jac_sp_);
   s.pack("FmuFunction::hess_sp", hess_sp_);
   s.pack("FmuFunction::adj_sp", adj_sp_);
   s.pack("FmuFunction::jac_colors", jac_colors_);
   s.pack("FmuFunction::adj_colors", adj_colors_);
   s.pack("FmuFunction::hess_colors", hess_colors_);
   s.pack("FmuFunction::hess_uni_colors", hess_uni_colors_);
   s.pack("FmuFunction::which_hess_color", which_hess_color_);
   s.pack("FmuFunction::nonlin", nonlin_);
  
  
   s.pack("FmuFunction::max_jac_tasks", max_jac_tasks_);
   s.pack("FmuFunction::max_hess_tasks", max_hess_tasks_);
   s.pack("FmuFunction::max_n_tasks", max_n_tasks_);
  
 }

References abstol_, adj_colors_, adj_sp_, asymmetric_hessian_coloring_, enable_adjoint_hessian_, enable_adjoint_jacobian_, enable_forward_jacobian_, fd_, fd_flip_, fmu_, has_adj_, has_fwd_, has_hess_, has_jac_, hess_colors_, hess_sp_, hess_uni_colors_, hessian_coloring_, in_, init_stats_, jac_colors_, jac_in_, jac_nom_in_, jac_out_, jac_sp_, make_symmetric_, max_hess_tasks_, max_jac_tasks_, max_n_tasks_, casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, nadj_, new_forward_, new_hessian_, new_jacobian_, nfwd_, nonlin_, out_, casadi::SerializingStream::pack(), parallelization_, print_progress_, reltol_, casadi::FunctionInternal::serialize_body(), sp_trans_, sp_trans_map_, step_, uses_adjoint_derivatives_, uses_directional_derivatives_, validate_ad_file_, validate_forward_, validate_hessian_, casadi::SerializingStream::version(), and which_hess_color_.

◆ serialize_type()

void casadi::FunctionInternal::serialize_type ( SerializingStream & s ) const

overridevirtualinherited

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

Reimplemented from casadi::ProtoFunction.

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

Definition at line 4243 of file function_internal.cpp.

                                                                   {
     s.pack("FunctionInternal::base_function", serialize_base_function());
   }

References casadi::SerializingStream::pack(), and casadi::ProtoFunction::serialize_base_function().

Referenced by casadi::Conic::serialize_type(), casadi::GenericExternal::serialize_type(), casadi::Integrator::serialize_type(), casadi::Interpolant::serialize_type(), casadi::Map::serialize_type(), casadi::MapSum::serialize_type(), casadi::Nlpsol::serialize_type(), casadi::OnnxFunction::serialize_type(), casadi::Rootfinder::serialize_type(), and casadi::LinearInterpolantJac::serialize_type().

◆ set_jac_sparsity()

void casadi::FunctionInternal::set_jac_sparsity	(	casadi_int	oind,
		casadi_int	iind,
		const Sparsity &	sp
	)

protectedinherited

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

Definition at line 4022 of file function_internal.cpp.

                                                                                               {
 #ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
     // Safe access to jac_sparsity_
     std::lock_guard<std::mutex> lock(jac_sparsity_mtx_);
 #endif // CASADI_WITH_THREADSAFE_SYMBOLICS
     casadi_int ind = iind + oind * n_in_;
     jac_sparsity_[false].resize(n_in_ * n_out_);
     jac_sparsity_[false].at(ind) = sp;
     jac_sparsity_[true].resize(n_in_ * n_out_);
     jac_sparsity_[true].at(ind) = to_compact(oind, iind, sp);
   }

References casadi::FunctionInternal::jac_sparsity_, casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, and casadi::FunctionInternal::to_compact().

◆ set_temp()

virtual void casadi::FunctionInternal::set_temp	(	void *	mem,
		const double **	arg,
		double **	res,
		casadi_int *	iw,
		double *	w
	)		const

inlinevirtualinherited

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

Reimplemented in casadi::FatropConicInterface, and casadi::OracleFunction.

Definition at line 1279 of file function_internal.hpp.

1280 {}

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

◆ set_work()

virtual void casadi::FunctionInternal::set_work	(	void *	mem,
		const double **&	arg,
		double **&	res,
		casadi_int *&	iw,
		double *&	w
	)		const

inlinevirtualinherited

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

Reimplemented in casadi::Sqpmethod, casadi::Scpgen, casadi::Qrsqp, casadi::Qrqp, casadi::Newton, casadi::ImplicitToNlp, casadi::Feasiblesqpmethod, casadi::FastNewton, casadi::XpressInterface, casadi::WorhpInterface, casadi::UnoInterface, casadi::SundialsInterface, casadi::KinsolInterface, casadi::SnoptInterface, casadi::SlicotExpm, casadi::SlicotDple, casadi::SLEQPInterface, casadi::MosekInterface, casadi::MadnlpInterface, casadi::KnitroInterface, casadi::IpoptInterface, casadi::HpipmInterface, casadi::HighsInterface, casadi::FatropInterface, casadi::FatropConicInterface, casadi::DaqpInterface, casadi::ConoptInterface, casadi::ClarabelInterface, casadi::MadmpecInterface, casadi::BonminInterface, casadi::Blocksqp, casadi::AmplInterface, casadi::AlpaqaInterface, casadi::Rootfinder, casadi::Nlpsol, casadi::FixedStepIntegrator, casadi::Integrator, and casadi::Conic.

Definition at line 1273 of file function_internal.hpp.

1274 {}

Referenced by casadi::Integrator::set_work(), casadi::SlicotDple::set_work(), casadi::SlicotExpm::set_work(), and casadi::FunctionInternal::setup().

◆ setup()

void casadi::FunctionInternal::setup	(	void *	mem,
		const double **	arg,
		double **	res,
		casadi_int *	iw,
		double *	w
	)		const

inherited

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

Definition at line 3796 of file function_internal.cpp.

                                                                 {
     set_work(mem, arg, res, iw, w);
     set_temp(mem, arg, res, iw, w);
     auto *m = static_cast<FunctionMemory*>(mem);
     m->stats_available = true;
   }

References casadi::FunctionInternal::set_temp(), casadi::FunctionInternal::set_work(), and casadi::FunctionMemory::stats_available.

Referenced by casadi::Conic::eval(), casadi::Nlpsol::eval(), casadi::CallbackInternal::eval(), casadi::FiniteDiff::eval(), eval(), casadi::Integrator::eval(), casadi::Map::eval(), casadi::OmpMap::eval(), casadi::ThreadMap::eval(), casadi::MapSum::eval(), casadi::MXFunction::eval(), casadi::Rootfinder::eval(), casadi::Switch::eval(), casadi::SXFunction::eval(), casadi::SlicotDple::eval(), casadi::SlicotExpm::eval(), casadi::BSplineInterpolant::eval(), and casadi::LinearInterpolant::eval().

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

◆ signature()

std::string casadi::FunctionInternal::signature ( const std::string & fname ) const

inherited

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

Definition at line 2555 of file function_internal.cpp.

                                                                     {
     return "int " + fname + "(const casadi_real** arg, casadi_real** res, "
                             "casadi_int* iw, casadi_real* w, int mem)";
   }

Referenced by casadi::CodeGenerator::add(), casadi::FunctionInternal::codegen(), casadi::External::codegen_declarations(), and casadi::OnnxFunction::init().

◆ signature_unrolled()

std::string casadi::FunctionInternal::signature_unrolled ( const std::string & fname ) const

inherited

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

Definition at line 2560 of file function_internal.cpp.

                                                                              {
     std::vector<std::string> args;
     for (auto e : name_in_) {
       args.push_back("const casadi_real* " + str(e));
     }
     for (auto e : name_out_) {
       args.push_back("casadi_real* " + str(e));
     }
     args.push_back("const casadi_real** arg");
     args.push_back("casadi_real** res");
     args.push_back("casadi_int* iw");
     args.push_back("casadi_real* w");
     args.push_back("int mem");
     return "int " + fname + "_unrolled(" + join(args, ", ") + ")";
   }

References casadi::join(), casadi::FunctionInternal::name_in_, casadi::FunctionInternal::name_out_, and casadi::str().

Referenced by casadi::CodeGenerator::add().

◆ simplify_passes()

Function casadi::FunctionInternal::simplify_passes ( const std::vector< std::pair< std::string, casadi_int > > & tasks ) const

virtualinherited

Each pass is a (task, count) pair; count>0 runs the task that many times, count==0 runs it until a fixed point.

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, and casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >.

Definition at line 3991 of file function_internal.cpp.

                                                                      {
     casadi_assert(tasks.empty(), "simplify passes not supported for " + class_name());
     return self();
   }

References casadi::SharedObjectInternal::class_name().

Referenced by casadi::Function::transform().

◆ size1_in()

casadi_int casadi::FunctionInternal::size1_in ( casadi_int ind ) const

inlineinherited

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

Definition at line 1029 of file function_internal.hpp.

1029 { return sparsity_in(ind).size1(); }

Referenced by casadi::FunctionInternal::check_arg(), eval(), eval_task(), casadi::FunctionInternal::forward(), casadi::Integrator::get_forward(), casadi::Integrator::get_reverse(), casadi::FunctionInternal::matching_arg(), and casadi::FunctionInternal::reverse().

◆ size1_out()

casadi_int casadi::FunctionInternal::size1_out ( casadi_int ind ) const

inlineinherited

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

Definition at line 1031 of file function_internal.hpp.

1031 { return sparsity_out(ind).size1(); }

Referenced by eval_task(), casadi::FunctionInternal::forward(), casadi::Integrator::get_forward(), casadi::LinearInterpolantJac::get_jacobian(), casadi::FunctionInternal::matching_res(), and casadi::FunctionInternal::reverse().

◆ size2_in()

casadi_int casadi::FunctionInternal::size2_in ( casadi_int ind ) const

inlineinherited

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

Definition at line 1030 of file function_internal.hpp.

1030 { return sparsity_in(ind).size2(); }

Referenced by casadi::FunctionInternal::call_gen(), casadi::FunctionInternal::call_reverse(), casadi::FunctionInternal::check_arg(), casadi::FunctionInternal::forward(), casadi::Integrator::get_reverse(), casadi::FunctionInternal::mapsum_mx(), casadi::FunctionInternal::matching_arg(), casadi::FunctionInternal::project_arg(), and casadi::FunctionInternal::reverse().

◆ size2_out()

casadi_int casadi::FunctionInternal::size2_out ( casadi_int ind ) const

inlineinherited

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

Definition at line 1032 of file function_internal.hpp.

1032 { return sparsity_out(ind).size2(); }

Referenced by casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::forward(), casadi::Integrator::get_forward(), casadi::LinearInterpolantJac::get_jacobian(), casadi::FunctionInternal::matching_res(), and casadi::FunctionInternal::reverse().

◆ size_in()

std::pair<casadi_int, casadi_int> casadi::FunctionInternal::size_in ( casadi_int ind ) const

inlineinherited

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

Definition at line 1033 of file function_internal.hpp.

                                                                   {
       return sparsity_in(ind).size();
     }

Referenced by casadi::Rootfinder::ad_forward(), casadi::Rootfinder::ad_reverse(), casadi::MXFunction::ad_reverse(), casadi::FunctionInternal::call_reverse(), casadi::FunctionInternal::fwd_seed(), casadi::Dple::get_forward(), and casadi::Dple::get_reverse().

◆ size_out()

std::pair<casadi_int, casadi_int> casadi::FunctionInternal::size_out ( casadi_int ind ) const

inlineinherited

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

Definition at line 1036 of file function_internal.hpp.

                                                                    {
       return sparsity_out(ind).size();
     }

Referenced by casadi::MXFunction::ad_forward(), casadi::Rootfinder::ad_reverse(), casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::check_res(), casadi::FunctionInternal::eval(), casadi::Integrator::get_forward(), casadi::Integrator::get_reverse(), and casadi::Nlpsol::init().

◆ slice()

Function casadi::FunctionInternal::slice	(	const std::string &	name,
		const std::vector< casadi_int > &	order_in,
		const std::vector< casadi_int > &	order_out,
		const Dict &	opts
	)		const

virtualinherited

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, and casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >.

Definition at line 4003 of file function_internal.cpp.

                                                                         {
     return wrap().slice(name, order_in, order_out, opts);
   }

References casadi::Function::slice(), and casadi::FunctionInternal::wrap().

Referenced by casadi::Function::slice().

◆ sp_forward()

int casadi::FunctionInternal::sp_forward	(	const bvec_t **	arg,
		bvec_t **	res,
		casadi_int *	iw,
		bvec_t *	w,
		void *	mem
	)		const

virtualinherited

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

Reimplemented in casadi::BSplineInterpolant, casadi::SXFunction, casadi::Rootfinder, casadi::MXFunction, casadi::MapSum, casadi::Map, and casadi::Integrator.

Definition at line 3083 of file function_internal.cpp.

                                                                                            {
     // Loop over outputs
     for (casadi_int oind=0; oind<n_out_; ++oind) {
       // Skip if nothing to assign
       if (res[oind]==nullptr || nnz_out(oind)==0) continue;
       // Clear result
       casadi_clear(res[oind], nnz_out(oind));
       // Loop over inputs
       for (casadi_int iind=0; iind<n_in_; ++iind) {
         // Skip if no seeds
         if (arg[iind]==nullptr || nnz_in(iind)==0) continue;
         // Propagate sparsity for the specific block
         if (sp_forward_block(arg, res, iw, w, mem, oind, iind)) return 1;
       }
     }
     return 0;
   }

References casadi::casadi_clear(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, casadi::FunctionInternal::nnz_in(), casadi::FunctionInternal::nnz_out(), and casadi::FunctionInternal::sp_forward_block().

Referenced by casadi::MXFunction::sp_forward(), casadi::SXFunction::sp_forward(), and casadi::BSplineInterpolant::sp_forward().

◆ sp_forward_block()

int casadi::FunctionInternal::sp_forward_block	(	const bvec_t **	arg,
		bvec_t **	res,
		casadi_int *	iw,
		bvec_t *	w,
		void *	mem,
		casadi_int	oind,
		casadi_int	iind
	)		const

virtualinherited

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

Definition at line 3102 of file function_internal.cpp.

                                                                                     {
     // Get the sparsity of the Jacobian block
     Sparsity sp = jac_sparsity(oind, iind, true, false);
     if (sp.is_null() || sp.nnz() == 0) return 0; // Skip if zero
     // Carry out the sparse matrix-vector multiplication
     casadi_int d1 = sp.size2();
     const casadi_int *colind = sp.colind(), *row = sp.row();
     for (casadi_int cc=0; cc<d1; ++cc) {
       for (casadi_int el = colind[cc]; el < colind[cc+1]; ++el) {
         res[oind][row[el]] |= arg[iind][cc];
       }
     }
     return 0;
   }

References casadi::Sparsity::colind(), casadi::GenericShared< Shared, Internal >::is_null(), casadi::FunctionInternal::jac_sparsity(), casadi::Sparsity::nnz(), casadi::Sparsity::row(), and casadi::Sparsity::size2().

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

◆ sp_reverse()

int casadi::FunctionInternal::sp_reverse	(	bvec_t **	arg,
		bvec_t **	res,
		casadi_int *	iw,
		bvec_t *	w,
		void *	mem
	)		const

virtualinherited

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

Reimplemented in casadi::BSplineInterpolant, casadi::SXFunction, casadi::Rootfinder, casadi::MXFunction, casadi::MapSum, casadi::Map, and casadi::Integrator.

Definition at line 3118 of file function_internal.cpp.

                                                                                      {
     // Loop over outputs
     for (casadi_int oind=0; oind<n_out_; ++oind) {
       // Skip if nothing to assign
       if (res[oind]==nullptr || nnz_out(oind)==0) continue;
  
       // Loop over inputs
       for (casadi_int iind=0; iind<n_in_; ++iind) {
         // Skip if no seeds
         if (arg[iind]==nullptr || nnz_in(iind)==0) continue;
  
         // Get the sparsity of the Jacobian block
         Sparsity sp = jac_sparsity(oind, iind, true, false);
         if (sp.is_null() || sp.nnz() == 0) continue; // Skip if zero
  
         // Carry out the sparse matrix-vector multiplication
         casadi_int d1 = sp.size2();
         const casadi_int *colind = sp.colind(), *row = sp.row();
         for (casadi_int cc=0; cc<d1; ++cc) {
           for (casadi_int el = colind[cc]; el < colind[cc+1]; ++el) {
             arg[iind][cc] |= res[oind][row[el]];
           }
         }
       }
  
       // Clear seeds
       casadi_clear(res[oind], nnz_out(oind));
     }
     return 0;
   }

References casadi::casadi_clear(), casadi::Sparsity::colind(), casadi::GenericShared< Shared, Internal >::is_null(), casadi::FunctionInternal::jac_sparsity(), casadi::FunctionInternal::n_in_, casadi::FunctionInternal::n_out_, casadi::Sparsity::nnz(), casadi::FunctionInternal::nnz_in(), casadi::FunctionInternal::nnz_out(), casadi::Sparsity::row(), and casadi::Sparsity::size2().

Referenced by casadi::MXFunction::sp_reverse(), casadi::SXFunction::sp_reverse(), and casadi::BSplineInterpolant::sp_reverse().

◆ sp_weight()

double casadi::FunctionInternal::sp_weight ( ) const

virtualinherited

sparsity propagation

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

Definition at line 3533 of file function_internal.cpp.

                                            {
     // If reverse mode propagation unavailable, use forward
     if (!has_sprev()) return 0;
  
     // If forward mode propagation unavailable, use reverse
     if (!has_spfwd()) return 1;
  
     // Use the (potentially user set) option
     return ad_weight_sp_;
   }

References casadi::FunctionInternal::ad_weight_sp_, casadi::FunctionInternal::has_spfwd(), and casadi::FunctionInternal::has_sprev().

Referenced by casadi::FunctionInternal::get_jac_sparsity(), casadi::FunctionInternal::get_jac_sparsity_hierarchical(), casadi::MXFunction::sp_forward(), casadi::SXFunction::sp_forward(), casadi::MXFunction::sp_reverse(), casadi::SXFunction::sp_reverse(), casadi::FunctionInternal::wrap(), and casadi::FunctionInternal::wrap_as_needed().

◆ sparsity_in()

const Sparsity& casadi::FunctionInternal::sparsity_in ( casadi_int ind ) const

inlineinherited

◆ sparsity_out()

const Sparsity& casadi::FunctionInternal::sparsity_out ( casadi_int ind ) const

inlineinherited

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

Definition at line 1046 of file function_internal.hpp.

1046 { return sparsity_out_.at(ind); }

Referenced by casadi::FunctionInternal::call_gen(), casadi::FunctionInternal::check_res(), casadi::FunctionInternal::dm_out(), eval(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::forward(), casadi::FunctionInternal::from_compact(), casadi::Integrator::get_reverse(), init(), casadi::JitFunction::JitFunction(), casadi::FunctionInternal::mx_out(), casadi::FunctionInternal::replace_res(), casadi::FunctionInternal::sx_out(), and casadi::FunctionInternal::to_compact().

◆ sprint()

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

inherited

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 casadi::ProtoFunction::format_time(), and casadi::ProtoFunction::print_time().

◆ string_from_UnifiedReturnStatus()

std::string casadi::FunctionInternal::string_from_UnifiedReturnStatus ( UnifiedReturnStatus status )

staticinherited

Definition at line 4214 of file function_internal.cpp.

                                                                                         {
     switch (status) {
       case SOLVER_RET_LIMITED:  return "SOLVER_RET_LIMITED";
       case SOLVER_RET_NAN:  return "SOLVER_RET_NAN";
       case SOLVER_RET_SUCCESS:  return "SOLVER_RET_SUCCESS";
       default: return "SOLVER_RET_UNKNOWN";
     }
   }

References casadi::SOLVER_RET_LIMITED, casadi::SOLVER_RET_NAN, and casadi::SOLVER_RET_SUCCESS.

Referenced by casadi::Conic::get_stats(), casadi::Nlpsol::get_stats(), and casadi::Rootfinder::get_stats().

◆ sx_in() [1/2]

const std::vector< SX > casadi::FunctionInternal::sx_in ( ) const

virtualinherited

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

Reimplemented in casadi::SXFunction.

Definition at line 3560 of file function_internal.cpp.

                                                     {
     std::vector<SX> ret(n_in_);
     for (casadi_int i=0; i<ret.size(); ++i) {
       ret[i] = sx_in(i);
     }
     return ret;
   }

References casadi::FunctionInternal::n_in_.

◆ sx_in() [2/2]

const SX casadi::FunctionInternal::sx_in ( casadi_int ind ) const

virtualinherited

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

Reimplemented in casadi::SXFunction.

Definition at line 3544 of file function_internal.cpp.

                                                        {
     return SX::sym(name_in_.at(ind), sparsity_in(ind));
   }

References casadi::FunctionInternal::name_in_, casadi::FunctionInternal::sparsity_in(), and casadi::GenericMatrix< Matrix< Scalar > >::sym().

◆ sx_out() [1/2]

const std::vector< SX > casadi::FunctionInternal::sx_out ( ) const

virtualinherited

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

Definition at line 3568 of file function_internal.cpp.

                                                      {
     std::vector<SX> ret(n_out_);
     for (casadi_int i=0; i<ret.size(); ++i) {
       ret[i] = sx_out(i);
     }
     return ret;
   }

References casadi::FunctionInternal::n_out_.

◆ sx_out() [2/2]

const SX casadi::FunctionInternal::sx_out ( casadi_int ind ) const

virtualinherited

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

Definition at line 3548 of file function_internal.cpp.

                                                         {
     return SX::sym(name_out_.at(ind), sparsity_out(ind));
   }

References casadi::FunctionInternal::name_out_, casadi::FunctionInternal::sparsity_out(), and casadi::GenericMatrix< Matrix< Scalar > >::sym().

◆ symbolic_output()

std::vector< MX > casadi::FunctionInternal::symbolic_output ( const std::vector< MX > & arg ) const

virtualinherited

Reimplemented in casadi::MXFunction.

Definition at line 1265 of file function_internal.cpp.

                                                                                 {
     return self()(arg);
   }

Referenced by casadi::MXFunction::symbolic_output().

◆ symbolicAdjSeed()

template<typename MatType >

std::vector< std::vector< MatType > > casadi::FunctionInternal::symbolicAdjSeed	(	casadi_int	nadj,
		const std::vector< MatType > &	v
	)		const

inherited

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

Definition at line 1598 of file function_internal.hpp.

                                                                       {
     std::vector<std::vector<MatType> > aseed(nadj, v);
     for (casadi_int dir=0; dir<nadj; ++dir) {
       // Replace symbolic inputs
       casadi_int oind=0;
       for (typename std::vector<MatType>::iterator i=aseed[dir].begin();
           i!=aseed[dir].end();
           ++i, ++oind) {
         // Name of the adjoint seed
         std::stringstream ss;
         ss << "a";
         if (nadj>1) ss << dir << "_";
         ss << oind;
  
         // Save to matrix
         *i = MatType::sym(ss.str(), is_diff_out_[oind] ? i->sparsity() : Sparsity(i->size()));
  
       }
     }
     return aseed;
   }

References casadi::FunctionInternal::is_diff_out_.

◆ sz_arg()

size_t casadi::FunctionInternal::sz_arg ( ) const

inlineinherited

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

Definition at line 1218 of file function_internal.hpp.

1218 { return sz_arg_per_ + sz_arg_tmp_;}

Referenced by casadi::FunctionInternal::alloc(), casadi::FunctionInternal::alloc_arg(), casadi::FunctionInternal::call_gen(), casadi::OmpMap::codegen_body(), casadi::ThreadMap::codegen_body(), casadi::ThreadMap::codegen_declarations(), casadi::FunctionInternal::codegen_meta(), casadi::FunctionInternal::codegen_sz_arg(), casadi::OmpMap::eval(), casadi::MXFunction::eval_sx(), casadi::OracleFunction::finalize(), casadi::FunctionInternal::get_jac_sparsity_gen(), casadi::FunctionInternal::get_jac_sparsity_hierarchical(), casadi::FunctionInternal::get_jac_sparsity_hierarchical_symm(), casadi::External::init(), casadi::Nlpsol::init(), casadi::MadmpecInterface::init(), casadi::ClarabelInterface::init(), casadi::DaqpInterface::init(), casadi::FatropConicInterface::init(), casadi::FatropInterface::init(), casadi::HighsInterface::init(), casadi::HpipmInterface::init(), casadi::MadnlpInterface::init(), casadi::MosekInterface::init(), casadi::XpressInterface::init(), casadi::Qrqp::init(), and casadi::FunctionInternal::sz_work().

◆ sz_iw()

size_t casadi::FunctionInternal::sz_iw ( ) const

inlineinherited

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

Definition at line 1228 of file function_internal.hpp.

1228 { return sz_iw_per_ + sz_iw_tmp_;}

◆ sz_res()

size_t casadi::FunctionInternal::sz_res ( ) const

inlineinherited

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

Definition at line 1223 of file function_internal.hpp.

1223 { return sz_res_per_ + sz_res_tmp_;}

Referenced by casadi::FunctionInternal::alloc(), casadi::FunctionInternal::alloc_res(), casadi::FunctionInternal::call_gen(), casadi::OmpMap::codegen_body(), casadi::ThreadMap::codegen_body(), casadi::ThreadMap::codegen_declarations(), casadi::FunctionInternal::codegen_meta(), casadi::FunctionInternal::codegen_sz_res(), casadi::OmpMap::eval(), casadi::MXFunction::eval_sx(), casadi::OracleFunction::finalize(), casadi::FunctionInternal::get_jac_sparsity_gen(), casadi::FunctionInternal::get_jac_sparsity_hierarchical(), casadi::FunctionInternal::get_jac_sparsity_hierarchical_symm(), casadi::External::init(), casadi::Nlpsol::init(), casadi::MadmpecInterface::init(), casadi::ClarabelInterface::init(), casadi::DaqpInterface::init(), casadi::FatropConicInterface::init(), casadi::FatropInterface::init(), casadi::HighsInterface::init(), casadi::HpipmInterface::init(), casadi::MadnlpInterface::init(), casadi::MosekInterface::init(), casadi::XpressInterface::init(), casadi::Qrqp::init(), and casadi::FunctionInternal::sz_work().

◆ sz_w()

size_t casadi::FunctionInternal::sz_w ( ) const

inlineinherited

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

Definition at line 1233 of file function_internal.hpp.

1233 { return sz_w_per_ + sz_w_tmp_;}

◆ sz_work()

void casadi::FunctionInternal::sz_work	(	size_t &	sz_arg,
		size_t &	sz_res,
		size_t &	sz_iw,
		size_t &	sz_w
	)		const

inherited

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

Definition at line 3150 of file function_internal.cpp.

                                                                     {
     sz_arg = this->sz_arg();
     sz_res = this->sz_res();
     sz_iw = this->sz_iw();
     sz_w = this->sz_w();
   }

References casadi::FunctionInternal::sz_arg(), casadi::FunctionInternal::sz_iw(), casadi::FunctionInternal::sz_res(), and casadi::FunctionInternal::sz_w().

◆ to_compact()

Sparsity casadi::FunctionInternal::to_compact	(	casadi_int	oind,
		casadi_int	iind,
		const Sparsity &	sp
	)		const

inherited

Definition at line 2036 of file function_internal.cpp.

                                 {
     // Strip rows and columns
     std::vector<casadi_int> mapping;
     return sp.sub(sparsity_out(oind).find(), sparsity_in(iind).find(), mapping);
   }

References casadi::FunctionInternal::find(), casadi::FunctionInternal::sparsity_in(), casadi::FunctionInternal::sparsity_out(), and casadi::Sparsity::sub().

Referenced by casadi::FunctionInternal::jac_sparsity(), and casadi::FunctionInternal::set_jac_sparsity().

◆ tocache()

void casadi::FunctionInternal::tocache	(	const Function &	f,
		const std::string &	suffix = `""`
	)		const

inherited

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

Definition at line 1192 of file function_internal.cpp.

                                                                                  {
     cache_.tocache(f.name() + ":" + suffix, f);
   }

References casadi::FunctionInternal::cache_, and casadi::Function::name().

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::BlazingSplineFunction::get_jacobian(), and casadi::FunctionInternal::init().

◆ tocache_if_missing()

void casadi::FunctionInternal::tocache_if_missing	(	Function &	f,
		const std::string &	suffix = `""`
	)		const

inherited

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

Definition at line 1196 of file function_internal.cpp.

                                                                                       {
     cache_.tocache_if_missing(f.name() + ":" + suffix, f);
   }

References casadi::FunctionInternal::cache_, and casadi::Function::name().

Referenced by casadi::MapSum::create(), casadi::OracleFunction::create_function(), casadi::FunctionInternal::forward(), casadi::FunctionInternal::jacobian(), casadi::FunctionInternal::map(), casadi::FunctionInternal::reverse(), and casadi::FunctionInternal::wrap().

◆ trace_values()

void casadi::FunctionInternal::trace_values	(	std::ostream &	trace,
		const double *	values,
		casadi_int	nnz
	)

staticprotectedinherited

Definition at line 826 of file function_internal.cpp.

                                                                         {
     if (!values) {
       trace << "null";
       return;
     }
     trace << "[";
     for (casadi_int i = 0; i < nnz; ++i) {
       if (i) trace << ",";
       double v = values[i];
       if (isnan(v)) {
         trace << "\"nan\"";
       } else if (isinf(v)) {
         trace << (v < 0 ? "\"-inf\"" : "\"inf\"");
       } else {
         normalized_out(trace, v);
       }
     }
     trace << "]";
   }

References casadi::normalized_out().

Referenced by casadi::FunctionInternal::finish_trace(), casadi::FunctionInternal::open_trace(), casadi::MXFunction::trace_instruction(), and casadi::SXFunction::trace_instruction().

◆ uses_output()

virtual bool casadi::FunctionInternal::uses_output ( ) const

inlinevirtualinherited

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

Reimplemented in casadi::Rootfinder, casadi::OnnxFunction, casadi::Nlpsol, casadi::FiniteDiff, and casadi::CallbackInternal.

Definition at line 626 of file function_internal.hpp.

626 {return false;}

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

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

◆ which_depends()

std::vector< bool > casadi::FunctionInternal::which_depends	(	const std::string &	s_in,
		const std::vector< std::string > &	s_out,
		casadi_int	order,
		bool	tr = `false`
	)		const

virtualinherited

Parameters

[in]	s_in	Input name
[in]	s_out	Output name(s)
[in]	order	Only 1 (linear) and 2 (nonlinear) allowed
[in]	tr	Flip the relationship. Return which expressions contain the variables

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

Reimplemented in casadi::XFunction< DerivedType, MatType, NodeType >, casadi::XFunction< MXFunction, MX, MXNode >, and casadi::XFunction< SXFunction, Matrix< SXElem >, SXNode >.

Definition at line 3983 of file function_internal.cpp.

                                        {
     Function f = shared_from_this<Function>();
     f = f.wrap();
     return f.which_depends(s_in, s_out, order, tr);
   }

References casadi::Function::which_depends(), and casadi::Function::wrap().

◆ wrap() [1/2]

Function casadi::FunctionInternal::wrap ( ) const

inherited

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

Definition at line 1240 of file function_internal.cpp.

                                         {
     return wrap("wrap_" + name_);
   }

References casadi::ProtoFunction::name_.

Referenced by casadi::FunctionInternal::eval_mx(), casadi::FunctionInternal::factory(), casadi::FunctionInternal::forward(), casadi::FunctionInternal::jacobian(), casadi::FunctionInternal::reverse(), and casadi::FunctionInternal::slice().

◆ wrap() [2/2]

Function casadi::FunctionInternal::wrap ( const std::string & name ) const

inherited

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

Definition at line 1244 of file function_internal.cpp.

                                                              {
     Function f;
     if (!incache(name, f)) {
       // Options
       Dict opts;
       opts["derivative_of"] = derivative_of_;
       opts["ad_weight"] = ad_weight();
       opts["ad_weight_sp"] = sp_weight();
       opts["max_num_dir"] = max_num_dir_;
       opts["is_diff_in"] = is_diff_in_;
       opts["is_diff_out"] = is_diff_out_;
       // Wrap the function
       std::vector<MX> arg = mx_in();
       std::vector<MX> res = self()(arg);
       f = Function(name, arg, res, name_in_, name_out_, opts);
       // Save in cache
       tocache_if_missing(f);
     }
     return f;
   }

References casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::derivative_of_, casadi::FunctionInternal::Function, casadi::FunctionInternal::incache(), casadi::FunctionInternal::is_diff_in_, casadi::FunctionInternal::is_diff_out_, casadi::FunctionInternal::max_num_dir_, casadi::FunctionInternal::mx_in(), casadi::FunctionInternal::name_in_, casadi::FunctionInternal::name_out_, casadi::FunctionInternal::sp_weight(), and casadi::FunctionInternal::tocache_if_missing().

Referenced by casadi::Function::wrap().

◆ wrap_as_needed() [1/2]

Function casadi::FunctionInternal::wrap_as_needed ( const Dict & opts ) const

inherited

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

Definition at line 1219 of file function_internal.cpp.

                                                                   {
     return wrap_as_needed("wrap_" + name_, opts);
   }

References casadi::ProtoFunction::name_, and casadi::FunctionInternal::wrap_as_needed().

◆ wrap_as_needed() [2/2]

Function casadi::FunctionInternal::wrap_as_needed	(	const std::string &	name,
		const Dict &	opts
	)		const

inherited

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

Definition at line 1223 of file function_internal.cpp.

                                                                                          {
     if (opts.empty() && name==name_) return shared_from_this<Function>();
     // Options
     Dict my_opts = opts;
     my_opts["derivative_of"] = derivative_of_;
     if (my_opts.find("ad_weight")==my_opts.end())
       my_opts["ad_weight"] = ad_weight();
     if (my_opts.find("ad_weight_sp")==my_opts.end())
       my_opts["ad_weight_sp"] = sp_weight();
     if (my_opts.find("max_num_dir")==my_opts.end())
       my_opts["max_num_dir"] = max_num_dir_;
     // Wrap the function
     std::vector<MX> arg = mx_in();
     std::vector<MX> res = self()(arg);
     return Function(name, arg, res, name_in_, name_out_, my_opts);
   }

References casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::derivative_of_, casadi::FunctionInternal::Function, casadi::FunctionInternal::max_num_dir_, casadi::FunctionInternal::mx_in(), casadi::ProtoFunction::name_, casadi::FunctionInternal::name_in_, casadi::FunctionInternal::name_out_, and casadi::FunctionInternal::sp_weight().

Referenced by casadi::Function::wrap_as_needed(), and casadi::FunctionInternal::wrap_as_needed().

Member Data Documentation

◆ abstol_

double casadi::FmuFunction::abstol_

Definition at line 169 of file fmu_function.hpp.

Referenced by casadi::FmuInternal::eval_fd(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ ad_weight_

double casadi::FunctionInternal::ad_weight_

inherited

Definition at line 1420 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::change_option(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ ad_weight_sp_

double casadi::FunctionInternal::ad_weight_sp_

inherited

Definition at line 1420 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::FunctionInternal::serialize_body(), and casadi::FunctionInternal::sp_weight().

◆ adj_colors_

Sparsity casadi::FmuFunction::adj_colors_

Definition at line 223 of file fmu_function.hpp.

Referenced by eval_task(), FmuFunction(), init(), and serialize_body().

◆ adj_prob_

casadi_jac_prob<double> casadi::FmuFunction::adj_prob_

Definition at line 232 of file fmu_function.hpp.

Referenced by eval(), eval_task(), FmuFunction(), and init().

◆ adj_sp_

Sparsity casadi::FmuFunction::adj_sp_

Definition at line 220 of file fmu_function.hpp.

Referenced by eval(), FmuFunction(), init(), and serialize_body().

◆ always_inline_

bool casadi::FunctionInternal::always_inline_

inherited

Definition at line 1309 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::eval_mx(), casadi::MXFunction::eval_mx(), casadi::SXFunction::eval_mx(), casadi::FunctionInternal::eval_sx(), casadi::MXFunction::eval_sx(), casadi::SXFunction::eval_sx(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ asymmetric_hessian_coloring_

bool casadi::FmuFunction::asymmetric_hessian_coloring_

Definition at line 171 of file fmu_function.hpp.

Referenced by FmuFunction(), init(), and serialize_body().

◆ cache_

WeakCache<std::string, Function> casadi::FunctionInternal::cache_

mutableinherited

Definition at line 1391 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::cache(), casadi::FunctionInternal::incache(), casadi::FunctionInternal::tocache(), and casadi::FunctionInternal::tocache_if_missing().

◆ cache_init_

Dict casadi::FunctionInternal::cache_init_

inherited

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

Definition at line 1388 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ checkout_

casadi_checkout_t casadi::FunctionInternal::checkout_

inherited

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

Definition at line 1358 of file function_internal.hpp.

Referenced by casadi::GenericExternal::any_symbol_found(), casadi::External::codegen_checkout(), casadi::External::codegen_declarations(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::finalize(), casadi::FunctionBuffer::FunctionBuffer(), casadi::FunctionInternal::FunctionInternal(), casadi::GenericExternal::init_external(), and casadi::FunctionBuffer::operator=().

◆ compiler_

Importer casadi::FunctionInternal::compiler_

inherited

Definition at line 1409 of file function_internal.hpp.

◆ compiler_plugin_

std::string casadi::FunctionInternal::compiler_plugin_

inherited

Definition at line 1408 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::Scpgen::init(), casadi::OracleFunction::jit_dependencies(), and casadi::FunctionInternal::serialize_body().

◆ custom_jacobian_

Function casadi::FunctionInternal::custom_jacobian_

inherited

Definition at line 1460 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ decref_

signal_t casadi::FunctionInternal::decref_

inherited

Definition at line 1368 of file function_internal.hpp.

Referenced by casadi::External::any_symbol_found(), casadi::External::codegen_declarations(), casadi::External::codegen_decref(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::External::init_external(), and casadi::FunctionInternal::~FunctionInternal().

◆ der_options_

Dict casadi::FunctionInternal::der_options_

inherited

Definition at line 1457 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::forward(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::BlazingSplineFunction::get_jacobian(), casadi::FunctionInternal::init(), casadi::FunctionInternal::jacobian(), casadi::FunctionInternal::reverse(), and casadi::FunctionInternal::serialize_body().

◆ derivative_of_

Function casadi::FunctionInternal::derivative_of_

inherited

Definition at line 1402 of file function_internal.hpp.

◆ deserialize_map

std::map< std::string, ProtoFunction *(*)(DeserializingStream &)> casadi::FunctionInternal::deserialize_map

staticinherited

Initial value:

= {
    {"MXFunction", MXFunction::deserialize},
    {"SXFunction", SXFunction::deserialize},
    {"Interpolant", Interpolant::deserialize},
    {"Switch", Switch::deserialize},
    {"ForwardDiff", ForwardDiff::deserialize},
    {"BackwardDiff", BackwardDiff::deserialize},
    {"CentralDiff", CentralDiff::deserialize},
    {"Smoothing", Smoothing::deserialize},
 
    {"Map", Map::deserialize},
    {"MapSum", MapSum::deserialize},
    {"Nlpsol", Nlpsol::deserialize},
    {"Rootfinder", Rootfinder::deserialize},
    {"Integrator", Integrator::deserialize},
    {"External", External::deserialize},
    {"Conic", Conic::deserialize},
    {"FmuFunction", FmuFunction::deserialize},
    {"BlazingSplineFunction", BlazingSplineFunction::deserialize},
    {"Onnx", OnnxFunction::deserialize}
  }

Definition at line 1514 of file function_internal.hpp.

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

◆ dump_

bool casadi::FunctionInternal::dump_

inherited

Definition at line 1448 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), and casadi::FunctionInternal::init().

◆ dump_count_

casadi_int casadi::FunctionInternal::dump_count_

mutableinherited

Definition at line 1469 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), and casadi::FunctionInternal::reset_dump_count().

◆ dump_dir_

std::string casadi::FunctionInternal::dump_dir_

inherited

Definition at line 1451 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::FunctionInternal(), casadi::CodeGenerator::generate_dump(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::FunctionInternal::open_trace(), and casadi::FunctionInternal::serialize_body().

◆ dump_format_

std::string casadi::FunctionInternal::dump_format_

inherited

Definition at line 1454 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::FunctionInternal(), casadi::CodeGenerator::generate_dump(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ dump_in_

bool casadi::FunctionInternal::dump_in_

inherited

Definition at line 1448 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::codegen(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ dump_out_

bool casadi::FunctionInternal::dump_out_

inherited

Definition at line 1448 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::codegen(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ enable_adjoint_hessian_

bool casadi::FmuFunction::enable_adjoint_hessian_

Definition at line 172 of file fmu_function.hpp.

Referenced by change_option(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ enable_adjoint_jacobian_

bool casadi::FmuFunction::enable_adjoint_jacobian_

Definition at line 172 of file fmu_function.hpp.

Referenced by eval(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ enable_fd_

bool casadi::FunctionInternal::enable_fd_

inherited

Definition at line 1416 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::adjViaJac(), casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::forward(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::fwdViaJac(), casadi::FunctionInternal::get_partition(), casadi::FunctionInternal::has_derivative(), casadi::FunctionInternal::init(), casadi::JitFunction::JitFunction(), and casadi::FunctionInternal::serialize_body().

◆ enable_fd_op_

bool casadi::FunctionInternal::enable_fd_op_

inherited

Definition at line 1417 of file function_internal.hpp.

Referenced by FmuFunction(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ enable_forward_

bool casadi::FunctionInternal::enable_forward_

inherited

Definition at line 1416 of file function_internal.hpp.

Referenced by casadi::MXFunction::ad_forward(), casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::adjViaJac(), casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::forward(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::fwdViaJac(), casadi::FunctionInternal::get_partition(), casadi::FunctionInternal::has_derivative(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ enable_forward_jacobian_

bool casadi::FmuFunction::enable_forward_jacobian_

Definition at line 172 of file fmu_function.hpp.

Referenced by change_option(), eval(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ enable_forward_op_

bool casadi::FunctionInternal::enable_forward_op_

inherited

Definition at line 1417 of file function_internal.hpp.

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

◆ enable_jacobian_

bool casadi::FunctionInternal::enable_jacobian_

inherited

Definition at line 1416 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::has_derivative(), casadi::FunctionInternal::init(), casadi::FunctionInternal::jacobian(), and casadi::FunctionInternal::serialize_body().

◆ enable_jacobian_op_

bool casadi::FunctionInternal::enable_jacobian_op_

inherited

Definition at line 1417 of file function_internal.hpp.

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

◆ enable_reverse_

bool casadi::FunctionInternal::enable_reverse_

inherited

Definition at line 1416 of file function_internal.hpp.

Referenced by casadi::MXFunction::ad_reverse(), casadi::FunctionInternal::ad_weight(), casadi::FunctionInternal::adjViaJac(), casadi::FunctionInternal::call_reverse(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::fwdViaJac(), casadi::FunctionInternal::get_partition(), casadi::FunctionInternal::has_derivative(), casadi::FunctionInternal::init(), casadi::FunctionInternal::reverse(), and casadi::FunctionInternal::serialize_body().

◆ enable_reverse_op_

bool casadi::FunctionInternal::enable_reverse_op_

inherited

Definition at line 1417 of file function_internal.hpp.

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

◆ error_on_fail_

bool casadi::ProtoFunction::error_on_fail_

inherited

Definition at line 263 of file function_internal.hpp.

◆ eval_

eval_t casadi::FunctionInternal::eval_

inherited

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

Definition at line 1353 of file function_internal.hpp.

Referenced by casadi::FunctionBuffer::_eval(), casadi::GenericExternal::any_symbol_found(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), and casadi::GenericExternal::init_external().

◆ fd_

FdMode casadi::FmuFunction::fd_

Definition at line 176 of file fmu_function.hpp.

Referenced by change_option(), casadi::FmuInternal::eval_fd(), FmuFunction(), init(), and serialize_body().

◆ fd_flip_

bool casadi::FmuFunction::fd_flip_

Definition at line 170 of file fmu_function.hpp.

Referenced by change_option(), casadi::FmuInternal::eval_fd(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ fd_method_

std::string casadi::FunctionInternal::fd_method_

inherited

Definition at line 1435 of file function_internal.hpp.

Referenced by change_option(), casadi::FunctionInternal::forward(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), init(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ fd_options_

Dict casadi::FunctionInternal::fd_options_

inherited

Definition at line 1429 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::forward(), casadi::FunctionInternal::generate_options(), and casadi::FunctionInternal::init().

◆ fd_step_

double casadi::FunctionInternal::fd_step_

inherited

Definition at line 1432 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ fmu_

Fmu casadi::FmuFunction::fmu_

Definition at line 138 of file fmu_function.hpp.

Referenced by alloc_mem(), change_option(), check_mem_count(), eval(), eval_task(), factory(), finalize_hessian(), FmuFunction(), free_mem(), get_forward(), get_jac_sparsity(), get_jacobian(), get_nominal_in(), get_nominal_out(), get_reverse(), get_sparsity_in(), get_sparsity_out(), get_stats(), init(), init_mem(), and serialize_body().

◆ forward_options_

Dict casadi::FunctionInternal::forward_options_

inherited

Definition at line 1457 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::forward(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ has_adj_

bool casadi::FmuFunction::has_adj_

Definition at line 157 of file fmu_function.hpp.

Referenced by FmuFunction(), init(), and serialize_body().

◆ has_fwd_

bool casadi::FmuFunction::has_fwd_

Definition at line 157 of file fmu_function.hpp.

Referenced by FmuFunction(), and serialize_body().

◆ has_hess_

bool casadi::FmuFunction::has_hess_

Definition at line 157 of file fmu_function.hpp.

Referenced by FmuFunction(), init(), and serialize_body().

◆ has_jac_

bool casadi::FmuFunction::has_jac_

Definition at line 157 of file fmu_function.hpp.

Referenced by FmuFunction(), init(), and serialize_body().

◆ has_refcount_

bool casadi::FunctionInternal::has_refcount_

inherited

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

Definition at line 1378 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::codegen_decref(), casadi::FunctionInternal::codegen_incref(), casadi::DaqpInterface::DaqpInterface(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::External::init(), casadi::MXFunction::init(), and casadi::FunctionInternal::serialize_body().

◆ has_refcount_in_deps_

bool casadi::FunctionInternal::has_refcount_in_deps_

inherited

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

Definition at line 1383 of file function_internal.hpp.

Referenced by casadi::CodeGenerator::add_dependency(), casadi::FunctionInternal::codegen_meta(), and casadi::FunctionInternal::finalize().

◆ hess_colors_

Sparsity casadi::FmuFunction::hess_colors_

Definition at line 223 of file fmu_function.hpp.

Referenced by change_option(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ hess_sp_

Sparsity casadi::FmuFunction::hess_sp_

Definition at line 220 of file fmu_function.hpp.

Referenced by eval(), eval_task(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ hess_uni_colors_

Sparsity casadi::FmuFunction::hess_uni_colors_

Definition at line 223 of file fmu_function.hpp.

Referenced by change_option(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ hessian_coloring_

bool casadi::FmuFunction::hessian_coloring_

Definition at line 171 of file fmu_function.hpp.

Referenced by change_option(), eval_task(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ in_

std::vector<InputStruct> casadi::FmuFunction::in_

Definition at line 141 of file fmu_function.hpp.

Referenced by all_regular(), all_vectors(), eval(), eval_task(), FmuFunction(), get_jac_sparsity(), get_nominal_in(), get_sparsity_in(), get_stats(), has_jac_sparsity(), init(), and serialize_body().

◆ incref_

signal_t casadi::FunctionInternal::incref_

inherited

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

Definition at line 1368 of file function_internal.hpp.

Referenced by casadi::External::any_symbol_found(), casadi::External::codegen_declarations(), casadi::External::codegen_incref(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), and casadi::External::init_external().

◆ init_stats_

Dict casadi::FmuFunction::init_stats_

Definition at line 182 of file fmu_function.hpp.

Referenced by FmuFunction(), and serialize_body().

◆ inputs_check_

bool casadi::FunctionInternal::inputs_check_

inherited

Definition at line 1426 of file function_internal.hpp.

Referenced by casadi::Nlpsol::check_inputs(), casadi::Conic::eval(), casadi::SqicInterface::evaluate(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::FunctionInternal::serialize_body(), and casadi::GurobiInterface::solve().

◆ is_diff_in_

std::vector<bool> casadi::FunctionInternal::is_diff_in_

inherited

◆ is_diff_out_

std::vector<bool> casadi::FunctionInternal::is_diff_out_

inherited

Definition at line 1315 of file function_internal.hpp.

◆ jac_colors_

Sparsity casadi::FmuFunction::jac_colors_

Definition at line 223 of file fmu_function.hpp.

Referenced by eval_task(), FmuFunction(), init(), and serialize_body().

◆ jac_in_

std::vector<size_t> casadi::FmuFunction::jac_in_

Definition at line 147 of file fmu_function.hpp.

Referenced by eval_task(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ jac_nom_in_

std::vector<double> casadi::FmuFunction::jac_nom_in_

Definition at line 150 of file fmu_function.hpp.

Referenced by FmuFunction(), init(), and serialize_body().

◆ jac_out_

std::vector<size_t> casadi::FmuFunction::jac_out_

Definition at line 147 of file fmu_function.hpp.

Referenced by eval_task(), FmuFunction(), init(), and serialize_body().

◆ jac_penalty_

double casadi::FunctionInternal::jac_penalty_

inherited

Definition at line 1413 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::adjViaJac(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::fwdViaJac(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ jac_prob_

casadi_jac_prob<double> casadi::FmuFunction::jac_prob_

Definition at line 232 of file fmu_function.hpp.

Referenced by eval(), eval_task(), FmuFunction(), and init().

◆ jac_sp_

Sparsity casadi::FmuFunction::jac_sp_

Definition at line 220 of file fmu_function.hpp.

Referenced by eval(), FmuFunction(), init(), and serialize_body().

◆ jac_sparsity_

std::vector<Sparsity> casadi::FunctionInternal::jac_sparsity_[2]

mutableinherited

Definition at line 1394 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::jac_sparsity(), and casadi::FunctionInternal::set_jac_sparsity().

◆ jacobian_options_

Dict casadi::FunctionInternal::jacobian_options_

inherited

Definition at line 1457 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::BlazingSplineFunction::get_jacobian(), casadi::FunctionInternal::init(), casadi::FunctionInternal::jacobian(), and casadi::FunctionInternal::serialize_body().

◆ jit_

bool casadi::FunctionInternal::jit_

inherited

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

Definition at line 1326 of file function_internal.hpp.

Referenced by casadi::MXFunction::change_option(), casadi::SXFunction::change_option(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::MXFunction::init(), casadi::SXFunction::init(), casadi::JitFunction::JitFunction(), casadi::OracleFunction::OracleFunction(), casadi::FunctionInternal::serialize_body(), casadi::OracleFunction::serialize_body(), and casadi::FunctionInternal::~FunctionInternal().

◆ jit_base_name_

std::string casadi::FunctionInternal::jit_base_name_

inherited

Definition at line 1343 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ jit_cleanup_

bool casadi::FunctionInternal::jit_cleanup_

inherited

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

Definition at line 1331 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::FunctionInternal::serialize_body(), and casadi::FunctionInternal::~FunctionInternal().

◆ jit_directory_

std::string casadi::FunctionInternal::jit_directory_

inherited

Definition at line 1342 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::finalize(), and casadi::FunctionInternal::~FunctionInternal().

◆ jit_name_

std::string casadi::FunctionInternal::jit_name_

inherited

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

Definition at line 1341 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::finalize(), and casadi::FunctionInternal::~FunctionInternal().

◆ jit_options_

Dict casadi::FunctionInternal::jit_options_

inherited

Definition at line 1410 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::Scpgen::init(), casadi::OracleFunction::jit_dependencies(), and casadi::FunctionInternal::serialize_body().

◆ jit_serialize_

std::string casadi::FunctionInternal::jit_serialize_

inherited

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

Definition at line 1336 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::OracleFunction::OracleFunction(), casadi::FunctionInternal::serialize_body(), and casadi::OracleFunction::serialize_body().

◆ jit_temp_suffix_

bool casadi::FunctionInternal::jit_temp_suffix_

inherited

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

Definition at line 1348 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ make_symmetric_

bool casadi::FmuFunction::make_symmetric_

Definition at line 171 of file fmu_function.hpp.

Referenced by change_option(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ max_adj_tasks_

casadi_int casadi::FmuFunction::max_adj_tasks_

Definition at line 235 of file fmu_function.hpp.

◆ max_hess_tasks_

casadi_int casadi::FmuFunction::max_hess_tasks_

Definition at line 235 of file fmu_function.hpp.

Referenced by eval(), FmuFunction(), init(), init_mem(), and serialize_body().

◆ max_io_

casadi_int casadi::FunctionInternal::max_io_

inherited

Definition at line 1445 of file function_internal.hpp.

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

◆ max_jac_tasks_

casadi_int casadi::FmuFunction::max_jac_tasks_

Definition at line 235 of file fmu_function.hpp.

Referenced by alloc_mem(), eval(), FmuFunction(), init(), init_mem(), and serialize_body().

◆ max_n_tasks_

casadi_int casadi::FmuFunction::max_n_tasks_

Definition at line 235 of file fmu_function.hpp.

Referenced by eval(), FmuFunction(), init(), and serialize_body().

◆ max_num_dir_

casadi_int casadi::FunctionInternal::max_num_dir_

inherited

Definition at line 1423 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::call_forward(), casadi::FunctionInternal::call_reverse(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::FunctionInternal::serialize_body(), casadi::FunctionInternal::wrap(), and casadi::FunctionInternal::wrap_as_needed().

◆ n_in_

size_t casadi::FunctionInternal::n_in_

inherited

Definition at line 1312 of file function_internal.hpp.

◆ n_out_

size_t casadi::FunctionInternal::n_out_

inherited

Definition at line 1312 of file function_internal.hpp.

◆ nadj_

casadi_int casadi::FmuFunction::nadj_

Definition at line 163 of file fmu_function.hpp.

Referenced by all_vectors(), eval(), eval_task(), FmuFunction(), get_sparsity_in(), get_sparsity_out(), init(), and serialize_body().

◆ name_

std::string casadi::ProtoFunction::name_

inherited

Definition at line 248 of file function_internal.hpp.

◆ name_in_

std::vector<std::string> casadi::FunctionInternal::name_in_

inherited

Definition at line 1321 of file function_internal.hpp.

◆ name_out_

std::vector<std::string> casadi::FunctionInternal::name_out_

inherited

Definition at line 1321 of file function_internal.hpp.

◆ never_inline_

bool casadi::FunctionInternal::never_inline_

inherited

Definition at line 1309 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::eval_mx(), casadi::MXFunction::eval_mx(), casadi::SXFunction::eval_mx(), casadi::FunctionInternal::eval_sx(), casadi::MXFunction::eval_sx(), casadi::SXFunction::eval_sx(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ new_forward_

bool casadi::FmuFunction::new_forward_

Definition at line 170 of file fmu_function.hpp.

Referenced by FmuFunction(), get_forward(), has_forward(), init(), and serialize_body().

◆ new_hessian_

bool casadi::FmuFunction::new_hessian_

Definition at line 170 of file fmu_function.hpp.

Referenced by FmuFunction(), get_reverse(), init(), and serialize_body().

◆ new_jacobian_

bool casadi::FmuFunction::new_jacobian_

Definition at line 170 of file fmu_function.hpp.

Referenced by FmuFunction(), has_jacobian(), init(), and serialize_body().

◆ nfwd_

casadi_int casadi::FmuFunction::nfwd_

Definition at line 163 of file fmu_function.hpp.

Referenced by all_vectors(), eval_all(), eval_task(), FmuFunction(), get_sparsity_in(), get_sparsity_out(), init(), and serialize_body().

◆ nonlin_

std::vector<casadi_int> casadi::FmuFunction::nonlin_

Definition at line 229 of file fmu_function.hpp.

Referenced by FmuFunction(), init(), and serialize_body().

◆ options_

const Options casadi::FmuFunction::options_

static

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

Definition at line 205 of file fmu_function.hpp.

◆ out_

std::vector<OutputStruct> casadi::FmuFunction::out_

Definition at line 144 of file fmu_function.hpp.

Referenced by all_regular(), all_vectors(), eval(), eval_task(), FmuFunction(), get_jac_sparsity(), get_nominal_out(), get_sparsity_out(), has_jac_sparsity(), init(), and serialize_body().

◆ parallelization_

Parallelization casadi::FmuFunction::parallelization_

Definition at line 179 of file fmu_function.hpp.

Referenced by eval_all(), factory(), FmuFunction(), get_forward(), get_jacobian(), get_reverse(), init(), and serialize_body().

◆ print_canonical_

bool casadi::FunctionInternal::print_canonical_

inherited

Definition at line 1442 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::MXFunction::print_arg(), casadi::SXFunction::print_arg(), casadi::FunctionInternal::print_in(), casadi::FunctionInternal::print_out(), casadi::MXFunction::print_res(), casadi::SXFunction::print_res(), and casadi::FunctionInternal::serialize_body().

◆ print_in_

bool casadi::FunctionInternal::print_in_

inherited

Definition at line 1438 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::codegen(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ print_out_

bool casadi::FunctionInternal::print_out_

inherited

Definition at line 1439 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::change_option(), casadi::FunctionInternal::codegen(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), and casadi::FunctionInternal::serialize_body().

◆ print_progress_

bool casadi::FmuFunction::print_progress_

Definition at line 170 of file fmu_function.hpp.

Referenced by change_option(), eval(), eval_task(), factory(), FmuFunction(), get_forward(), get_jacobian(), get_reverse(), init(), and serialize_body().

◆ print_time_

bool casadi::ProtoFunction::print_time_

inherited

Definition at line 254 of file function_internal.hpp.

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

◆ record_time_

bool casadi::ProtoFunction::record_time_

inherited

Definition at line 257 of file function_internal.hpp.

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

◆ registered_functions_

std::vector<Function> casadi::FunctionInternal::registered_functions_

inherited

Definition at line 1463 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::alloc(), casadi::FunctionInternal::find(), casadi::FunctionInternal::FunctionInternal(), and casadi::FunctionInternal::serialize_body().

◆ regularity_check_

bool casadi::ProtoFunction::regularity_check_

inherited

Definition at line 260 of file function_internal.hpp.

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

◆ release_

casadi_release_t casadi::FunctionInternal::release_

inherited

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

Definition at line 1363 of file function_internal.hpp.

Referenced by casadi::GenericExternal::any_symbol_found(), casadi::External::codegen_declarations(), casadi::External::codegen_release(), casadi::FunctionInternal::eval_gen(), casadi::FunctionInternal::finalize(), casadi::FunctionInternal::FunctionInternal(), casadi::GenericExternal::init_external(), casadi::FunctionBuffer::operator=(), and casadi::FunctionBuffer::~FunctionBuffer().

◆ reltol_

double casadi::FmuFunction::reltol_

Definition at line 169 of file fmu_function.hpp.

Referenced by casadi::FmuInternal::eval_fd(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ reverse_options_

Dict casadi::FunctionInternal::reverse_options_

inherited

Definition at line 1457 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), casadi::FunctionInternal::init(), casadi::FunctionInternal::reverse(), and casadi::FunctionInternal::serialize_body().

◆ sp_trans_

std::vector<Sparsity> casadi::FmuFunction::sp_trans_

Definition at line 153 of file fmu_function.hpp.

Referenced by eval(), FmuFunction(), init(), and serialize_body().

◆ sp_trans_map_

std::vector<casadi_int> casadi::FmuFunction::sp_trans_map_

Definition at line 154 of file fmu_function.hpp.

Referenced by eval(), FmuFunction(), init(), and serialize_body().

◆ sparsity_in_

std::vector<Sparsity> casadi::FunctionInternal::sparsity_in_

inherited

Definition at line 1318 of file function_internal.hpp.

◆ sparsity_out_

std::vector<Sparsity> casadi::FunctionInternal::sparsity_out_

inherited

◆ stats_

Dict casadi::FunctionInternal::stats_

inherited

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

Definition at line 1373 of file function_internal.hpp.

◆ step_

double casadi::FmuFunction::step_

Definition at line 169 of file fmu_function.hpp.

Referenced by change_option(), casadi::FmuInternal::eval_fd(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ user_data_

void* casadi::FunctionInternal::user_data_

inherited

Definition at line 1405 of file function_internal.hpp.

Referenced by casadi::FunctionInternal::FunctionInternal(), casadi::FunctionInternal::generate_options(), and casadi::FunctionInternal::init().

◆ uses_adjoint_derivatives_

bool casadi::FmuFunction::uses_adjoint_derivatives_

Definition at line 160 of file fmu_function.hpp.

Referenced by change_option(), eval_task(), FmuFunction(), init(), and serialize_body().

◆ uses_directional_derivatives_

bool casadi::FmuFunction::uses_directional_derivatives_

Definition at line 160 of file fmu_function.hpp.

Referenced by change_option(), casadi::FmuInternal::eval_fwd(), FmuFunction(), init(), and serialize_body().

◆ validate_ad_file_

std::string casadi::FmuFunction::validate_ad_file_

Definition at line 173 of file fmu_function.hpp.

Referenced by casadi::FmuInternal::eval_fd(), FmuFunction(), init(), and serialize_body().

◆ validate_forward_

bool casadi::FmuFunction::validate_forward_

Definition at line 166 of file fmu_function.hpp.

Referenced by casadi::FmuInternal::eval_fd(), casadi::FmuInternal::eval_fwd(), FmuFunction(), init(), and serialize_body().

◆ validate_hessian_

bool casadi::FmuFunction::validate_hessian_

Definition at line 166 of file fmu_function.hpp.

Referenced by finalize_hessian(), FmuFunction(), init(), and serialize_body().

◆ verbose_

bool casadi::ProtoFunction::verbose_

inherited

Definition at line 251 of file function_internal.hpp.

◆ which_hess_color_

std::vector<casadi_int> casadi::FmuFunction::which_hess_color_

Definition at line 226 of file fmu_function.hpp.

Referenced by eval_task(), finalize_hessian(), FmuFunction(), init(), and serialize_body().

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

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Member Typedef Documentation

◆ weak_ref_type

Constructor & Destructor Documentation

◆ FmuFunction() [1/2]

◆ ~FmuFunction()

◆ FmuFunction() [2/2]

Member Function Documentation

◆ ad_weight()

◆ add_embedded()

◆ adjViaJac()

◆ all_regular()

◆ all_scalar()

◆ all_vectors()

◆ alloc()

◆ alloc_arg()

◆ alloc_iw()

◆ alloc_mem()

◆ alloc_res()

◆ alloc_w()

◆ cache()

◆ call()

◆ call_forward() [1/2]

◆ call_forward() [2/2]

◆ call_gen() [1/2]

◆ call_gen() [2/2]

◆ call_reverse() [1/2]

◆ call_reverse() [2/2]

◆ change_option()

◆ check_arg()

◆ check_mat()

◆ check_mem_count()

◆ check_res()

◆ checkout()

◆ class_name()

◆ clear_mem()

◆ codegen()

◆ codegen_alloc_mem()

◆ codegen_body()

◆ codegen_checkout()

◆ codegen_declarations()

◆ codegen_decref()

◆ codegen_free_mem()

◆ codegen_incref()

◆ codegen_init_mem()

◆ codegen_mem()

◆ codegen_mem_is_opaque()

◆ codegen_mem_type()

◆ codegen_meta()

◆ codegen_name()

◆ codegen_needs_mem()

◆ codegen_release()

◆ codegen_sparsities()

◆ codegen_sz_arg()

◆ codegen_sz_iw()

◆ codegen_sz_res()

◆ codegen_sz_w()

◆ construct()

◆ convert_arg() [1/2]

◆ convert_arg() [2/2]

◆ convert_res() [1/2]

◆ convert_res() [2/2]

◆ debug_repr()

◆ definition()

◆ deserialize()

◆ destroySingleton()

◆ diff_prefix()

◆ disp()

◆ disp_more()

◆ dm_in() [1/2]

◆ dm_in() [2/2]

◆ dm_out() [1/2]

◆ dm_out() [2/2]