xgboost::EllpackPage Class Reference

A page stored in ELLPACK format. More...

#include <ellpack_page.h>

Public Member Functions
	EllpackPage ()
	Default constructor.
	EllpackPage (Context const *ctx, DMatrix *dmat, const BatchParam &param)
	Constructor from an existing DMatrix.
	~EllpackPage ()
	Destructor.
	EllpackPage (EllpackPage &&that)
size_t	Size () const
void	SetBaseRowId (std::size_t row_id)
	Set the base row id for this page.
const EllpackPageImpl *	Impl () const
EllpackPageImpl *	Impl ()
common::HistogramCuts &	Cuts ()
common::HistogramCuts const &	Cuts () const

Detailed Description

A page stored in ELLPACK format.

This class uses the PImpl idiom (https://en.cppreference.com/w/cpp/language/pimpl) to avoid including CUDA-specific implementation details in the header.

Constructor & Destructor Documentation

EllpackPage() [1/2]

xgboost::EllpackPage::EllpackPage ( )

default

Default constructor.

This is used in the external memory case. An empty ELLPACK page is constructed with its content set later by the reader.

EllpackPage() [2/2]

xgboost::EllpackPage::EllpackPage ( Context const *  ctx, DMatrix *  dmat, const BatchParam &  param  )

explicit

Constructor from an existing DMatrix.

This is used in the in-memory case. The ELLPACK page is constructed from an existing DMatrix in CSR format.

Member Function Documentation

Size()

size_t xgboost::EllpackPage::Size

(

)

const

Returns

Number of instances in the page.

---

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

• External/xgboost/src/data/ellpack_page.h
• External/xgboost/src/data/ellpack_page.cc