#include <alpaqa/casadi/casadi-external-function.hpp>

Detailed Description

Class that loads and calls pre-compiled CasADi functions in a DLL/SO file.

Designed to match (part of) the casadi::Function API.

Definition at line 25 of file casadi-external-function.hpp.

Collaboration diagram for Function:

Classes
struct	Functions
class	Sparsity
struct	Work

Public Member Functions
	Function ()
	Function (std::shared_ptr< void > so_handle, const std::string &func_name)
	Function (const Functions &functions)
	Function (const Function &)
	Function (Function &&) noexcept
	~Function ()
casadi_int	n_in () const
casadi_int	n_out () const
std::pair< casadi_int, casadi_int >	size_in (casadi_int) const
std::pair< casadi_int, casadi_int >	size_out (casadi_int) const
casadi_int	size1_in (casadi_int) const
casadi_int	size1_out (casadi_int) const
casadi_int	size2_in (casadi_int) const
casadi_int	size2_out (casadi_int) const
Sparsity	sparsity_in (casadi_int) const
Sparsity	sparsity_out (casadi_int) const
void	operator() (std::span< const double const > arg, std::span< double const > res)

Private Member Functions
void	load (void *so_handle, const std::string &func_name)
void	init_work ()

Private Attributes
std::shared_ptr< void >	so_handle
Functions	functions
std::optional< Work >	work
int	mem = 0

Class Documentation

◆ alpaqa::casadi::Function::Functions

struct alpaqa::casadi::Function::Functions

Collaboration diagram for Function::Functions:

Class Members
signature_t *	incref = nullptr
signature_t *	decref = nullptr
signature_t *	n_in = nullptr
signature_t *	n_out = nullptr
signature_t *	name_in = nullptr
signature_t *	name_out = nullptr
signature_t *	sparsity_in = nullptr
signature_t *	sparsity_out = nullptr
signature_t *	alloc_mem = nullptr
signature_t *	init_mem = nullptr
signature_t *	free_mem = nullptr
signature_t *	work = nullptr
signature_t *	call = nullptr

◆ alpaqa::casadi::Function::Work

struct alpaqa::casadi::Function::Work

Collaboration diagram for Function::Work:

Class Members
vector< const casadi_real * >	arg
vector< casadi_real * >	res
vector< casadi_int >	iw
vector< casadi_real >	w

Constructor & Destructor Documentation

◆ Function() [1/5]

Function ( )

default

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Function() [2/5]

Function	(	std::shared_ptr< void >	so_handle,
		const std::string &	func_name )

Definition at line 46 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ Function() [3/5]

Function ( const Functions & functions )

Definition at line 52 of file casadi-external-function.cpp.

◆ Function() [4/5]

Function ( const Function & o )

Definition at line 56 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ Function() [5/5]

Function ( Function && o )

noexcept

Definition at line 60 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ ~Function()

~Function ( )

Definition at line 63 of file casadi-external-function.cpp.

Member Function Documentation

◆ n_in()

casadi_int n_in ( ) const

nodiscard

Definition at line 71 of file casadi-external-function.cpp.

Here is the caller graph for this function:

◆ n_out()

casadi_int n_out ( ) const

nodiscard

Definition at line 72 of file casadi-external-function.cpp.

Here is the caller graph for this function:

◆ size_in()

std::pair< casadi_int, casadi_int > size_in ( casadi_int n ) const

nodiscard

Definition at line 73 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ size_out()

std::pair< casadi_int, casadi_int > size_out ( casadi_int n ) const

nodiscard

Definition at line 76 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ size1_in()

casadi_int size1_in ( casadi_int n ) const

nodiscard

Definition at line 79 of file casadi-external-function.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size1_out()

casadi_int size1_out ( casadi_int n ) const

nodiscard

Definition at line 82 of file casadi-external-function.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size2_in()

casadi_int size2_in ( casadi_int n ) const

nodiscard

Definition at line 85 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ size2_out()

casadi_int size2_out ( casadi_int n ) const

nodiscard

Definition at line 88 of file casadi-external-function.cpp.

Here is the call graph for this function:

◆ sparsity_in()

Function::Sparsity sparsity_in ( casadi_int n ) const

nodiscard

Definition at line 91 of file casadi-external-function.cpp.

Here is the caller graph for this function:

◆ sparsity_out()

Function::Sparsity sparsity_out ( casadi_int n ) const

nodiscard

Definition at line 94 of file casadi-external-function.cpp.

Here is the caller graph for this function:

◆ operator()()

void operator()	(	std::span< const double *const >	arg,
		std::span< double *const >	res )

inline

Definition at line 79 of file casadi-external-function.hpp.

Here is the call graph for this function:

◆ load()

void load	(	void *	so_handle,
		const std::string &	func_name )

private

Definition at line 12 of file casadi-external-function.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_work()

void init_work ( )

private

Definition at line 31 of file casadi-external-function.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ so_handle

std::shared_ptr<void> so_handle

private

Definition at line 101 of file casadi-external-function.hpp.

◆ functions

Functions functions

private

Definition at line 102 of file casadi-external-function.hpp.

◆ work

std::optional<Work> work

private

Definition at line 109 of file casadi-external-function.hpp.

◆ mem

int mem = 0

private

Definition at line 110 of file casadi-external-function.hpp.

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

src/interop/casadi/include/alpaqa/casadi/casadi-external-function.hpp
src/interop/casadi/src/casadi-external-function.cpp

Detailed Description

Classes

Public Member Functions

Private Member Functions

Private Attributes

Class Documentation

◆ alpaqa::casadi::Function::Functions

◆ alpaqa::casadi::Function::Work

Constructor & Destructor Documentation

◆ Function() [1/5]

◆ Function() [2/5]

◆ Function() [3/5]

◆ Function() [4/5]

◆ Function() [5/5]

◆ ~Function()

Member Function Documentation

◆ n_in()

◆ n_out()

◆ size_in()

◆ size_out()

◆ size1_in()

◆ size1_out()

◆ size2_in()

◆ size2_out()

◆ sparsity_in()

◆ sparsity_out()

◆ operator()()

◆ load()

◆ init_work()

Member Data Documentation

◆ so_handle

◆ functions

◆ work

◆ mem