features Struct Reference

the core definition of a set of features. More...

#include <feature_group.h>

Public Types
using	iterator = features_iterator< feature_value, feature_index >
using	const_iterator = features_iterator< const feature_value, const feature_index >
using	audit_iterator = audit_features_iterator< feature_value, feature_index, audit_strings >
using	const_audit_iterator = audit_features_iterator< const feature_value, const feature_index, const audit_strings >
using	extent_iterator = ns_extent_iterator< features, audit_iterator, std::vector< VW::namespace_extent >::iterator >
using	const_extent_iterator = ns_extent_iterator< const features, const_audit_iterator, std::vector< VW::namespace_extent >::const_iterator >

Public Member Functions
	features ()=default
	~features ()=default
	features (const features &)=default
features &	operator= (const features &)=default
	features (features &&other)=default
features &	operator= (features &&other)=default
size_t	size () const
bool	empty () const
bool	nonempty () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
VW::generic_range< audit_iterator >	audit_range ()
VW::generic_range< const_audit_iterator >	audit_range () const
audit_iterator	audit_begin ()
const_audit_iterator	audit_begin () const
audit_iterator	audit_end ()
const_audit_iterator	audit_end () const
const_audit_iterator	audit_cbegin () const
const_audit_iterator	audit_cend () const
extent_iterator	hash_extents_begin (uint64_t hash)
const_extent_iterator	hash_extents_begin (uint64_t hash) const
extent_iterator	hash_extents_end (uint64_t hash)
const_extent_iterator	hash_extents_end (uint64_t hash) const
template<typename FuncT >
void	foreach_feature_for_hash (uint64_t hash, const FuncT &func) const
void	clear ()
void	truncate_to (const audit_iterator &pos, float sum_feat_sq_of_removed_section)
void	truncate_to (const iterator &pos, float sum_feat_sq_of_removed_section)
void	truncate_to (size_t i, float sum_feat_sq_of_removed_section)
void	truncate_to (const audit_iterator &pos)
void	truncate_to (const iterator &pos)
void	truncate_to (size_t i)
void	concat (const features &other)
void	push_back (feature_value v, feature_index i)
void	push_back (feature_value v, feature_index i, uint64_t ns_hash)
bool	sort (uint64_t parse_mask)
void	start_ns_extent (uint64_t hash)
void	end_ns_extent ()
bool	validate_extents ()

Public Attributes
v_array< feature_value >	values
v_array< feature_index >	indices
std::vector< audit_strings >	space_names
std::vector< VW::namespace_extent >	namespace_extents
float	sum_feat_sq = 0.f

Detailed Description

the core definition of a set of features.

Member Typedef Documentation

audit_iterator

using features::audit_iterator = audit_features_iterator<feature_value, feature_index, audit_strings>

const_audit_iterator

using features::const_audit_iterator = audit_features_iterator<const feature_value, const feature_index, const audit_strings>

const_extent_iterator

using features::const_extent_iterator = ns_extent_iterator<const features, const_audit_iterator, std::vector<VW::namespace_extent>::const_iterator>

const_iterator

using features::const_iterator = features_iterator<const feature_value, const feature_index>

extent_iterator

using features::extent_iterator = ns_extent_iterator<features, audit_iterator, std::vector<VW::namespace_extent>::iterator>

iterator

using features::iterator = features_iterator<feature_value, feature_index>

Constructor & Destructor Documentation

features() [1/3]

features::features ( )

default

~features()

features::~features ( )

default

features() [2/3]

features::features ( const features &  )

default

features() [3/3]

features::features ( features &&  other )

default

Member Function Documentation

audit_begin() [1/2]

audit_iterator features::audit_begin ( )

inline

audit_begin() [2/2]

const_audit_iterator features::audit_begin ( ) const

inline

audit_cbegin()

const_audit_iterator features::audit_cbegin ( ) const

inline

audit_cend()

const_audit_iterator features::audit_cend ( ) const

inline

audit_end() [1/2]

audit_iterator features::audit_end ( )

inline

audit_end() [2/2]

const_audit_iterator features::audit_end ( ) const

inline

audit_range() [1/2]

VW::generic_range<audit_iterator> features::audit_range ( )

inline

audit_range() [2/2]

VW::generic_range<const_audit_iterator> features::audit_range ( ) const

inline

begin() [1/2]

iterator features::begin ( )

inline

begin() [2/2]

const_iterator features::begin ( ) const

inline

cbegin()

const_iterator features::cbegin ( ) const

inline

cend()

const_iterator features::cend ( ) const

inline

clear()

void features::clear

(

)

concat()

void features::concat

(

const features &

other

)

empty()

bool features::empty ( ) const

inline

end() [1/2]

iterator features::end ( )

inline

end() [2/2]

const_iterator features::end ( ) const

inline

end_ns_extent()

void features::end_ns_extent

(

)

foreach_feature_for_hash()

template<typename FuncT >

void features::foreach_feature_for_hash ( uint64_t  hash, const FuncT &  func  ) const

inline

hash_extents_begin() [1/2]

extent_iterator features::hash_extents_begin ( uint64_t  hash )

inline

hash_extents_begin() [2/2]

const_extent_iterator features::hash_extents_begin ( uint64_t  hash ) const

inline

hash_extents_end() [1/2]

extent_iterator features::hash_extents_end ( uint64_t  hash )

inline

hash_extents_end() [2/2]

const_extent_iterator features::hash_extents_end ( uint64_t  hash ) const

inline

nonempty()

bool features::nonempty ( ) const

inline

operator=() [1/2]

features& features::operator= ( const features &  )

default

operator=() [2/2]

features& features::operator= ( features &&  other )

default

push_back() [1/2]

void features::push_back	(	feature_value	v,
		feature_index	i
	)

push_back() [2/2]

void features::push_back	(	feature_value	v,
		feature_index	i,
		uint64_t	ns_hash
	)

size()

size_t features::size ( ) const

inline

sort()

bool features::sort

(

uint64_t

parse_mask

)

start_ns_extent()

void features::start_ns_extent

(

uint64_t

hash

)

truncate_to() [1/6]

void features::truncate_to	(	const audit_iterator &	pos,
		float	sum_feat_sq_of_removed_section
	)

truncate_to() [2/6]

void features::truncate_to	(	const iterator &	pos,
		float	sum_feat_sq_of_removed_section
	)

truncate_to() [3/6]

void features::truncate_to	(	size_t	i,
		float	sum_feat_sq_of_removed_section
	)

truncate_to() [4/6]

void features::truncate_to

(

const audit_iterator &

pos

)

truncate_to() [5/6]

void features::truncate_to

(

const iterator &

pos

)

truncate_to() [6/6]

void features::truncate_to

(

size_t

i

)

validate_extents()

bool features::validate_extents ( )

inline

Member Data Documentation

indices

v_array<feature_index> features::indices

namespace_extents

std::vector<VW::namespace_extent> features::namespace_extents

space_names

std::vector<audit_strings> features::space_names

sum_feat_sq

float features::sum_feat_sq = 0.f

values

v_array<feature_value> features::values

---

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

• /__w/vowpal_wabbit/vowpal_wabbit/vowpalwabbit/feature_group.h