VW::sparse_parameters Class Reference

#include <array_parameters_sparse.h>

Public Types
using	iterator = details::sparse_iterator< VW::weight >
using	const_iterator = details::sparse_iterator< const VW::weight >

Public Member Functions
	sparse_parameters (size_t length, uint32_t stride_shift=0)
	sparse_parameters ()
	sparse_parameters (const sparse_parameters &other)=delete
sparse_parameters &	operator= (const sparse_parameters &other)=delete
sparse_parameters &	operator= (sparse_parameters &&) noexcept=delete
	sparse_parameters (sparse_parameters &&) noexcept=delete
bool	not_null ()
VW::weight *	first ()
iterator	begin ()
iterator	end ()
const_iterator	cbegin () const
const_iterator	cend () const
VW::weight &	operator[] (size_t i)
const VW::weight &	operator[] (size_t i) const
VW::weight &	get (size_t i)
const VW::weight &	get (size_t i) const
VW::weight &	strided_index (size_t index)
const VW::weight &	strided_index (size_t index) const
void	shallow_copy (const sparse_parameters &input)
template<typename Lambda >
void	set_default (Lambda &&default_func)
void	set_zero (size_t offset)
uint64_t	mask () const
uint64_t	stride () const
uint32_t	stride_shift () const
void	stride_shift (uint32_t stride_shift)
void	share (size_t)

Member Typedef Documentation

const_iterator

using VW::sparse_parameters::const_iterator = details::sparse_iterator<const VW::weight>

iterator

using VW::sparse_parameters::iterator = details::sparse_iterator<VW::weight>

Constructor & Destructor Documentation

sparse_parameters() [1/4]

VW::sparse_parameters::sparse_parameters	(	size_t	length,
		uint32_t	stride_shift = 0
	)

sparse_parameters() [2/4]

VW::sparse_parameters::sparse_parameters

(

)

sparse_parameters() [3/4]

VW::sparse_parameters::sparse_parameters ( const sparse_parameters &  other )

delete

sparse_parameters() [4/4]

VW::sparse_parameters::sparse_parameters ( sparse_parameters &&  )

deletenoexcept

Member Function Documentation

begin()

iterator VW::sparse_parameters::begin ( )

inline

cbegin()

const_iterator VW::sparse_parameters::cbegin ( ) const

inline

cend()

const_iterator VW::sparse_parameters::cend ( ) const

inline

end()

iterator VW::sparse_parameters::end ( )

inline

first()

VW::weight * VW::sparse_parameters::first ( )

inline

get() [1/2]

VW::weight & VW::sparse_parameters::get ( size_t  i )

inline

get() [2/2]

const VW::weight & VW::sparse_parameters::get ( size_t  i ) const

inline

mask()

uint64_t VW::sparse_parameters::mask ( ) const

inline

not_null()

bool VW::sparse_parameters::not_null ( )

inline

operator=() [1/2]

sparse_parameters & VW::sparse_parameters::operator= ( const sparse_parameters &  other )

delete

operator=() [2/2]

sparse_parameters & VW::sparse_parameters::operator= ( sparse_parameters &&  )

deletenoexcept

operator[]() [1/2]

VW::weight & VW::sparse_parameters::operator[] ( size_t  i )

inline

operator[]() [2/2]

const VW::weight & VW::sparse_parameters::operator[] ( size_t  i ) const

inline

set_default()

template<typename Lambda >

void VW::sparse_parameters::set_default ( Lambda &&  default_func )

inline

set_zero()

void VW::sparse_parameters::set_zero

(

size_t

offset

)

shallow_copy()

void VW::sparse_parameters::shallow_copy

(

const sparse_parameters &

input

)

share()

void VW::sparse_parameters::share

(

size_t

)

stride()

uint64_t VW::sparse_parameters::stride ( ) const

inline

stride_shift() [1/2]

uint32_t VW::sparse_parameters::stride_shift ( ) const

inline

stride_shift() [2/2]

void VW::sparse_parameters::stride_shift ( uint32_t  stride_shift )

inline

strided_index() [1/2]

VW::weight & VW::sparse_parameters::strided_index ( size_t  index )

inline

strided_index() [2/2]

const VW::weight & VW::sparse_parameters::strided_index ( size_t  index ) const

inline

---

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

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