Attention

The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called cuVS. We will continue to support the vector search algorithms in RAFT during this move, but will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.10 (October) release and they will be removed from RAFT altogether in the 24.12 (December) release.

Multi-dimensional Data

This page provides C++ class references for the RAFT’s 1d span and multi-dimension owning (mdarray) and non-owning (mdspan) APIs. These headers can be found in the raft/core directory.

Contents:

• Multi-dimensional Representation
  • Data Layouts
  • Shapes
  • Accessors
• mdspan: Multi-dimensional Non-owning View
  • mdspan
  • make_mdspan()
  • make_extents()
  • make_strided_layout()
  • unravel_index()
  • is_c_contiguous()
  • is_f_contiguous()
  • make_const_mdspan()
  • Device Vocabulary
  • Device Factories
  • Managed Vocabulary
  • Managed Factories
  • Host Vocabulary
  • Host Factories
  • Pinned Vocabulary
  • Pinned Factories
  • Validation Routines
• mdarray: Multi-dimensional Owning Container
  • is_array_interface_v
  • raft::array_interface
  • raft::is_array_interface
  • raft::is_array_interface< T1 >
  • raft::is_array_interface< T1, Tn... >
  • raft::mdarray
  • Device Vocabulary
  • Device Factories
  • Host Vocabulary
  • Host Factories
  • Managed Vocabulary
  • Managed Factories
  • Pinned Vocabulary
  • Pinned Factories
• span: One-dimensional Non-owning View
  • element_type
  • value_type
  • size_type
  • difference_type
  • pointer
  • const_pointer
  • reference
  • const_reference
  • iterator
  • const_iterator
  • reverse_iterator
  • const_reverse_iterator
  • span()
  • span()
  • span()
  • span()
  • span()
  • span()
  • span()
  • begin()
  • end()
  • cbegin()
  • cend()
  • front()
  • back()
  • operator[]()
  • data()
  • size()
  • size_bytes()
  • empty()
  • first()
  • first()
  • last()
  • last()
  • subspan()
  • subspan()
  • operator==()
  • operator!=()
  • operator<()
  • operator<=()
  • operator>()
  • operator>=()
  • as_bytes()
  • as_writable_bytes()
  • raft::span
  • device_span
  • host_span
• mdbuffer: Multi-dimensional Maybe-Owning Container
  • alternate_from_mem_type
  • default_container_policy_variant
  • is_mdbuffer_t
  • is_input_mdbuffer_t
  • is_output_mdbuffer_t
  • enable_if_mdbuffer
  • enable_if_input_mdbuffer
  • enable_if_output_mdbuffer
  • is_mdbuffer_v
  • is_input_mdbuffer_v
  • is_output_mdbuffer_v
  • variant_index_from_memory_type()
  • memory_type_from_variant_index()
  • __takes_an_mdbuffer_ptr()
  • raft::default_buffer_container_policy
  • raft::mdbuffer
  • raft::is_mdbuffer
  • raft::is_mdbuffer< T, std::void_t< decltype(__takes_an_mdbuffer_ptr(std::declval< T * >()))> >
  • raft::is_input_mdbuffer
  • raft::is_input_mdbuffer< T, std::void_t< decltype(__takes_an_mdbuffer_ptr(std::declval< T * >()))> >
  • raft::is_output_mdbuffer
  • raft::is_output_mdbuffer< T, std::void_t< decltype(__takes_an_mdbuffer_ptr(std::declval< T * >()))> >
• memory_type_dispatcher
  • memory_type_dispatcher()
  • memory_type_dispatcher()
  • memory_type_dispatcher()
• temporary_device_buffer: Temporary raft::device_mdspan Producing Object
  • raft::temporary_device_buffer
  • Factories