Vowpal Wabbit
Public Types | Public Member Functions | Friends | List of all members
features_iterator< feature_value_type_t, feature_index_type_t > Class Template Referencefinal

#include <feature_group.h>

Public Types

using iterator_category = std::random_access_iterator_tag
 
using difference_type = std::ptrdiff_t
 
using value_type = features_iterator< feature_value_type_t, feature_index_type_t >
 
using pointer = value_type *
 
using reference = value_type &
 
using const_reference = const value_type &
 

Public Member Functions

 features_iterator ()
 
 features_iterator (feature_value_type_t *begin_values, feature_index_type_t *begin_indices)
 
 features_iterator (const features_iterator &)=default
 
features_iterator & operator= (const features_iterator &)=default
 
 features_iterator (features_iterator &&) noexcept=default
 
features_iterator & operator= (features_iterator &&) noexcept=default
 
feature_value_type_t & value ()
 
const feature_value_type_t & value () const
 
feature_index_type_t & index ()
 
const feature_index_type_t & index () const
 
reference operator* ()
 
const_reference operator* () const
 
features_iterator & operator++ ()
 
features_iterator & operator+= (difference_type diff)
 
features_iterator & operator-= (difference_type diff)
 

Friends

struct features
 
features_iterator< feature_value_type_t, feature_index_type_t > operator+ (const features_iterator &lhs, difference_type rhs)
 
features_iterator< feature_value_type_t, feature_index_type_t > operator+ (difference_type lhs, const features_iterator &rhs)
 
difference_type operator- (const features_iterator &lhs, const features_iterator &rhs)
 
features_iterator< feature_value_type_t, feature_index_type_t > operator- (const features_iterator &lhs, difference_type rhs)
 
bool operator< (const features_iterator &lhs, const features_iterator &rhs)
 
bool operator> (const features_iterator &lhs, const features_iterator &rhs)
 
bool operator<= (const features_iterator &lhs, const features_iterator &rhs)
 
bool operator>= (const features_iterator &lhs, const features_iterator &rhs)
 
bool operator== (const features_iterator &lhs, const features_iterator &rhs)
 
bool operator!= (const features_iterator &lhs, const features_iterator &rhs)
 
void swap (features_iterator &lhs, features_iterator &rhs)
 

Member Typedef Documentation

◆ const_reference

template<typename feature_value_type_t , typename feature_index_type_t >
using features_iterator< feature_value_type_t, feature_index_type_t >::const_reference = const value_type&

◆ difference_type

template<typename feature_value_type_t , typename feature_index_type_t >
using features_iterator< feature_value_type_t, feature_index_type_t >::difference_type = std::ptrdiff_t

◆ iterator_category

template<typename feature_value_type_t , typename feature_index_type_t >
using features_iterator< feature_value_type_t, feature_index_type_t >::iterator_category = std::random_access_iterator_tag

◆ pointer

template<typename feature_value_type_t , typename feature_index_type_t >
using features_iterator< feature_value_type_t, feature_index_type_t >::pointer = value_type*

◆ reference

template<typename feature_value_type_t , typename feature_index_type_t >
using features_iterator< feature_value_type_t, feature_index_type_t >::reference = value_type&

◆ value_type

template<typename feature_value_type_t , typename feature_index_type_t >
using features_iterator< feature_value_type_t, feature_index_type_t >::value_type = features_iterator<feature_value_type_t, feature_index_type_t>

Constructor & Destructor Documentation

◆ features_iterator() [1/4]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator< feature_value_type_t, feature_index_type_t >::features_iterator ( )
inline

◆ features_iterator() [2/4]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator< feature_value_type_t, feature_index_type_t >::features_iterator ( feature_value_type_t *  begin_values,
feature_index_type_t *  begin_indices 
)
inline

◆ features_iterator() [3/4]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator< feature_value_type_t, feature_index_type_t >::features_iterator ( const features_iterator< feature_value_type_t, feature_index_type_t > &  )
default

◆ features_iterator() [4/4]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator< feature_value_type_t, feature_index_type_t >::features_iterator ( features_iterator< feature_value_type_t, feature_index_type_t > &&  )
defaultnoexcept

Member Function Documentation

◆ index() [1/2]

template<typename feature_value_type_t , typename feature_index_type_t >
feature_index_type_t& features_iterator< feature_value_type_t, feature_index_type_t >::index ( )
inline

◆ index() [2/2]

template<typename feature_value_type_t , typename feature_index_type_t >
const feature_index_type_t& features_iterator< feature_value_type_t, feature_index_type_t >::index ( ) const
inline

◆ operator*() [1/2]

template<typename feature_value_type_t , typename feature_index_type_t >
reference features_iterator< feature_value_type_t, feature_index_type_t >::operator* ( )
inline

◆ operator*() [2/2]

template<typename feature_value_type_t , typename feature_index_type_t >
const_reference features_iterator< feature_value_type_t, feature_index_type_t >::operator* ( ) const
inline

◆ operator++()

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator& features_iterator< feature_value_type_t, feature_index_type_t >::operator++ ( )
inline

◆ operator+=()

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator& features_iterator< feature_value_type_t, feature_index_type_t >::operator+= ( difference_type  diff)
inline

◆ operator-=()

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator& features_iterator< feature_value_type_t, feature_index_type_t >::operator-= ( difference_type  diff)
inline

◆ operator=() [1/2]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator& features_iterator< feature_value_type_t, feature_index_type_t >::operator= ( const features_iterator< feature_value_type_t, feature_index_type_t > &  )
default

◆ operator=() [2/2]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator& features_iterator< feature_value_type_t, feature_index_type_t >::operator= ( features_iterator< feature_value_type_t, feature_index_type_t > &&  )
defaultnoexcept

◆ value() [1/2]

template<typename feature_value_type_t , typename feature_index_type_t >
feature_value_type_t& features_iterator< feature_value_type_t, feature_index_type_t >::value ( )
inline

◆ value() [2/2]

template<typename feature_value_type_t , typename feature_index_type_t >
const feature_value_type_t& features_iterator< feature_value_type_t, feature_index_type_t >::value ( ) const
inline

Friends And Related Function Documentation

◆ features

template<typename feature_value_type_t , typename feature_index_type_t >
friend struct features
friend

◆ operator!=

template<typename feature_value_type_t , typename feature_index_type_t >
bool operator!= ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator+ [1/2]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator<feature_value_type_t, feature_index_type_t> operator+ ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
difference_type  rhs 
)
friend

◆ operator+ [2/2]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator<feature_value_type_t, feature_index_type_t> operator+ ( difference_type  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator- [1/2]

template<typename feature_value_type_t , typename feature_index_type_t >
difference_type operator- ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator- [2/2]

template<typename feature_value_type_t , typename feature_index_type_t >
features_iterator<feature_value_type_t, feature_index_type_t> operator- ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
difference_type  rhs 
)
friend

◆ operator<

template<typename feature_value_type_t , typename feature_index_type_t >
bool operator< ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator<=

template<typename feature_value_type_t , typename feature_index_type_t >
bool operator<= ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator==

template<typename feature_value_type_t , typename feature_index_type_t >
bool operator== ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator>

template<typename feature_value_type_t , typename feature_index_type_t >
bool operator> ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ operator>=

template<typename feature_value_type_t , typename feature_index_type_t >
bool operator>= ( const features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
const features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend

◆ swap

template<typename feature_value_type_t , typename feature_index_type_t >
void swap ( features_iterator< feature_value_type_t, feature_index_type_t > &  lhs,
features_iterator< feature_value_type_t, feature_index_type_t > &  rhs 
)
friend
The documentation for this class was generated from the following file:
Generated on Wed Apr 6 2022 19:04:18 for Vowpal Wabbit by   doxygen 1.8.13