Dictionary Search

group dictionary_search

Functions

std::unique_ptr<scalar> get_index(dictionary_column_view const &dictionary, scalar const &key, rmm::cuda_stream_view stream = cudf::get_default_stream(), rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource())

Return the index value for a given key.

If the key does not exist in the dictionary the returned scalar will have is_valid()==false

Throws:

cudf::logic_error – if key.type() != dictionary.keys().type()

Parameters:

• dictionary – The dictionary to search for the key.

• key – The value to search for in the dictionary keyset.

• stream – CUDA stream used for device memory operations and kernel launches.

• mr – Device memory resource used to allocate the returned scalar’s device memory.

Returns:

Numeric scalar index value of the key within the dictionary.