cuml_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2024, 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 <cuda_runtime_api.h>
 
#include <stddef.h>
 
// Block inclusion of this header when compiling libcuml++.so. If this error is
// shown during compilation, there is an issue with how the `#include` have
// been set up. To debug the issue, run `./build.sh cppdocs` and open the page
// 'cpp/build/html/cuml__api_8h.html' in a browser. This will show which files
// directly and indirectly include this file. Only files ending in '*_api' or
// 'cumlHandle' should include this header.
#ifdef CUML_CPP_API
#error "This header is only for the C-API and should not be included from the C++ API."
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int cumlHandle_t;
 
typedef enum cumlError_t { CUML_SUCCESS, CUML_ERROR_UNKNOWN, CUML_INVALID_HANDLE } cumlError_t;
 
typedef cudaError_t (*cuml_allocate)(void** p, size_t n, cudaStream_t stream);
typedef cudaError_t (*cuml_deallocate)(void* p, size_t n, cudaStream_t stream);
 
const char* cumlGetErrorString(cumlError_t error);
 
cumlError_t cumlCreate(cumlHandle_t* handle, cudaStream_t stream);
 
cumlError_t cumlGetStream(cumlHandle_t handle, cudaStream_t* stream);
 
cumlError_t cumlSetDeviceAllocator(cumlHandle_t handle,
                                   cuml_allocate allocate_fn,
                                   cuml_deallocate deallocate_fn);
cumlError_t cumlSetHostAllocator(cumlHandle_t handle,
                                 cuml_allocate allocate_fn,
                                 cuml_deallocate deallocate_fn);
 
cumlError_t cumlDestroy(cumlHandle_t handle);
 
#ifdef __cplusplus
}
#endif