rmm::mr::polymorphic_allocator< T > Class Template Reference

A stream ordered Allocator using a rmm::mr::device_memory_resource to satisfy (de)allocations. More...

#include <polymorphic_allocator.hpp>

Public Types
using	value_type = T
	T, the value type of objects allocated by this allocator.

Public Member Functions
	polymorphic_allocator ()=default
	Construct a polymorphic_allocator using the return value of rmm::mr::get_current_device_resource_ref() as the underlying memory resource.
	polymorphic_allocator (device_async_resource_ref mr)
	Construct a polymorphic_allocator using the provided memory resource. More...
template<typename U >
	polymorphic_allocator (polymorphic_allocator< U > const &other) noexcept
	Construct a polymorphic_allocator using the underlying memory resource of other. More...
value_type *	allocate (std::size_t num, cuda_stream_view stream)
	Allocates storage for num objects of type T using the underlying memory resource. More...
void	deallocate (value_type *ptr, std::size_t num, cuda_stream_view stream)
	Deallocates storage pointed to by ptr. More...
rmm::device_async_resource_ref	get_upstream_resource () const noexcept
	rmm::device_async_resource_ref to the upstream resource More...

Detailed Description

template<typename T>
class rmm::mr::polymorphic_allocator< T >

A stream ordered Allocator using a rmm::mr::device_memory_resource to satisfy (de)allocations.

Similar to std::pmr::polymorphic_allocator, uses the runtime polymorphism of device_memory_resource to allow containers with polymorphic_allocator as their static allocator type to be interoperable, but exhibit different behavior depending on resource used.

Unlike STL allocators, polymorphic_allocator's allocate and deallocate functions are stream ordered. Use stream_allocator_adaptor to allow interoperability with interfaces that require standard, non stream-ordered Allocator interfaces.

Template Parameters

T	The allocators value type.

Constructor & Destructor Documentation

polymorphic_allocator() [1/2]

template<typename T >

rmm::mr::polymorphic_allocator< T >::polymorphic_allocator ( device_async_resource_ref  mr )

inline

Construct a polymorphic_allocator using the provided memory resource.

This constructor provides an implicit conversion from device_async_resource_ref.

Parameters

mr	The upstream memory resource to use for allocation.

polymorphic_allocator() [2/2]

template<typename T >

template<typename U >

rmm::mr::polymorphic_allocator< T >::polymorphic_allocator ( polymorphic_allocator< U > const &  other )

inlinenoexcept

Construct a polymorphic_allocator using the underlying memory resource of other.

Parameters

other

The polymorphic_allocator whose memory resource will be used as the underlying resource of the new polymorphic_allocator.

Member Function Documentation

allocate()

template<typename T >

value_type* rmm::mr::polymorphic_allocator< T >::allocate ( std::size_t  num, cuda_stream_view  stream  )

inline

Allocates storage for num objects of type T using the underlying memory resource.

Parameters

num	The number of objects to allocate storage for
stream	The stream on which to perform the allocation

Returns

Pointer to the allocated storage

deallocate()

template<typename T >

void rmm::mr::polymorphic_allocator< T >::deallocate ( value_type *  ptr, std::size_t  num, cuda_stream_view  stream  )

inline

Deallocates storage pointed to by ptr.

ptr must have been allocated from a memory resource r that compares equal to get_upstream_resource() using r.allocate(n * sizeof(T)).

Parameters

ptr	Pointer to memory to deallocate
num	Number of objects originally allocated
stream	Stream on which to perform the deallocation

get_upstream_resource()

template<typename T >

rmm::device_async_resource_ref rmm::mr::polymorphic_allocator< T >::get_upstream_resource ( ) const

inlinenoexcept

rmm::device_async_resource_ref to the upstream resource

Returns

rmm::device_async_resource_ref to the upstream resource

---

The documentation for this class was generated from the following file:

• polymorphic_allocator.hpp