datasketches-cpp
Public Member Functions | List of all members
array_tuple_intersection< Array, Policy, Allocator > Class Template Reference

array tuple intersection More...

#include <array_tuple_intersection.hpp>

Inheritance diagram for array_tuple_intersection< Array, Policy, Allocator >:
tuple_intersection< Array, Policy, typename Array::allocator_type >

Public Member Functions

 array_tuple_intersection (uint64_t seed=DEFAULT_SEED, const Policy &policy=Policy(), const Allocator &allocator=Allocator())
 Constructor. More...
 
CompactSketch get_result (bool ordered=true) const
 Produces a copy of the current state of the intersection. More...
 
- Public Member Functions inherited from tuple_intersection< Array, Policy, typename Array::allocator_type >
 tuple_intersection (uint64_t seed=DEFAULT_SEED, const Policy &policy=Policy(), const typename Array::allocator_type &allocator=typename Array::allocator_type())
 Constructor. More...
 
void update (FwdSketch &&sketch)
 Updates the intersection with a given sketch. More...
 
CompactSketch get_result (bool ordered=true) const
 Produces a copy of the current state of the intersection. More...
 
bool has_result () const
 Returns true if the state of the intersection is defined (not infinite "universe"). More...
 

Detailed Description

template<typename Array, typename Policy, typename Allocator = typename Array::allocator_type>
class datasketches::array_tuple_intersection< Array, Policy, Allocator >

array tuple intersection

Constructor & Destructor Documentation

◆ array_tuple_intersection()

array_tuple_intersection ( uint64_t  seed = DEFAULT_SEED,
const Policy &  policy = Policy(),
const Allocator &  allocator = Allocator() 
)
explicit

Constructor.

Parameters
seedfor the hash function that was used to create the sketch
policyuser-defined way of combining Summary during intersection
allocatorto use for allocating and deallocating memory

Member Function Documentation

◆ get_result()

auto get_result ( bool  ordered = true) const

Produces a copy of the current state of the intersection.

If update() was not called, the state is the infinite "universe", which is considered an undefined state, and throws an exception.

Parameters
orderedoptional flag to specify if an ordered sketch should be produced
Returns
the result of the intersection as a compact sketch

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