datasketches-cpp
Loading...
Searching...
No Matches
update_tuple_sketch< Summary, Update, Policy, Allocator >::builder Class Reference

Update Tuple sketch builder. More...

#include <tuple_sketch.hpp>

Inheritance diagram for update_tuple_sketch< Summary, Update, Policy, Allocator >::builder:
tuple_base_builder< builder, P, A > theta_base_builder< builder, A >

Public Member Functions

 builder (const P &policy=P(), const A &allocator=A())
 Constructor Creates and instance of the builder with default parameters.
update_tuple_sketch< S, U, P, A > build () const
 This is to create an instance of the sketch with predefined parameters.
Public Member Functions inherited from theta_base_builder< builder, A >
 theta_base_builder (const A &allocator)
 Creates and instance of the builder with default parameters.
builder & set_lg_k (uint8_t lg_k)
 Set log2(k), where k is a nominal number of entries in the sketch.
builder & set_resize_factor (resize_factor rf)
 Set resize factor for the internal hash table (defaults to 8).
builder & set_p (float p)
 Set sampling probability (initial theta).
builder & set_seed (uint64_t seed)
 Set the seed for the hash function.

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 >::builder

Update Tuple sketch builder.

Constructor & Destructor Documentation

◆ builder()

template<typename S, typename U, typename P, typename A>
builder ( const P & policy = P(),
const A & allocator = A() )

Constructor Creates and instance of the builder with default parameters.

Parameters
policyuser-defined way of creating and updating Summary
allocatorinstance of an Allocator to pass to created sketches

Member Function Documentation

◆ build()

template<typename S, typename U, typename P, typename A>
auto build ( ) const

This is to create an instance of the sketch with predefined parameters.

Returns
an instance of the sketch

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