example.h File Reference

#include "vw/core/action_score.h"
#include "vw/core/active_multiclass_prediction.h"
#include "vw/core/cb.h"
#include "vw/core/cb_continuous_label.h"
#include "vw/core/cb_with_observations_label.h"
#include "vw/core/ccb_label.h"
#include "vw/core/constant.h"
#include "vw/core/cost_sensitive.h"
#include "vw/core/decision_scores.h"
#include "vw/core/example_predict.h"
#include "vw/core/feature_group.h"
#include "vw/core/multiclass.h"
#include "vw/core/multilabel.h"
#include "vw/core/no_label.h"
#include "vw/core/prediction_type.h"
#include "vw/core/prob_dist_cont.h"
#include "vw/core/simple_label.h"
#include "vw/core/slates_label.h"
#include "vw/core/v_array.h"
#include <cstdint>
#include <functional>
#include <vector>

Classes
class	VW::polylabel
struct	VW::no_pred
class	VW::polyprediction
class	VW::example

Namespaces
namespace	VW
namespace	VW::details

Macros
#define	VW_ADD_PASSTHROUGH_FEATURE(ec, i, x)

Typedefs
using	VW::example_factory_t = std::function< example &()>
using	polylabel = VW::polylabel
using	polyprediction = VW::polyprediction
using	example = VW::example
using	multi_ex = VW::multi_ex

Functions
void	VW::copy_example_data (example *dst, const example *src)
void	VW::setup_example (VW::workspace &all, example *ae)
std::string	VW::to_string (const v_array< float > &scalars, int decimal_precision=details::DEFAULT_FLOAT_PRECISION)
void	VW::swap_prediction (polyprediction &a, polyprediction &b, prediction_type_t prediction_type)
void	VW::flatten_features (VW::workspace &all, example &ec, features &fs)
bool	VW::example_is_newline (const example &ec)
bool	VW::valid_ns (char c)
void	VW::details::add_passthrough_feature_magic (example &ec, uint64_t magic, uint64_t i, float x)
void	VW::return_multiple_example (VW::workspace &all, VW::multi_ex &examples)
void	VW::details::clean_example (VW::workspace &all, example &ec)
void	VW::details::append_example_namespace (VW::example &ec, VW::namespace_index ns, const features &fs)
void	VW::details::truncate_example_namespace (VW::example &ec, VW::namespace_index ns, const features &fs)
void	VW::details::append_example_namespaces_from_example (VW::example &target, const VW::example &source)
void	VW::details::truncate_example_namespaces_from_example (VW::example &target, const VW::example &source)
bool	example_is_newline (const VW::example &ec)
bool	valid_ns (char c)

Macro Definition Documentation

VW_ADD_PASSTHROUGH_FEATURE

#define VW_ADD_PASSTHROUGH_FEATURE	(		ec,
			i,
			x
	)

Value:

  VW::details::add_passthrough_feature_magic( \
      ec, __FILE__[0] * 483901 + __FILE__[1] * 3417 + __FILE__[2] * 8490177, i, x);

Typedef Documentation

example

using example = VW::example

multi_ex

using multi_ex = VW::multi_ex

polylabel

using polylabel = VW::polylabel

polyprediction

using polyprediction = VW::polyprediction

Function Documentation

example_is_newline()

bool example_is_newline ( const VW::example &  ec )

inline

Deprecated:

"example_is_newline moved into VW namespace"

valid_ns()

bool valid_ns ( char  c )

inline

Deprecated:

"valid_ns moved into VW namespace"