VW::experimental Namespace Reference

Namespaces
namespace	error_code

Classes
class	api_status
	Report status of all API calls. More...
class	status_builder
	Helper class used in report_error template funcstions to return status from API calls. More...

Typedefs
using	i_trace = void

Functions
template<typename Last >
void	report_error (std::ostringstream &os, const Last &last)
	Ends recursion of report_error variadic template with the Last argument. More...
template<typename First , typename... Rest>
void	report_error (std::ostringstream &os, const First &first, const Rest &... rest)
	Begins recursion of report_error variadic template with ostringstream to serialize error information. More...
template<typename... All>
int	report_error (api_status *status, int scode, const All &... all)
	The main report_error template used to serialize error into api_status The method most end users will use with a status code and a number of objects to be serialised into an api_status. More...
template<typename T >
VW::experimental::status_builder &	operator<< (VW::experimental::status_builder &sb, const T &val)
	left shift operator to serialize types into stringstream held in status_builder More...
int	report_error (status_builder &sb)
	Terminates recursion of report_error. More...
template<typename Last >
int	report_error (status_builder &sb, const Last &last)
	report_error that takes the final paramter More...
template<typename First , typename... Rest>
int	report_error (status_builder &sb, const First &first, const Rest &... rest)
	variadic template report_error that takes a list of parameters More...

Typedef Documentation

i_trace

using VW::experimental::i_trace = typedef void

Function Documentation

operator<<()

template<typename T >

VW::experimental::status_builder & VW::experimental::operator<<	(	VW::experimental::status_builder &	sb,
		const T &	val
	)

left shift operator to serialize types into stringstream held in status_builder

Template Parameters

T	Type to serialize

Parameters

sb	Status builder that holds serialized error message
val	Error code

Returns

reinforcement_learning::status_builder& Passed in status builder so left shift operators can be chained together.

report_error() [1/6]

template<typename... All>

int VW::experimental::report_error	(	api_status *	status,
		int	scode,
		const All &...	all
	)

The main report_error template used to serialize error into api_status The method most end users will use with a status code and a number of objects to be serialised into an api_status.

Template Parameters

All	All the type arguments to the variadic template

Parameters

status	Status object to serialize error description into
scode	Error code
all	Parameter list argument for the variadic template

Returns

int Error code that was passed in

report_error() [2/6]

int VW::experimental::report_error ( status_builder &  sb )

inline

Terminates recursion of report_error.

Parameters

sb	status_builder that contains the serialized error string

Returns

int Error status

report_error() [3/6]

template<typename First , typename... Rest>

int VW::experimental::report_error	(	status_builder &	sb,
		const First &	first,
		const Rest &...	rest
	)

variadic template report_error that takes a list of parameters

Template Parameters

First	Type of first parameter in parameter list
Rest	Tail parameter types in paramter list

Parameters

sb	status_builder that contains the serialized error string
first	First parameter value
rest	Tail paramter value list

Returns

int Error status

report_error() [4/6]

template<typename Last >

int VW::experimental::report_error	(	status_builder &	sb,
		const Last &	last
	)

report_error that takes the final paramter

Template Parameters

Last	Final paramter type

Parameters

sb	status_builder that contains the serialized error string
last	Final parameter value

Returns

int Error status

report_error() [5/6]

template<typename First , typename... Rest>

void VW::experimental::report_error	(	std::ostringstream &	os,
		const First &	first,
		const Rest &...	rest
	)

Begins recursion of report_error variadic template with ostringstream to serialize error information.

Template Parameters

First	Type of first parameter to report_error
Rest	Rest of the parameter type list

Parameters

os	ostringstream that contains serialized error data
first	value of the first parameter to report_error
rest	rest of the values to report error

report_error() [6/6]

template<typename Last >

void VW::experimental::report_error	(	std::ostringstream &	os,
		const Last &	last
	)

Ends recursion of report_error variadic template with the Last argument.

Template Parameters

Last	type of Last argument to report_error

Parameters

os	ostringstream that contains serialized error data
last	value of last argument to report_error