Memory Resource Management

Classes
class	cudf::memory_resources
	Non-owning references to the memory resources used by a cuDF operation. More...

Functions
rmm::device_async_resource_ref	cudf::get_current_device_resource_ref ()
	Get the current device memory resource reference. More...
cuda::mr::any_resource< cuda::mr::device_accessible >	cudf::set_current_device_resource (cuda::mr::any_resource< cuda::mr::device_accessible > mr)
	Set the current device memory resource. More...
cuda::mr::any_resource< cuda::mr::device_accessible >	cudf::set_current_device_resource_ref (rmm::device_async_resource_ref mr)
	Set the current device memory resource reference. More...
cuda::mr::any_resource< cuda::mr::device_accessible >	cudf::reset_current_device_resource ()
	Reset the current device memory resource to the initial resource. More...
cuda::mr::any_resource< cuda::mr::device_accessible >	cudf::reset_current_device_resource_ref ()
	Reset the current device memory resource reference to the initial resource. More...

Detailed Description

Function Documentation

get_current_device_resource_ref()

rmm::device_async_resource_ref cudf::get_current_device_resource_ref ( )

inline

#include <cudf/utilities/memory_resource.hpp>

Get the current device memory resource reference.

Returns

The current device memory resource reference.

Definition at line 34 of file memory_resource.hpp.

reset_current_device_resource()

cuda::mr::any_resource<cuda::mr::device_accessible> cudf::reset_current_device_resource ( )

inline

#include <cudf/utilities/memory_resource.hpp>

Reset the current device memory resource to the initial resource.

Returns

An owning any_resource holding the previous resource.

Definition at line 147 of file memory_resource.hpp.

reset_current_device_resource_ref()

cuda::mr::any_resource<cuda::mr::device_accessible> cudf::reset_current_device_resource_ref ( )

inline

#include <cudf/utilities/memory_resource.hpp>

Reset the current device memory resource reference to the initial resource.

Deprecated:

Use reset_current_device_resource instead.

Returns

An owning any_resource holding the previous resource.

Definition at line 161 of file memory_resource.hpp.

set_current_device_resource()

cuda::mr::any_resource<cuda::mr::device_accessible> cudf::set_current_device_resource ( cuda::mr::any_resource< cuda::mr::device_accessible >  mr )

inline

#include <cudf/utilities/memory_resource.hpp>

Set the current device memory resource.

Parameters

mr	The new device memory resource.

Returns

An owning any_resource holding the previous resource.

Definition at line 118 of file memory_resource.hpp.

set_current_device_resource_ref()

cuda::mr::any_resource<cuda::mr::device_accessible> cudf::set_current_device_resource_ref ( rmm::device_async_resource_ref  mr )

inline

#include <cudf/utilities/memory_resource.hpp>

Set the current device memory resource reference.

Deprecated:

Use set_current_device_resource instead.

The object referenced by mr must outlive the last use of the resource, otherwise behavior is undefined. It is the caller's responsibility to maintain the lifetime of the resource object.

Parameters

mr	The new device memory resource reference.

Returns

An owning any_resource holding the previous resource.

Definition at line 137 of file memory_resource.hpp.