xgboost: xgboost::BitFieldContainer< VT, Direction, IsConst > Struct Template Reference

xgboost

A non-owning type with auxiliary methods defined for manipulating bits. More...

#include <bitfield.h>

Collaboration diagram for xgboost::BitFieldContainer< VT, Direction, IsConst >:

Collaboration graph

Classes
struct	Pos

Public Types
using	value_type = std::conditional_t< IsConst, VT const, VT >

using	pointer = value_type *

Public Member Functions
	BitFieldContainer ()=default

XGBOOST_DEVICE	BitFieldContainer (common::Span< value_type > bits)

XGBOOST_DEVICE	BitFieldContainer (BitFieldContainer const &other)

common::Span< value_type >	Bits ()

common::Span< value_type const >	Bits () const

BitFieldContainer &	operator\|= (BitFieldContainer const &rhs)

BitFieldContainer &	operator&= (BitFieldContainer const &rhs)

void	Set (value_type pos)

void	Clear (value_type pos)

XGBOOST_DEVICE bool	Check (Pos pos_v) const

XGBOOST_DEVICE bool	Check (value_type pos) const

XGBOOST_DEVICE size_t	Size () const

XGBOOST_DEVICE pointer	Data () const

Static Public Member Functions
static XGBOOST_DEVICE Pos	ToBitPos (value_type pos)

static XGBOOST_DEVICE size_t	ComputeStorageSize (size_t size)

Static Public Attributes
static constexpr value_type	kValueSize = sizeof(value_type) * 8

static constexpr value_type	kOne = 1

Friends
std::ostream &	operator<< (std::ostream &os, BitFieldContainer< VT, Direction, IsConst > field)

Detailed Description

template<typename VT, typename Direction, bool IsConst = false>
struct xgboost::BitFieldContainer< VT, Direction, IsConst >

A non-owning type with auxiliary methods defined for manipulating bits.

Template Parameters

Direction Whether the bits start from left or from right.

Member Typedef Documentation

◆ pointer

template<typename VT , typename Direction , bool IsConst = false>

using xgboost::BitFieldContainer< VT, Direction, IsConst >::pointer = value_type*

◆ value_type

template<typename VT , typename Direction , bool IsConst = false>

using xgboost::BitFieldContainer< VT, Direction, IsConst >::value_type = std::conditional_t<IsConst, VT const, VT>

Constructor & Destructor Documentation

◆ BitFieldContainer() [1/3]

template<typename VT , typename Direction , bool IsConst = false>

xgboost::BitFieldContainer< VT, Direction, IsConst >::BitFieldContainer ( )

default

◆ BitFieldContainer() [2/3]

template<typename VT , typename Direction , bool IsConst = false>

XGBOOST_DEVICE xgboost::BitFieldContainer< VT, Direction, IsConst >::BitFieldContainer ( common::Span< value_type > bits )

inlineexplicit

◆ BitFieldContainer() [3/3]

template<typename VT , typename Direction , bool IsConst = false>

XGBOOST_DEVICE xgboost::BitFieldContainer< VT, Direction, IsConst >::BitFieldContainer ( BitFieldContainer< VT, Direction, IsConst > const & other )

inline

Member Function Documentation

◆ Bits() [1/2]

template<typename VT , typename Direction , bool IsConst = false>

common::Span<value_type> xgboost::BitFieldContainer< VT, Direction, IsConst >::Bits ( )

inline

◆ Bits() [2/2]

template<typename VT , typename Direction , bool IsConst = false>

common::Span<value_type const> xgboost::BitFieldContainer< VT, Direction, IsConst >::Bits ( ) const

inline

◆ Check() [1/2]

template<typename VT , typename Direction , bool IsConst = false>

XGBOOST_DEVICE bool xgboost::BitFieldContainer< VT, Direction, IsConst >::Check ( Pos pos_v ) const

inline

◆ Check() [2/2]

template<typename VT , typename Direction , bool IsConst = false>

XGBOOST_DEVICE bool xgboost::BitFieldContainer< VT, Direction, IsConst >::Check ( value_type pos ) const

inline

◆ Clear()

template<typename VT , typename Direction , bool IsConst = false>

void xgboost::BitFieldContainer< VT, Direction, IsConst >::Clear ( value_type pos )

inline

◆ ComputeStorageSize()

template<typename VT , typename Direction , bool IsConst = false>

static XGBOOST_DEVICE size_t xgboost::BitFieldContainer< VT, Direction, IsConst >::ComputeStorageSize ( size_t size )

inlinestatic

◆ Data()

template<typename VT , typename Direction , bool IsConst = false>

XGBOOST_DEVICE pointer xgboost::BitFieldContainer< VT, Direction, IsConst >::Data ( ) const

inline

◆ operator&=()

template<typename VT , typename Direction , bool IsConst = false>

BitFieldContainer& xgboost::BitFieldContainer< VT, Direction, IsConst >::operator&= ( BitFieldContainer< VT, Direction, IsConst > const & rhs )

inline

◆ operator|=()

template<typename VT , typename Direction , bool IsConst = false>

BitFieldContainer& xgboost::BitFieldContainer< VT, Direction, IsConst >::operator|= ( BitFieldContainer< VT, Direction, IsConst > const & rhs )

inline

◆ Set()

template<typename VT , typename Direction , bool IsConst = false>

void xgboost::BitFieldContainer< VT, Direction, IsConst >::Set ( value_type pos )

inline

◆ Size()

template<typename VT , typename Direction , bool IsConst = false>

XGBOOST_DEVICE size_t xgboost::BitFieldContainer< VT, Direction, IsConst >::Size ( ) const

inline

◆ ToBitPos()

template<typename VT , typename Direction , bool IsConst = false>

static XGBOOST_DEVICE Pos xgboost::BitFieldContainer< VT, Direction, IsConst >::ToBitPos ( value_type pos )

inlinestatic

Friends And Related Function Documentation

◆ operator<<

template<typename VT , typename Direction , bool IsConst = false>

std::ostream& operator<<	(	std::ostream &	os,
		BitFieldContainer< VT, Direction, IsConst >	field
	)

friend

Member Data Documentation

◆ kOne

template<typename VT , typename Direction , bool IsConst = false>

constexpr value_type xgboost::BitFieldContainer< VT, Direction, IsConst >::kOne = 1

staticconstexpr

◆ kValueSize

template<typename VT , typename Direction , bool IsConst = false>

constexpr value_type xgboost::BitFieldContainer< VT, Direction, IsConst >::kValueSize = sizeof(value_type) * 8

staticconstexpr

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

/home/runner/work/xgboost/xgboost/src/common/bitfield.h