template for all quantile sketch algorithm that uses merge/prune scheme More...

#include <quantile.h>

Inheritance diagram for xgboost::common::QuantileSketchTemplate< DType, RType, TSummary >:

Data Structures
struct	SummaryContainer
	same as summary, but use STL to backup the space More...

Public Types
using	Summary = TSummary
	type of summary type

using	Entry = typename Summary::Entry
	the entry type

Public Member Functions
void	Init (size_t maxn, double eps)
	initialize the quantile sketch, given the performance specification

void	Push (DType x, RType w=1)
	add an element to a sketch

void	PushSummary (const Summary &summary)

void	PushTemp ()
	push up temp

void	GetSummary (SummaryContainer *out)
	get the summary after finalize

void	CheckValid (RType eps) const

void	InitLevel (size_t nlevel)

Static Public Member Functions
static void	LimitSizeLevel (size_t maxn, double eps, size_t out_nlevel, size_t out_limit_size)

Detailed Description

template<typename DType, typename RType, class TSummary>
class xgboost::common::QuantileSketchTemplate< DType, RType, TSummary >

template for all quantile sketch algorithm that uses merge/prune scheme

Template Parameters

DType	type of data content
RType	type of rank
TSummary	actual summary data structure it uses

Member Function Documentation

template<typename DType , typename RType , class TSummary >

void xgboost::common::QuantileSketchTemplate< DType, RType, TSummary >::Init	(	size_t	maxn,
		double	eps
	)

inline

initialize the quantile sketch, given the performance specification

Parameters

maxn	maximum number of data points can be feed into sketch
eps	accuracy level of summary

template<typename DType , typename RType , class TSummary >

void xgboost::common::QuantileSketchTemplate< DType, RType, TSummary >::Push	(	DType	x,
		RType	w = `1`
	)

inline

add an element to a sketch

Parameters

x	The element added to the sketch
w	The weight of the element.

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