example Struct Reference

#include <example.h>

Inheritance diagram for example:

Public Member Functions
	example ()=default
	~example ()
	example (const example &)=delete
example &	operator= (const example &)=delete
	example (example &&other)=default
example &	operator= (example &&other)=default
void	delete_unions (void(*delete_label)(polylabel *), void(*delete_prediction)(void *))
Public Member Functions inherited from example_predict
	example_predict ()=default
	~example_predict ()=default
	example_predict (const example_predict &)=delete
example_predict &	operator= (const example_predict &)=delete
	example_predict (example_predict &&other)=default
example_predict &	operator= (example_predict &&other)=default
iterator	begin ()
	If indices is modified this iterator is invalidated. More...
iterator	end ()
	If indices is modified this iterator is invalidated. More...

Public Attributes
polylabel	l
float	initial = 0.f
polyprediction	pred
float	weight = 1.f
v_array< char >	tag
size_t	example_counter = 0
size_t	num_features = 0
float	partial_prediction = 0.f
float	updated_prediction = 0.f
float	loss = 0.f
float	total_sum_feat_sq = 0.f
float	confidence = 0.f
features *	passthrough
bool	test_only = false
bool	end_pass = false
bool	sorted = false
bool	in_use = true
Public Attributes inherited from example_predict
v_array< namespace_index >	indices
std::array< features, NUM_NAMESPACES >	feature_space
uint64_t	ft_offset = 0
namespace_interactions *	interactions = nullptr
reduction_features	_reduction_features
uint32_t	_debug_current_reduction_depth = 0

Constructor & Destructor Documentation

example::example ( )

default

example::~example

(

)

example::example ( const example &  )

delete

example::example ( example &&  other )

default

Member Function Documentation

void example::delete_unions	(	void(*)(polylabel *)	delete_label,
		void(*)(void *)	delete_prediction
	)

Example contains unions for label and prediction. These do not get cleaned up by the constructor because the type is not known at that time. To ensure correct cleanup delete_unions must be explicitly called.

example& example::operator= ( const example &  )

delete

example& example::operator= ( example &&  other )

default

Member Data Documentation

float example::confidence = 0.f

bool example::end_pass = false

size_t example::example_counter = 0

bool example::in_use = true

float example::initial = 0.f

polylabel example::l

float example::loss = 0.f

size_t example::num_features = 0

float example::partial_prediction = 0.f

features* example::passthrough

Initial value:

=
      nullptr

polyprediction example::pred

bool example::sorted = false

v_array<char> example::tag

bool example::test_only = false

float example::total_sum_feat_sq = 0.f

float example::updated_prediction = 0.f

float example::weight = 1.f

---

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

• /__w/vowpal_wabbit/vowpal_wabbit/vowpalwabbit/example.h