datasketches-cpp
Public Member Functions | List of all members
theta_sketch_alloc< Allocator > Class Template Referenceabstract

Base class for the Theta Sketch, a generalization of the Kth Minimum Value (KMV) sketch. More...

#include <theta_sketch.hpp>

Inheritance diagram for theta_sketch_alloc< Allocator >:
base_theta_sketch_alloc< std::allocator< uint64_t > >

Public Member Functions

virtual iterator begin ()=0
 Iterator over hash values in this sketch. More...
 
virtual iterator end ()=0
 Iterator pointing past the valid range. More...
 
virtual const_iterator begin () const =0
 Const iterator over hash values in this sketch. More...
 
virtual const_iterator end () const =0
 Const iterator pointing past the valid range. More...
 
- Public Member Functions inherited from base_theta_sketch_alloc< std::allocator< uint64_t > >
virtual std::allocator< uint64_t > get_allocator () const=0
 
virtual bool is_empty () const=0
 
double get_estimate () const
 
double get_lower_bound (uint8_t num_std_devs) const
 Returns the approximate lower error bound given a number of standard deviations. More...
 
double get_upper_bound (uint8_t num_std_devs) const
 Returns the approximate upper error bound given a number of standard deviations. More...
 
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
 
virtual string< std::allocator< uint64_t > > to_string (bool print_items=false) const
 Provides a human-readable summary of this sketch as a string. More...
 

Detailed Description

template<typename Allocator = std::allocator<uint64_t>>
class datasketches::theta_sketch_alloc< Allocator >

Base class for the Theta Sketch, a generalization of the Kth Minimum Value (KMV) sketch.

Member Function Documentation

◆ begin() [1/2]

virtual iterator begin ( )
pure virtual

Iterator over hash values in this sketch.

Returns
begin iterator

Implemented in compact_theta_sketch_alloc< Allocator >, and update_theta_sketch_alloc< Allocator >.

◆ end() [1/2]

virtual iterator end ( )
pure virtual

Iterator pointing past the valid range.

Not to be incremented or dereferenced.

Returns
end iterator

Implemented in compact_theta_sketch_alloc< Allocator >, and update_theta_sketch_alloc< Allocator >.

◆ begin() [2/2]

virtual const_iterator begin ( ) const
pure virtual

Const iterator over hash values in this sketch.

Returns
begin iterator

Implemented in compact_theta_sketch_alloc< Allocator >, and update_theta_sketch_alloc< Allocator >.

◆ end() [2/2]

virtual const_iterator end ( ) const
pure virtual

Const iterator pointing past the valid range.

Not to be incremented or dereferenced.

Returns
end iterator

Implemented in compact_theta_sketch_alloc< Allocator >, and update_theta_sketch_alloc< Allocator >.


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