VW::example Class Reference

#include <example.h>

Inheritance diagram for VW::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
size_t	get_num_features () const noexcept
float	get_total_sum_feat_sq ()
void	reset_total_sum_feat_sq ()
Public Member Functions inherited from VW::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
uint64_t	get_or_calculate_order_independent_feature_space_hash ()
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
polyprediction	pred
float	weight = 1.f
VW::v_array< char >	tag
size_t	example_counter = 0
size_t	num_features = 0
size_t	num_features_from_interactions = 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	is_newline = false
Public Attributes inherited from VW::example_predict
VW::v_array< namespace_index >	indices
std::array< features, NUM_NAMESPACES >	feature_space
uint64_t	ft_offset = 0
uint64_t	feature_space_hash = 0
bool	is_set_feature_space_hash = false
std::vector< std::vector< namespace_index > > *	interactions = nullptr
std::vector< std::vector< extent_term > > *	extent_interactions = nullptr
reduction_features	ex_reduction_features
uint32_t	debug_current_reduction_depth = 0

Friends
void	VW::copy_example_data (example *dst, const example *src)
void	VW::setup_example (VW::workspace &all, example *ae)

Constructor & Destructor Documentation

example() [1/3]

VW::example::example ( )

default

~example()

VW::example::~example

(

)

example() [2/3]

VW::example::example ( const example &  )

delete

example() [3/3]

VW::example::example ( example &&  other )

default

Member Function Documentation

get_num_features()

size_t VW::example::get_num_features ( ) const

inlinenoexcept

get_total_sum_feat_sq()

float VW::example::get_total_sum_feat_sq

(

)

operator=() [1/2]

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

delete

operator=() [2/2]

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

default

reset_total_sum_feat_sq()

void VW::example::reset_total_sum_feat_sq ( )

inline

Friends And Related Function Documentation

VW::copy_example_data

void VW::copy_example_data ( example *  dst, const example *  src  )

friend

VW::setup_example

void VW::setup_example ( VW::workspace &  all, example *  ae  )

friend

Member Data Documentation

confidence

float VW::example::confidence = 0.f

end_pass

bool VW::example::end_pass = false

example_counter

size_t VW::example::example_counter = 0

is_newline

bool VW::example::is_newline = false

l

polylabel VW::example::l

loss

float VW::example::loss = 0.f

num_features

size_t VW::example::num_features = 0

num_features_from_interactions

size_t VW::example::num_features_from_interactions = 0

partial_prediction

float VW::example::partial_prediction = 0.f

passthrough

features* VW::example::passthrough

Initial value:

=
      nullptr

pred

polyprediction VW::example::pred

sorted

bool VW::example::sorted = false

tag

VW::v_array<char> VW::example::tag

test_only

bool VW::example::test_only = false

total_sum_feat_sq

float VW::example::total_sum_feat_sq = 0.f

updated_prediction

float VW::example::updated_prediction = 0.f

weight

float VW::example::weight = 1.f

---

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

• /nix/store/2saqbz278bj3pvhbfxlcc50cjbvs3h0h-source/vowpalwabbit/core/include/vw/core/example.h