tuple_sketch< Summary, Allocator > Class Template Reference

Base class for Tuple sketch. More...

#include <tuple_sketch.hpp>

Inheritance diagram for tuple_sketch< Summary, Allocator >:

Public Member Functions
virtual Allocator	get_allocator () const =0
virtual bool	is_empty () const =0
double	get_estimate () const
double	get_lower_bound (uint8_t num_std_devs, uint32_t num_subset_entries) const
	Returns the approximate lower error bound given a number of standard deviations over an arbitrary number of items stored in the sketch.
double	get_lower_bound (uint8_t num_std_devs) const
	Returns the approximate lower error bound given a number of standard deviations.
double	get_upper_bound (uint8_t num_std_devs, uint32_t num_subset_entries) const
	Returns the approximate upper error bound given a number of standard deviations over an arbitrary number of items stored in the sketch.
double	get_upper_bound (uint8_t num_std_devs) const
	Returns the approximate upper error bound given a number of standard deviations.
bool	is_estimation_mode () const
double	get_theta () const
virtual uint64_t	get_theta64 () const =0
virtual uint32_t	get_num_retained () const =0
virtual uint16_t	get_seed_hash () const =0
virtual bool	is_ordered () const =0
string< Allocator >	to_string (bool print_items=false) const
	Provides a human-readable summary of this sketch as a string.
virtual iterator	begin ()=0
	Iterator over entries in this sketch.
virtual iterator	end ()=0
	Iterator pointing past the valid range.
virtual const_iterator	begin () const =0
	Const iterator over entries in this sketch.
virtual const_iterator	end () const =0
	Const iterator pointing past the valid range.

Detailed Description

template<typename Summary, typename Allocator = std::allocator<Summary>>
class datasketches::tuple_sketch< Summary, Allocator >

Base class for Tuple sketch.

This is an extension of Theta sketch that allows keeping arbitrary Summary associated with each retained key.

Member Function Documentation

get_allocator()

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual Allocator get_allocator ( ) const

pure virtual

Returns

allocator

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

is_empty()

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual bool is_empty ( ) const

pure virtual

Returns

true if this sketch represents an empty set (not the same as no retained entries!)

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

get_estimate()

template<typename S , typename A >

double get_estimate

(

)

const

Returns

estimate of the distinct count of the input stream

get_lower_bound() [1/2]

template<typename S , typename A >

double get_lower_bound	(	uint8_t	num_std_devs,
		uint32_t	num_subset_entries
	)		const

Returns the approximate lower error bound given a number of standard deviations over an arbitrary number of items stored in the sketch.

This parameter is similar to the number of standard deviations of the normal distribution and corresponds to approximately 67%, 95% and 99% confidence intervals.

Parameters

num_std_devs	number of Standard Deviations (1, 2 or 3)
num_subset_entries	number of items from {0, 1, ..., get_num_retained()} over which to estimate the bound

Returns

the lower bound

get_lower_bound() [2/2]

template<typename S , typename A >

double get_lower_bound

(

uint8_t

num_std_devs

)

const

Returns the approximate lower error bound given a number of standard deviations.

This parameter is similar to the number of standard deviations of the normal distribution and corresponds to approximately 67%, 95% and 99% confidence intervals.

Parameters

num_std_devs

number of Standard Deviations (1, 2 or 3)

Returns

the lower bound

get_upper_bound() [1/2]

template<typename S , typename A >

double get_upper_bound	(	uint8_t	num_std_devs,
		uint32_t	num_subset_entries
	)		const

Returns the approximate upper error bound given a number of standard deviations over an arbitrary number of items stored in the sketch.

This parameter is similar to the number of standard deviations of the normal distribution and corresponds to approximately 67%, 95% and 99% confidence intervals.

Parameters

num_std_devs	number of Standard Deviations (1, 2 or 3)
num_subset_entries	number of items from {0, 1, ..., get_num_retained()} over which to estimate the bound

Returns

the lower bound

get_upper_bound() [2/2]

template<typename S , typename A >

double get_upper_bound

(

uint8_t

num_std_devs

)

const

Returns the approximate upper error bound given a number of standard deviations.

This parameter is similar to the number of standard deviations of the normal distribution and corresponds to approximately 67%, 95% and 99% confidence intervals.

Parameters

num_std_devs

number of Standard Deviations (1, 2 or 3)

Returns

the upper bound

is_estimation_mode()

template<typename S , typename A >

bool is_estimation_mode

(

)

const

Returns

true if the sketch is in estimation mode (as opposed to exact mode)

get_theta()

template<typename S , typename A >

double get_theta

(

)

const

Returns

theta as a fraction from 0 to 1 (effective sampling rate)

get_theta64()

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual uint64_t get_theta64 ( ) const

pure virtual

Returns

theta as a positive integer between 0 and LLONG_MAX

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

get_num_retained()

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual uint32_t get_num_retained ( ) const

pure virtual

Returns

the number of retained entries in the sketch

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

get_seed_hash()

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual uint16_t get_seed_hash ( ) const

pure virtual

Returns

hash of the seed that was used to hash the input

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

is_ordered()

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual bool is_ordered ( ) const

pure virtual

Returns

true if retained entries are ordered

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

to_string()

template<typename S , typename A >

string< A > to_string

(

bool

print_items = false

)

const

Provides a human-readable summary of this sketch as a string.

Parameters

print_items

if true include the list of items retained by the sketch

Returns

sketch summary as a string

begin() [1/2]

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual iterator begin ( )

pure virtual

Iterator over entries in this sketch.

Returns

begin iterator

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

end() [1/2]

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual iterator end ( )

pure virtual

Iterator pointing past the valid range.

Not to be incremented or dereferenced.

Returns

end iterator

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

begin() [2/2]

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual const_iterator begin ( ) const

pure virtual

Const iterator over entries in this sketch.

Returns

begin const iterator

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

end() [2/2]

template<typename Summary , typename Allocator = std::allocator<Summary>>

virtual const_iterator end ( ) const

pure virtual

Const iterator pointing past the valid range.

Not to be incremented or dereferenced.

Returns

end const iterator

Implemented in update_tuple_sketch< Summary, Update, Policy, Allocator >, update_tuple_sketch< Array, Array, default_array_tuple_update_policy< Array >, typename Array::allocator_type >, compact_tuple_sketch< Summary, Allocator >, and compact_tuple_sketch< Array, typename Array::allocator_type >.

---

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

• tuple/include/tuple_sketch.hpp
• tuple/include/tuple_sketch_impl.hpp