Update Tuple sketch. More...

#include <tuple_sketch.hpp>

Inheritance diagram for update_tuple_sketch< Summary, Update, Policy, Allocator >:

Classes
class	builder
	Update Tuple sketch builder. More...

Public Member Functions
virtual Allocator	get_allocator () const

virtual bool	is_empty () const

virtual bool	is_ordered () const

virtual uint64_t	get_theta64 () const

virtual uint32_t	get_num_retained () const

virtual uint16_t	get_seed_hash () const

uint8_t	get_lg_k () const

resize_factor	get_rf () const

template<typename FwdUpdate >
void	update (const std::string &key, FwdUpdate &&value)
	Update this sketch with a given string.

template<typename FwdUpdate >
void	update (uint64_t key, FwdUpdate &&value)
	Update this sketch with a given unsigned 64-bit integer.

template<typename FwdUpdate >
void	update (int64_t key, FwdUpdate &&value)
	Update this sketch with a given signed 64-bit integer.

template<typename FwdUpdate >
void	update (uint32_t key, FwdUpdate &&value)
	Update this sketch with a given unsigned 32-bit integer.

template<typename FwdUpdate >
void	update (int32_t key, FwdUpdate &&value)
	Update this sketch with a given signed 32-bit integer.

template<typename FwdUpdate >
void	update (uint16_t key, FwdUpdate &&value)
	Update this sketch with a given unsigned 16-bit integer.

template<typename FwdUpdate >
void	update (int16_t key, FwdUpdate &&value)
	Update this sketch with a given signed 16-bit integer.

template<typename FwdUpdate >
void	update (uint8_t key, FwdUpdate &&value)
	Update this sketch with a given unsigned 8-bit integer.

template<typename FwdUpdate >
void	update (int8_t key, FwdUpdate &&value)
	Update this sketch with a given signed 8-bit integer.

template<typename FwdUpdate >
void	update (double key, FwdUpdate &&value)
	Update this sketch with a given double-precision floating point value.

template<typename FwdUpdate >
void	update (float key, FwdUpdate &&value)
	Update this sketch with a given floating point value.

template<typename FwdUpdate >
void	update (const void *key, size_t length, FwdUpdate &&value)
	Update this sketch with given data of any type.

void	trim ()
	Remove retained entries in excess of the nominal size k (if any)

void	reset ()
	Reset the sketch to the initial empty state.

compact_tuple_sketch< Summary, Allocator >	compact (bool ordered=true) const
	Converts this sketch to a compact sketch (ordered or unordered).

template<typename Predicate >
compact_tuple_sketch< Summary, Allocator >	filter (const Predicate &predicate) const
	Produces a Compact Tuple sketch from this sketch by applying a given predicate to each entry.

virtual iterator	begin ()
	Iterator over entries in this sketch.

virtual iterator	end ()
	Iterator pointing past the valid range.

virtual const_iterator	begin () const
	Const iterator over entries in this sketch.

virtual const_iterator	end () const
	Const iterator pointing past the valid range.

Public Member Functions inherited from tuple_sketch< Summary, Allocator >
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

string< Allocator >	to_string (bool print_items=false) const
	Provides a human-readable summary of this sketch as a string.

Detailed Description

template<typename Summary, typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>
class datasketches::update_tuple_sketch< Summary, Update, Policy, Allocator >

Update Tuple sketch.

The purpose of this class is to build a Tuple sketch from input data via the update() methods. There is no constructor. Use builder instead.

Member Function Documentation

◆ get_allocator()

template<typename S , typename U , typename P , typename A >

A get_allocator ( ) const

virtual

Returns: allocator

Implements tuple_sketch< Summary, Allocator >.

◆ is_empty()

template<typename S , typename U , typename P , typename A >

bool is_empty ( ) const

virtual

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

Implements tuple_sketch< Summary, Allocator >.

◆ is_ordered()

template<typename S , typename U , typename P , typename A >

bool is_ordered ( ) const

virtual

Returns: true if retained entries are ordered

Implements tuple_sketch< Summary, Allocator >.

◆ get_theta64()

template<typename S , typename U , typename P , typename A >

uint64_t get_theta64 ( ) const

virtual

Returns: theta as a positive integer between 0 and LLONG_MAX

Implements tuple_sketch< Summary, Allocator >.

◆ get_num_retained()

template<typename S , typename U , typename P , typename A >

uint32_t get_num_retained ( ) const

virtual

Returns: the number of retained entries in the sketch

Implements tuple_sketch< Summary, Allocator >.

◆ get_seed_hash()

template<typename S , typename U , typename P , typename A >

uint16_t get_seed_hash ( ) const

virtual

Returns: hash of the seed that was used to hash the input

Implements tuple_sketch< Summary, Allocator >.

◆ get_lg_k()

template<typename S , typename U , typename P , typename A >

uint8_t get_lg_k ( ) const

Returns: configured nominal number of entries in the sketch

◆ get_rf()

template<typename S , typename U , typename P , typename A >

auto get_rf ( ) const

Returns: configured resize factor of the sketch

◆ update() [1/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	const std::string &	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given string.

Parameters

key	string to update the sketch with
value	to update the sketch with

◆ update() [2/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	uint64_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given unsigned 64-bit integer.

Parameters

key	uint64_t to update the sketch with
value	to update the sketch with

◆ update() [3/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	int64_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given signed 64-bit integer.

Parameters

key	int64_t to update the sketch with
value	to update the sketch with

◆ update() [4/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	uint32_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given unsigned 32-bit integer.

For compatibility with Java implementation.

Parameters

key	uint32_t to update the sketch with
value	to update the sketch with

◆ update() [5/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	int32_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given signed 32-bit integer.

For compatibility with Java implementation.

Parameters

key	int32_t to update the sketch with
value	to update the sketch with

◆ update() [6/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	uint16_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given unsigned 16-bit integer.

For compatibility with Java implementation.

Parameters

key	uint16_t to update the sketch with
value	to update the sketch with

◆ update() [7/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	int16_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given signed 16-bit integer.

For compatibility with Java implementation.

Parameters

key	int16_t to update the sketch with
value	to update the sketch with

◆ update() [8/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	uint8_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given unsigned 8-bit integer.

For compatibility with Java implementation.

Parameters

key	uint8_t to update the sketch with
value	to update the sketch with

◆ update() [9/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	int8_t	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given signed 8-bit integer.

For compatibility with Java implementation.

Parameters

key	int8_t to update the sketch with
value	to update the sketch with

◆ update() [10/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	double	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given double-precision floating point value.

For compatibility with Java implementation.

Parameters

key	double to update the sketch with
value	to update the sketch with

◆ update() [11/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	float	key,
		FwdUpdate &&	value
	)

inline

Update this sketch with a given floating point value.

For compatibility with Java implementation.

Parameters

key	float to update the sketch with
value	to update the sketch with

◆ update() [12/12]

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename FwdUpdate >

void update	(	const void *	key,
		size_t	length,
		FwdUpdate &&	value
	)

Update this sketch with given data of any type.

This is a "universal" update that covers all cases above, but may produce different hashes. Be very careful to hash input values consistently using the same approach both over time and on different platforms and while passing sketches between C++ environment and Java environment. Otherwise two sketches that should represent overlapping sets will be disjoint For instance, for signed 32-bit values call update(int32_t) method above, which does widening conversion to int64_t, if compatibility with Java is expected

Parameters

key	pointer to the data
length	of the data in bytes
value	to update the sketch with

◆ compact()

template<typename S , typename U , typename P , typename A >

compact_tuple_sketch< S, A > compact ( bool ordered = true ) const

Converts this sketch to a compact sketch (ordered or unordered).

Parameters

ordered optional flag to specify if an ordered sketch should be produced

Returns: compact sketch

◆ filter()

template<typename Summary , typename Update = Summary, typename Policy = default_tuple_update_policy<Summary, Update>, typename Allocator = std::allocator<Summary>>

template<typename Predicate >

compact_tuple_sketch< Summary, Allocator > filter ( const Predicate & predicate ) const

Produces a Compact Tuple sketch from this sketch by applying a given predicate to each entry.

Parameters

predicate should return true for the entries to keep

Returns: compact sketch with the entries retained according to the predicate

◆ begin() [1/2]

template<typename S , typename U , typename P , typename A >

auto begin ( )

virtual

Iterator over entries in this sketch.

Returns: begin iterator

Implements tuple_sketch< Summary, Allocator >.

◆ end() [1/2]

template<typename S , typename U , typename P , typename A >

auto end ( )

virtual

Iterator pointing past the valid range.

Not to be incremented or dereferenced.

Returns: end iterator

Implements tuple_sketch< Summary, Allocator >.

◆ begin() [2/2]

template<typename S , typename U , typename P , typename A >

auto begin ( ) const

virtual

Const iterator over entries in this sketch.

Returns: begin const iterator

Implements tuple_sketch< Summary, Allocator >.

◆ end() [2/2]

template<typename S , typename U , typename P , typename A >

auto end ( ) const

virtual

Const iterator pointing past the valid range.

Not to be incremented or dereferenced.

Returns: end const iterator

Implements tuple_sketch< Summary, Allocator >.

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

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

Classes

Public Member Functions

Detailed Description

Member Function Documentation

◆ get_allocator()

◆ is_empty()

◆ is_ordered()

◆ get_theta64()

◆ get_num_retained()

◆ get_seed_hash()

◆ get_lg_k()

◆ get_rf()

◆ update() [1/12]

◆ update() [2/12]

◆ update() [3/12]

◆ update() [4/12]

◆ update() [5/12]

◆ update() [6/12]

◆ update() [7/12]

◆ update() [8/12]

◆ update() [9/12]

◆ update() [10/12]

◆ update() [11/12]

◆ update() [12/12]

◆ compact()

◆ filter()

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]