Search::search Struct Reference

#include <search.h>

Public Member Functions
template<class T >
void	set_task_data (T *data)
template<class T >
T *	get_task_data ()
template<class T >
void	set_metatask_data (T *data)
template<class T >
T *	get_metatask_data ()
void	set_options (uint32_t opts)
void	set_label_parser (label_parser &lp, bool(*is_test)(const polylabel &))
void	loss (float incr_loss)
action	predict (example &ec, ptag my_tag, const action *oracle_actions, size_t oracle_actions_cnt=1, const ptag *condition_on=nullptr, const char *condition_on_names=nullptr, const action *allowed_actions=nullptr, size_t allowed_actions_cnt=0, const float *allowed_actions_cost=nullptr, size_t learner_id=0, float weight=0.)
action	predictLDF (example *ecs, size_t ec_cnt, ptag my_tag, const action *oracle_actions, size_t oracle_actions_cnt=1, const ptag *condition_on=nullptr, const char *condition_on_names=nullptr, size_t learner_id=0, float weight=0.)
bool	predictNeedsExample ()
uint32_t	get_history_length ()
bool	is_ldf ()
std::stringstream &	output ()
void	set_num_learners (size_t num_learners)
void	get_test_action_sequence (std::vector< action > &)
uint64_t	get_mask ()
size_t	get_stride_shift ()
std::string	pretty_label (action a)
BaseTask	base_task (multi_ex &ec)
VW::workspace &	get_vw_pointer_unsafe ()
void	set_force_oracle (bool force)
	search ()
	~search ()

Public Attributes
search_private *	priv = nullptr
std::shared_ptr< void >	task_data = nullptr
std::shared_ptr< void >	metatask_data = nullptr
const char *	task_name = nullptr
const char *	metatask_name = nullptr

Constructor & Destructor Documentation

search()

Search::search::search

(

)

~search()

Search::search::~search

(

)

Member Function Documentation

base_task()

BaseTask Search::search::base_task ( multi_ex &  ec )

inline

get_history_length()

uint32_t Search::search::get_history_length

(

)

get_mask()

uint64_t Search::search::get_mask

(

)

get_metatask_data()

template<class T >

T* Search::search::get_metatask_data ( )

inline

get_stride_shift()

size_t Search::search::get_stride_shift

(

)

get_task_data()

template<class T >

T* Search::search::get_task_data ( )

inline

get_test_action_sequence()

void Search::search::get_test_action_sequence

(

std::vector< action > &

)

get_vw_pointer_unsafe()

VW::workspace& Search::search::get_vw_pointer_unsafe

(

)

is_ldf()

bool Search::search::is_ldf

(

)

loss()

void Search::search::loss

(

float

incr_loss

)

output()

std::stringstream& Search::search::output

(

)

predict()

action Search::search::predict	(	example &	ec,
		ptag	my_tag,
		const action *	oracle_actions,
		size_t	oracle_actions_cnt = 1,
		const ptag *	condition_on = nullptr,
		const char *	condition_on_names = nullptr,
		const action *	allowed_actions = nullptr,
		size_t	allowed_actions_cnt = 0,
		const float *	allowed_actions_cost = nullptr,
		size_t	learner_id = 0,
		float	weight = 0.
	)

predictLDF()

action Search::search::predictLDF	(	example *	ecs,
		size_t	ec_cnt,
		ptag	my_tag,
		const action *	oracle_actions,
		size_t	oracle_actions_cnt = 1,
		const ptag *	condition_on = nullptr,
		const char *	condition_on_names = nullptr,
		size_t	learner_id = 0,
		float	weight = 0.
	)

predictNeedsExample()

bool Search::search::predictNeedsExample

(

)

pretty_label()

std::string Search::search::pretty_label

(

action

a

)

set_force_oracle()

void Search::search::set_force_oracle

(

bool

force

)

set_label_parser()

void Search::search::set_label_parser	(	label_parser &	lp,
		bool(*)(const polylabel &)	is_test
	)

set_metatask_data()

template<class T >

void Search::search::set_metatask_data ( T *  data )

inline

set_num_learners()

void Search::search::set_num_learners

(

size_t

num_learners

)

set_options()

void Search::search::set_options

(

uint32_t

opts

)

set_task_data()

template<class T >

void Search::search::set_task_data ( T *  data )

inline

Member Data Documentation

metatask_data

std::shared_ptr<void> Search::search::metatask_data = nullptr

metatask_name

const char* Search::search::metatask_name = nullptr

priv

search_private* Search::search::priv = nullptr

task_data

std::shared_ptr<void> Search::search::task_data = nullptr

task_name

const char* Search::search::task_name = nullptr

---

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

• /__w/vowpal_wabbit/vowpal_wabbit/vowpalwabbit/search.h