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

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

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

template<typename Array, typename Policy, typename Allocator>

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

explicit

Constructor.

Parameters

seed	for the hash function that was used to create the sketch
policy	user-defined way of combining Summary during intersection
allocator	to use for allocating and deallocating memory

Member Function Documentation

update()

template<typename Array, typename Policy, typename Allocator>

template<typename FwdSketch>

void update

(

FwdSketch &&

sketch

)

Updates the intersection with a given sketch.

The sketch must have the same number of values as the intersection policy.

Parameters

sketch

to intersect with

Exceptions

std::invalid_argument

if the number of values does not match

get_result()

template<typename Array, typename Policy, typename Allocator = typename Array::allocator_type>

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

ordered

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

• tuple/include/array_tuple_intersection.hpp
• tuple/include/array_tuple_intersection_impl.hpp