datasketches-cpp
Public Member Functions | List of all members
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. More...
 
update_tuple_sketch< S, U, P, A > build () const
 This is to create an instance of the sketch with predefined parameters. More...
 
- 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. More...
 
builder & set_lg_k (uint8_t lg_k)
 Set log2(k), where k is a nominal number of entries in the sketch. More...
 
builder & set_resize_factor (resize_factor rf)
 Set resize factor for the internal hash table (defaults to 8) More...
 
builder & set_p (float p)
 Set sampling probability (initial theta). More...
 
builder & set_seed (uint64_t seed)
 Set the seed for the hash function. More...
 

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()

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()

auto build

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: