Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
xgboost.data::SparsePageSourceImpl< S > Class Template Referenceabstract

Base class for all page sources. More...

#include <sparse_page_source.h>

Inheritance diagram for xgboost.data::SparsePageSourceImpl< S >:
xgboost::BatchIteratorImpl< S > xgboost.data::PageSourceIncMixIn< CSCPage > xgboost.data::PageSourceIncMixIn< EllpackPage > xgboost.data::PageSourceIncMixIn< GHistIndexMatrix > xgboost.data::PageSourceIncMixIn< SortedCSCPage > xgboost.data::PageSourceIncMixIn< S > xgboost.data::CSCPageSource xgboost.data::EllpackPageSource xgboost.data::GradientIndexPageSource xgboost.data::SortedCSCPageSource

Public Member Functions

 SparsePageSourceImpl (float missing, int nthreads, bst_feature_t n_features, uint32_t n_batches, std::shared_ptr< Cache > cache)
 
 SparsePageSourceImpl (SparsePageSourceImpl const &that)=delete
 
uint32_t Iter () const
 
const S & operator* () const override
 
std::shared_ptr< S const > Page () const override
 
bool AtEnd () const override
 
virtual void Reset ()
 
- Public Member Functions inherited from xgboost::BatchIteratorImpl< S >
virtual BatchIteratorImploperator++ ()=0
 

Protected Types

using Ring = std::vector< std::future< std::shared_ptr< S > > >
 

Protected Member Functions

bool ReadCache ()
 
void WriteCache ()
 
virtual void Fetch ()=0
 

Protected Attributes

std::mutex single_threaded_
 
std::shared_ptr< S > page_
 
bool at_end_ {false}
 
float missing_
 
std::int32_t nthreads_
 
bst_feature_t n_features_
 
std::uint32_t count_ {0}
 
std::uint32_t n_batches_ {0}
 
std::shared_ptr< Cachecache_info_
 
std::unique_ptr< Ring > ring_ {new Ring}
 
ExceHandler exce_
 
common::Monitor monitor_
 

Additional Inherited Members

- Public Types inherited from xgboost::BatchIteratorImpl< S >
using iterator_category = std::forward_iterator_tag
 

Detailed Description

template<typename S>
class xgboost.data::SparsePageSourceImpl< S >

Base class for all page sources.

Handles fetching, writing, and iteration.

Member Function Documentation

◆ AtEnd()

template<typename S >
bool xgboost.data::SparsePageSourceImpl< S >::AtEnd ( ) const
inlineoverridevirtual

◆ operator*()

template<typename S >
const S & xgboost.data::SparsePageSourceImpl< S >::operator* ( ) const
inlineoverridevirtual

◆ Page()

template<typename S >
std::shared_ptr< S const > xgboost.data::SparsePageSourceImpl< S >::Page ( ) const
inlineoverridevirtual

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