hipRAFT C++ API documentation

2026-03-13

7 min read time

Applies to Linux

• Core
  • Error Handling
    • Exceptions
      • raft::cublas_error
      • raft::cusolver_error
      • raft::cusparse_error
      • raft::exception
      • raft::logic_error
      • raft::non_cuda_build_error
    • Assertion Macros
      • RAFT_CUSOLVER_TRY
      • CUSOLVER_TRY
      • RAFT_CUSOLVER_TRY_NO_THROW
      • RAFT_CUSPARSE_TRY
      • RAFT_CUSPARSE_TRY_NO_THROW
      • RAFT_CUBLAS_TRY
      • CUBLAS_TRY
      • RAFT_CUBLAS_TRY_NO_THROW
      • RAFT_EXPECTS
      • RAFT_FAIL
  • Copy
    • copy()
    • RAFT_NON_CUDA_COPY_IMPLEMENTED
  • Core Types
    • Enumeration Types
      • Apply
    • Stream View
      • stream_view_per_thread
      • raft::stream_view
  • Resources
    • Vocabulary
      • resource_type
      • raft::resource::resource
      • raft::resource::empty_resource
      • raft::resource::resource_factory
      • raft::resource::empty_resource_factory
    • Device Resources
      • raft::device_resources
    • Device Resources Manager
      • raft::device_resources_manager
    • SNMG Device Resources
      • raft::device_resources_snmg
    • Resource Functions
      • Comms
      • hipBLAS Handle
      • hipBLASLt Handle
      • HIP Stream
      • HIP Stream Pool
      • hipSOLVER Dense Handle
      • hipSOLVER Sparse Handle
      • hipSPARSE Handle
      • Device ID
      • Device Memory Resource
      • Device Properties
      • Sub Communicators
      • rocThrust Exec Policy
      • Custom runtime-shared resources
  • Key-Value Pair
    • raft::KeyValuePair
      • Key
      • Value
      • KeyValuePair()
      • KeyValuePair()
      • key
      • value
  • Profiling Ranges (ROCTX)
    • push_range()
    • pop_range()
    • raft::common::nvtx::range
      • range()
  • Interruptible
    • raft::interrupted_exception
    • raft::interruptible
      • cancel()
      • synchronize()
      • synchronize()
      • yield()
      • yield_no_throw()
      • get_token()
      • get_token()
      • cancel()
  • Operators and Functors
    • add_const_op
    • sub_const_op
    • mul_const_op
    • div_const_op
    • div_checkzero_const_op
    • pow_const_op
    • mod_const_op
    • equal_const_op
    • absdiff_op
    • sqdiff_op
    • raft::identity_op
    • raft::void_op
    • raft::cast_op
    • raft::key_op
    • raft::value_op
    • raft::sqrt_op
    • raft::nz_op
    • raft::abs_op
    • raft::sq_op
    • raft::add_op
    • raft::sub_op
    • raft::mul_op
    • raft::div_op
    • raft::div_checkzero_op
    • raft::pow_op
    • raft::mod_op
    • raft::min_op
    • raft::max_op
    • raft::argmin_op
    • raft::argmax_op
    • raft::greater_op
    • raft::less_op
    • raft::greater_or_equal_op
    • raft::less_or_equal_op
    • raft::equal_op
    • raft::notequal_op
    • raft::const_op
    • raft::plug_const_op
    • raft::compose_op
    • raft::map_args_op
  • Mathematical Functions
    • abs()
  • Bitset
    • raft::core::bitset_view
      • bitset_view()
      • bitset_view()
      • test()
      • operator[]()
      • data()
      • size()
      • n_elements()
      • count()
      • count()
      • repeat()
      • sparsity()
      • get_original_nbits()
      • to_csr()
      • eval_n_elements()
    • raft::core::bitset
      • bitset()
      • bitset()
      • view()
      • data()
      • size()
      • n_elements()
      • to_mdspan()
      • resize()
      • test()
      • set()
      • flip()
      • reset()
      • count()
      • count()
      • any()
      • all()
      • none()
  • Bitmap
    • raft::core::bitmap_view
      • bitmap_view()
      • bitmap_view()
      • to_csr()
• Linear Algebra
  • Arithmetic
    • Addition
      • add()
      • add_scalar()
    • Binary Op
      • binary_op()
    • Division
      • divide_scalar()
    • Multiplication
      • multiply_scalar()
    • Power
      • power()
      • power_scalar()
    • Square Root
      • sqrt()
    • Subtraction
      • subtract()
      • subtract_scalar()
    • Ternary Op
      • ternary_op()
    • Unary Op
      • unary_op()
      • write_only_unary_op()
  • BLAS Routines
    • axpy
      • axpy()
    • dot
      • cublasdot()
      • cublasdot()
      • cublasdot()
      • dot()
    • gemm
      • cublasgemm()
      • cublasgemm()
      • cublasgemm()
      • gemm()
    • gemv
      • cublasgemv()
      • cublasgemv()
      • cublasgemv()
      • gemv()
  • Mapping and Reduction
    • Coalesced Reduction
      • coalesced_reduction()
    • Map
      • map()
      • map()
      • map()
      • map()
      • map_offset()
      • map_offset()
      • map_offset()
      • map_offset()
    • Map Reduce
      • map_reduce()
    • Mean Squared Error
      • mean_squared_error()
    • Norm
      • norm()
    • Normalize
      • row_normalize()
      • row_normalize()
    • Reduction
      • reduce()
    • Reduce Cols By Key
      • reduce_cols_by_key()
    • Reduce Rows By Key
      • reduce_rows_by_key()
    • Strided Reduction
      • strided_reduction()
  • Matrix Operations
    • Transpose
      • transpose()
  • Matrix-Vector Operations
    • Arithmetic
      • binary_mult_skip_zero()
      • binary_div()
      • binary_div_skip_zero()
      • binary_add()
      • binary_sub()
    • Operations
      • matrix_vector_op()
      • matrix_vector_op()
  • Linear Algebra Solvers
    • Eigen Decomposition
      • eig_dc()
      • eig_dc_selective()
      • eig_jacobi()
    • QR Decomposition
      • qr_get_q()
      • qr_get_qr()
    • Randomized Singular-Value Decomposition
      • rsvd_fixed_rank()
      • rsvd_fixed_rank()
      • rsvd_fixed_rank_symmetric()
      • rsvd_fixed_rank_symmetric()
      • rsvd_fixed_rank_jacobi()
      • rsvd_fixed_rank_jacobi()
      • rsvd_fixed_rank_symmetric_jacobi()
      • rsvd_fixed_rank_symmetric_jacobi()
      • rsvd_perc()
      • rsvd_perc()
      • rsvd_perc_symmetric()
      • rsvd_perc_symmetric()
      • rsvd_perc_jacobi()
      • rsvd_perc_jacobi()
      • rsvd_perc_symmetric_jacobi()
      • rsvd_perc_symmetric_jacobi()
      • randomized_svd()
      • randomized_svd()
    • Singular-Value Decomposition
      • cusolverDngesvd_bufferSize()
      • cusolverDngesvd()
      • cusolverDngesvd()
      • cusolverDngesvd()
      • cusolverDnxgesvdr_bufferSize()
      • cusolverDnxgesvdr()
      • svd_qr()
      • svd_qr()
      • svd_qr_transpose_right_vec()
      • svd_qr_transpose_right_vec()
      • svd_eig()
      • svd_eig()
      • svd_reconstruction()
    • Least Squares
      • lstsq_svd_qr()
      • lstsq_svd_jacobi()
      • lstsq_eig()
      • lstsq_qr()
• Matrix
  • Matrix Arithmetic
    • Line-wise Operation
      • linewise_op()
      • linewise_op()
    • Power
      • power()
      • weighted_power()
      • weighted_power()
      • power()
    • Ratio
      • ratio()
      • ratio()
    • Reciprocal
      • reciprocal()
      • reciprocal()
    • Sign-flip
      • sign_flip()
    • Square Root
      • sqrt()
      • sqrt()
      • weighted_sqrt()
      • weighted_sqrt()
  • Matrix Manipulation
    • Initialization
      • fill()
      • fill()
    • Reverse
      • col_reverse()
      • row_reverse()
    • Threshold
      • zero_small_values()
      • zero_small_values()
    • Gather
      • gather()
      • gather()
      • gather_if()
      • gather_if()
      • gather()
      • gather()
      • gather_if()
      • gather_if()
      • gather()
      • gather()
    • Sample Rows
      • sample_rows()
      • sample_rows()
    • Shift
      • shift()
      • shift()
  • Matrix Ordering
    • Argmax
      • argmax()
    • Argmin
      • argmin()
    • Select-K
      • SelectAlgo
      • select_k()
      • operator<<()
      • select_k()
    • Column-wise Sort
      • sort_cols_per_row()
      • sort_cols_per_row()
  • Matrix Reductions
    • Matrix Norm
      • l2_norm()
• Multi-dimensional Data
  • Multi-dimensional Representation
    • Data Layouts
      • layout_c_contiguous
      • row_major
      • layout_f_contiguous
      • col_major
    • Shapes
      • matrix_extent
      • vector_extent
      • scalar_extent
      • extent_3d
      • extent_4d
      • extent_5d
      • value
      • alignTo()
      • flatten()
      • reshape()
      • accessor_of_const()
      • accessor_of_const()
      • raft::detail::padding
      • raft::detail::alignment
      • flatten()
      • reshape()
    • Accessors
      • raft::host_device_accessor
      • host_accessor
      • device_accessor
      • managed_accessor
  • 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_mdspan
      • raft::is_device_mdspan
      • is_device_mdspan_t
      • is_input_device_mdspan_t
      • is_output_device_mdspan_t
      • enable_if_device_mdspan
      • enable_if_input_device_mdspan
      • enable_if_output_device_mdspan
      • device_matrix_view
      • device_vector_view
      • device_scalar_view
    • Device Factories
      • make_device_matrix_view()
      • make_device_vector_view()
      • make_device_scalar_view()
    • Managed Vocabulary
      • managed_mdspan
      • raft::is_managed_mdspan
      • is_managed_mdspan_t
      • is_input_managed_mdspan_t
      • is_output_managed_mdspan_t
      • enable_if_managed_mdspan
      • enable_if_input_managed_mdspan
      • enable_if_output_managed_mdspan
    • Managed Factories
      • make_managed_mdspan()
    • Host Vocabulary
      • host_mdspan
      • raft::is_host_mdspan
      • is_host_mdspan_t
      • is_input_host_mdspan_t
      • is_output_host_mdspan_t
      • enable_if_host_mdspan
      • enable_if_input_host_mdspan
      • enable_if_output_host_mdspan
      • host_matrix_view
      • host_vector_view
      • host_scalar_view
    • Host Factories
      • make_host_matrix_view()
      • make_host_vector_view()
      • make_host_scalar_view()
    • Pinned Vocabulary
      • pinned_mdspan
      • pinned_matrix_view
      • pinned_vector_view
      • pinned_scalar_view
    • Pinned Factories
      • make_pinned_matrix_view()
      • make_pinned_vector_view()
      • make_pinned_vector_view()
      • make_pinned_scalar_view()
    • Validation Routines
      • raft::is_mdspan
      • is_mdspan_t
      • raft::is_input_mdspan
      • is_input_mdspan_t
      • raft::is_output_mdspan
      • is_output_mdspan_t
      • enable_if_mdspan
      • enable_if_input_mdspan
      • enable_if_output_mdspan
  • 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
      • view_type
      • mdarray()
      • view()
      • view()
      • operator()()
      • operator()()
      • extent()
    • Device Vocabulary
      • device_mdarray
      • device_matrix
      • device_vector
      • device_scalar
    • Device Factories
      • make_device_matrix()
      • make_device_vector()
      • make_device_scalar()
    • Host Vocabulary
      • host_matrix
      • host_vector
      • host_scalar
    • Host Factories
      • make_host_mdarray()
      • make_host_matrix()
      • make_host_scalar()
      • make_host_vector()
    • Managed Vocabulary
      • managed_mdarray
      • managed_matrix
      • managed_vector
      • managed_scalar
    • Managed Factories
      • make_managed_matrix()
      • make_managed_vector()
      • make_managed_scalar()
    • Pinned Vocabulary
      • pinned_mdarray
      • pinned_matrix
      • pinned_vector
      • pinned_scalar
    • Pinned Factories
      • make_pinned_matrix()
      • make_pinned_vector()
      • make_pinned_scalar()
  • 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()
    • operator=()
    • operator=()
    • begin()
    • end()
    • cbegin()
    • cend()
    • rbegin()
    • rend()
    • crbegin()
    • crend()
    • 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
      • span()
      • span()
      • span()
      • span()
      • span()
      • subspan()
    • 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
      • mdbuffer()
      • mdbuffer()
      • mdbuffer()
      • mdbuffer()
      • mdbuffer()
      • mdbuffer()
      • mdbuffer()
      • mdbuffer()
      • mem_type()
      • is_owning()
      • view()
      • view()
      • view()
      • view()
    • 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
      • temporary_device_buffer()
      • view()
    • Factories
      • make_temporary_device_buffer()
      • make_readonly_temporary_device_buffer()
      • make_writeback_temporary_device_buffer()
• Multi-node Multi-GPU
  • Common Types
    • datatype_t
      • CHAR
      • UINT8
      • INT32
      • UINT32
      • INT64
      • UINT64
      • FLOAT32
      • FLOAT64
    • op_t
      • SUM
      • PROD
      • MIN
      • MAX
    • status_t
      • SUCCESS
      • ERROR
      • ABORT
    • request_t
    • get_type()
    • get_type< char >()
    • get_type< uint8_t >()
    • get_type< int >()
    • get_type< uint32_t >()
    • get_type< int64_t >()
    • get_type< uint64_t >()
    • get_type< float >()
    • get_type< double >()
  • Comms Interface
    • raft::comms::comms_t
      • ~comms_t()
      • get_size()
      • get_rank()
      • comm_split()
      • barrier()
      • sync_stream()
      • isend()
      • irecv()
      • waitall()
      • allreduce()
      • bcast()
      • bcast()
      • reduce()
      • allgather()
      • allgatherv()
      • gather()
      • gatherv()
      • reducescatter()
      • device_send()
      • device_recv()
      • device_sendrecv()
      • device_multicast_sendrecv()
      • group_start()
      • group_end()
  • MPI Comms
    • initialize_mpi_comms()
  • RCCL+UCX Comms
    • build_comms_nccl_only()
    • build_comms_nccl_ucx()
• Random
  • Random State
    • raft::random::RngState
      • type
    • Data Generation
      • make_blobs
      • make_regression
      • rmat
    • Univariate Random Sampling
      • uniform()
      • uniformInt()
      • normal()
      • normalInt()
      • normalTable()
      • fill()
      • bernoulli()
      • scaled_bernoulli()
      • gumbel()
      • lognormal()
      • logistic()
      • exponential()
      • rayleigh()
      • laplace()
      • discrete()
    • Multi-Variable Random Sampling
      • Multi-Variable Gaussian
    • Sampling Without Replacement
      • sample_without_replacement()
      • sample_without_replacement()
      • permute()
      • permute()
• Solvers
  • Linear Assignment Problem
    • raft::solver::LinearAssignmentProblem
      • LinearAssignmentProblem()
      • solve()
      • getRowDualVector()
      • getColDualVector()
      • getPrimalObjectiveValue()
      • getDualObjectiveValue()
  • Minimum Spanning Tree
    • mst()
• Sparse
  • Sparse Types
    • SparsityType
      • OWNING
      • PRESERVING
    • row_type
    • col_type
    • nnz_type
    • element_type
    • structure_view_type
    • view_type
    • structure_type
    • container_policy_type
    • container_type
    • sparse_structure()
    • sparse_structure()
    • get_nnz()
    • get_n_rows()
    • get_n_cols()
    • initialize_sparsity()
    • sparse_matrix_view()
    • structure_view()
    • get_elements()
    • sparse_matrix()
    • sparse_matrix()
    • sparse_matrix()
    • sparse_matrix()
    • operator=()
    • operator=()
    • ~sparse_matrix()
    • view()
    • raft::sparse_structure
      • sparse_structure()
      • sparse_structure()
      • get_nnz()
      • get_n_rows()
      • get_n_cols()
      • initialize_sparsity()
    • raft::sparse_matrix_view
      • structure_view()
      • get_elements()
    • raft::sparse_matrix
      • structure_view()
      • view()
    • COO Matrix
      • Basic Vocabulary
      • Device COO Matrix
      • Host COO Matrix
    • CSR Matrix
      • Basic Vocabulary
      • Device CSR Matrix
      • Host CSR Matrix
  • Sparse Linear Algebra
    • csr_add_calc_inds()
    • csr_add_finalize()
    • coo_degree()
    • coo_degree()
    • coo_degree_scalar()
    • coo_degree_scalar()
    • coo_degree_nz()
    • coo_degree_nz()
    • compute_graph_laplacian()
    • laplacian_normalized()
    • masked_matmul()
    • masked_matmul()
    • csr_row_normalize_l1()
    • csr_row_normalize_max()
    • rowNormCsr()
    • sddmm()
    • spmm()
    • coo_symmetrize()
    • coo_symmetrize()
    • symmetrize()
    • csr_transpose()
  • Sparse Matrix Operations
    • coo_remove_scalar()
    • coo_remove_scalar()
    • coo_remove_scalar()
    • coo_remove_zeros()
    • compute_duplicates_mask()
    • max_duplicates()
    • csr_row_slice_indptr()
    • csr_row_slice_populate()
    • coo_sort()
    • coo_sort()
    • coo_sort_by_weight()
  • Sparse Solvers
    • LANCZOS_WHICH
      • LA
      • LM
      • SA
      • SM
    • curand_generate_uniformX()
    • curand_generate_uniformX()
    • lanczos_compute_smallest_eigenvectors()
    • lanczos_compute_smallest_eigenvectors()
    • mst()
    • raft::sparse::solver::alteration_functor
    • raft::sparse::solver::new_edges_functor
    • raft::sparse::solver::lanczos_solver_config
      • n_components
      • max_iterations
      • ncv
      • tolerance
      • which
      • seed
    • raft::sparse::solver::Graph_COO
    • raft::sparse::solver::MST_solver
• Spectral
  • Graph Partitioning
  • Modularity Maximization
• Stats
  • Summary Statistics
    • Covariance
      • cov()
    • Histogram
      • HistType
      • histogram()
    • Mean
      • mean()
      • mean()
    • Mean Center
      • mean_center()
      • mean_add()
    • Mean Variance
      • meanvar()
    • Min/Max
      • minmax()
    • Standard Deviation
      • stddev()
    • Sum
      • sum()
    • Weighted Average
      • weighted_mean()
      • row_weighted_mean()
      • col_weighted_mean()
  • Probability & Information Theory
    • Contingency Matrix
      • get_input_class_cardinality()
      • contingency_matrix()
    • Entropy
      • entropy()
    • KL-Divergence
      • kl_divergence()
    • Mutual Information
      • mutual_info_score()
  • Regression Model Scoring
    • Information Criterion
      • IC_Type
      • information_criterion_batched()
    • R2 Score
      • r2_score()
    • Regression Metrics
      • regression_metrics()
  • Classification Model Scoring
    • Accuracy
      • accuracy()
  • Clustering Model Scoring
    • Adjusted Rand Index
      • adjusted_rand_index()
    • Completeness Score
      • completeness_score()
    • Cluster Dispersion
      • cluster_dispersion()
    • Rand Index
      • rand_index()
    • Silhouette Score
      • silhouette_score()
      • silhouette_score_batched()
    • V Measure
      • v_measure()
• Utilities
  • Integer Arithmetic
    • is_narrowing_v
    • round_up_safe()
    • round_down_safe()
    • div_rounding_up_unsafe()
    • div_rounding_up_safe()
    • is_a_power_of_two()
    • bound_by_power_of_two()
    • absolute_value()