datasketches-cpp
Classes | Public Member Functions | List of all members
tuple_union< Summary, Policy, Allocator > Class Template Reference

Tuple Union. More...

#include <tuple_union.hpp>

Classes

class  builder
 Tuple union builder. More...
 

Public Member Functions

template<typename FwdSketch >
void update (FwdSketch &&sketch)
 Update the union with a given sketch. More...
 
CompactSketch get_result (bool ordered=true) const
 Produces a copy of the current state of the union as a compact sketch. More...
 
void reset ()
 Reset the union to the initial empty state.
 

Detailed Description

template<typename Summary, typename Policy = default_tuple_union_policy<Summary>, typename Allocator = std::allocator<Summary>>
class datasketches::tuple_union< Summary, Policy, Allocator >

Tuple Union.

Computes union of Tuple sketches. There is no constructor. Use builder instead.

Member Function Documentation

◆ update()

void update ( FwdSketch &&  sketch)

Update the union with a given sketch.

Parameters
sketchto update the union with

◆ get_result()

auto get_result ( bool  ordered = true) const

Produces a copy of the current state of the union as a compact sketch.

Parameters
orderedoptional flag to specify if an ordered sketch should be produced
Returns
the result of the union

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