dbscan.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2025, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <cuml/common/distance_type.hpp>
#include <cuml/common/logger.hpp>
 
#include <cstddef>
#include <cstdint>
 
namespace raft {
class handle_t;
}
 
namespace ML {
namespace Dbscan {
 
enum EpsNnMethod { BRUTE_FORCE, RBC };
 
void fit(const raft::handle_t& handle,
         float* input,
         int n_rows,
         int n_cols,
         float eps,
         int min_pts,
         ML::distance::DistanceType metric,
         int* labels,
         int* core_sample_indices            = nullptr,
         float* sample_weight                = nullptr,
         size_t max_bytes_per_batch          = 0,
         EpsNnMethod eps_nn_method           = BRUTE_FORCE,
         rapids_logger::level_enum verbosity = rapids_logger::level_enum::info,
         bool opg                            = false);
void fit(const raft::handle_t& handle,
         double* input,
         int n_rows,
         int n_cols,
         double eps,
         int min_pts,
         ML::distance::DistanceType metric,
         int* labels,
         int* core_sample_indices            = nullptr,
         double* sample_weight               = nullptr,
         size_t max_bytes_per_batch          = 0,
         EpsNnMethod eps_nn_method           = BRUTE_FORCE,
         rapids_logger::level_enum verbosity = rapids_logger::level_enum::info,
         bool opg                            = false);
 
void fit(const raft::handle_t& handle,
         float* input,
         int64_t n_rows,
         int64_t n_cols,
         float eps,
         int min_pts,
         ML::distance::DistanceType metric,
         int64_t* labels,
         int64_t* core_sample_indices        = nullptr,
         float* sample_weight                = nullptr,
         size_t max_bytes_per_batch          = 0,
         EpsNnMethod eps_nn_method           = BRUTE_FORCE,
         rapids_logger::level_enum verbosity = rapids_logger::level_enum::info,
         bool opg                            = false);
void fit(const raft::handle_t& handle,
         double* input,
         int64_t n_rows,
         int64_t n_cols,
         double eps,
         int min_pts,
         ML::distance::DistanceType metric,
         int64_t* labels,
         int64_t* core_sample_indices        = nullptr,
         double* sample_weight               = nullptr,
         size_t max_bytes_per_batch          = 0,
         EpsNnMethod eps_nn_method           = BRUTE_FORCE,
         rapids_logger::level_enum verbosity = rapids_logger::level_enum::info,
         bool opg                            = false);
 
}  // namespace Dbscan
}  // namespace ML