params.hpp File Reference

#include <alpaqa/config/config.hpp>
#include <alpaqa/export.hpp>
#include <optional>
#include <span>
#include <stdexcept>
#include <string_view>
#include <tuple>

Include dependency graph for params.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ParamString
	Represents a parameter value encoded as a string in the format abc.def.key=value. More...
struct	invalid_param
	Custom parameter parsing exception. More...
struct	vec_from_file< Conf >

Namespaces
namespace	alpaqa
namespace	alpaqa::params

Functions
auto	split_key (std::string_view full, char tok='.')
	Split the string full on the first occurrence of tok.
template<class T >
void	set_param (T &, ParamString)
	Update/overwrite the first argument based on the option in s.
template<class T >
void	set_params (T &t, std::string_view prefix, std::span< const std::string_view > options, std::optional< std::span< unsigned > > used=std::nullopt)
	Overwrites t based on the options that start with prefix.

---

Class Documentation

alpaqa::params::ParamString

struct alpaqa::params::ParamString

Collaboration diagram for ParamString:

Class Members
string_view	full_key	Full key string, used for diagnostics.
string_view	key	The subkey to resolve next.
string_view	value	The value of the parameter to store.

alpaqa::params::vec_from_file

struct alpaqa::params::vec_from_file

Collaboration diagram for vec_from_file< Conf >:

Class Members
length_t	expected_size
optional< vec >	value = std::nullopt