alpaqa_problem_register_t Struct Reference

#include <alpaqa/dl/dl-problem.h>

Detailed Description

Note

When used in C, you should initialize this struct by passing a pointer to your instance to the ALPAQA_PROBLEM_REGISTER_INIT macro. In C++, this is not necessary, because all members have default initializers.

Examples

C++/DLProblem/main.cpp, and problems/sparse-logistic-regression.cpp.

Definition at line 447 of file dl-problem.h.

Collaboration diagram for alpaqa_problem_register_t:

Public Attributes
alpaqa_dl_abi_version_t	abi_version { 0xA1A000000005 }
	To check whether the loaded problem is compatible with the version of the solver.
void *	instance { nullptr }
	Owning pointer.
alpaqa_problem_functions_t *	functions { nullptr }
	Non-owning pointer, lifetime at least as long as instance.
void(*	cleanup )(void *)
	Pointer to the function to clean up instance.
alpaqa_function_dict_t *	extra_functions { nullptr }
	Pointer to a map of extra functions (C++ only).
alpaqa_exception_ptr_t *	exception { nullptr }
	Pointer to an exception that ocurred during problem creation.

Member Data Documentation

abi_version

alpaqa_dl_abi_version_t abi_version { 0xA1A000000005 }

To check whether the loaded problem is compatible with the version of the solver.

Definition at line 450 of file dl-problem.h.

instance

void* instance { nullptr }

Owning pointer.

Examples

C++/DLProblem/main.cpp, and problems/sparse-logistic-regression.cpp.

Definition at line 452 of file dl-problem.h.

functions

alpaqa_problem_functions_t* functions { nullptr }

Non-owning pointer, lifetime at least as long as instance.

Examples

C++/DLProblem/main.cpp, and problems/sparse-logistic-regression.cpp.

Definition at line 454 of file dl-problem.h.

cleanup

void(* cleanup) (void *)

inline

Pointer to the function to clean up instance.

Examples

C++/DLProblem/main.cpp, and problems/sparse-logistic-regression.cpp.

Definition at line 456 of file dl-problem.h.

extra_functions

alpaqa_function_dict_t* extra_functions { nullptr }

Pointer to a map of extra functions (C++ only).

See also

alpaqa::register_function

alpaqa::register_member_function

Definition at line 460 of file dl-problem.h.

exception

alpaqa_exception_ptr_t* exception { nullptr }

Pointer to an exception that ocurred during problem creation.

Examples

problems/sparse-logistic-regression.cpp.

Definition at line 462 of file dl-problem.h.

---

The documentation for this struct was generated from the following file:

• src/interop/dl-api/include/alpaqa/dl/dl-problem.h