vecmem::conditional_memory_resource Class Reference

This memory resource conditionally allocates memory. More...

#include <vecmem/memory/conditional_memory_resource.hpp>

Inheritance diagram for vecmem::conditional_memory_resource:

Public Member Functions
VECMEM_CORE_EXPORT	conditional_memory_resource (memory_resource &upstream, std::function< bool(std::size_t, std::size_t)> pred)
	Constructs the conditional memory resource.
VECMEM_CORE_EXPORT	conditional_memory_resource (conditional_memory_resource &&parent)
	Move constructor.
	conditional_memory_resource (const conditional_memory_resource &)=delete
	Disallow copying the memory resource.
VECMEM_CORE_EXPORT	~conditional_memory_resource ()
	Destructor.
VECMEM_CORE_EXPORT conditional_memory_resource &	operator= (conditional_memory_resource &&rhs)
	Move assignment operator.
conditional_memory_resource &	operator= (const conditional_memory_resource &)=delete
	Disallow copying the memory resource.

Protected Member Functions
Function(s) implementing @c vecmem::memory_resource
virtual VECMEM_CORE_EXPORT bool	do_is_equal (const memory_resource &other) const noexcept
	Compare the equality of *this memory resource with another.

Private Member Functions
Function(s) implementing @c vecmem::memory_resource
virtual VECMEM_CORE_EXPORT void *	do_allocate (std::size_t, std::size_t) override final
	Allocate memory with one of the underlying resources.
virtual VECMEM_CORE_EXPORT void	do_deallocate (void *p, std::size_t, std::size_t) override final
	De-allocate a previously allocated memory block.

Detailed Description

This memory resource conditionally allocates memory.

It is constructed with a predicate function that determines whether an allocation should succeed or not.

This resource can be used to construct complex conditional allocation schemes.

Constructor & Destructor Documentation

conditional_memory_resource()

vecmem::conditional_memory_resource::conditional_memory_resource	(	memory_resource &	upstream,
		std::function< bool(std::size_t, std::size_t)>	pred
	)

Constructs the conditional memory resource.

Parameters

[in]	upstream	The upstream memory resource to use.
[in]	pred	The predicate function that determines whether the allocation should succeed.

Member Function Documentation

do_is_equal()

bool vecmem::details::memory_resource_base::do_is_equal ( const memory_resource &  other ) const

protectedvirtualnoexceptinherited

Compare the equality of *this memory resource with another.

Parameters

other

The other memory resource to compare with

Returns

true if the two memory resources are equal, false otherwise

Reimplemented in vecmem::identity_memory_resource, vecmem::host_memory_resource, and vecmem::terminal_memory_resource.

---

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

• core/include/vecmem/memory/conditional_memory_resource.hpp
• core/src/memory/conditional_memory_resource.cpp