A runtime-managed buffer mirrored between host and device memory. More...

#include <buffer.h>

Inherits Allocator.

Public Types
using	element_type = std::decay_t< T >

using	allocator_traits = std::allocator_traits< Allocator >

using	allocator_type = typename allocator_traits::allocator_type

Public Member Functions
	Buffer ()

	Buffer (std::size_t n, ttg::scope scope=ttg::scope::SyncIn)

template<typename Deleter >
	Buffer (std::unique_ptr< element_type[], Deleter > ptr, std::size_t n, ttg::scope scope=ttg::scope::SyncIn)

	Buffer (std::shared_ptr< element_type[]> ptr, std::size_t n, ttg::scope scope=ttg::scope::SyncIn)

virtual	~Buffer ()

	Buffer (Buffer &&db)

	Buffer (const Buffer &db)=delete

Buffer &	operator= (Buffer &&db)

Buffer &	operator= (const Buffer &db)=delete

void	set_current_device (const ttg::device::Device &device)

bool	is_current_on (ttg::device::Device dev) const

ttg::device::Device	get_owner_device () const

element_type *	current_device_ptr ()

const element_type *	current_device_ptr () const

element_type *	owner_device_ptr ()

const element_type *	owner_device_ptr () const

element_type *	device_ptr_on (const ttg::device::Device &device)

const element_type *	device_ptr_on (const ttg::device::Device &device) const

element_type *	host_ptr ()

const element_type *	host_ptr () const

bool	is_valid_on (const ttg::device::Device &device) const

void	allocate_on (const ttg::device::Device &device_id)

bool	empty () const

void	pin ()

void	unpin ()

void	pin_on (int device_id)

void	unpin_on (int device_id)

bool	is_valid () const

	operator bool () const

std::size_t	size () const

void	reset (std::size_t n, ttg::scope scope=ttg::scope::SyncIn)

void	reset (std::shared_ptr< element_type[]> ptr, std::size_t n, ttg::scope scope=ttg::scope::SyncIn)

void	reset_scope (ttg::scope scope)

Detailed Description

template<typename T, typename Allocator>
struct ttg_madness::Buffer< T, Allocator >

A runtime-managed buffer mirrored between host and device memory.

Definition at line 13 of file buffer.h.

Member Typedef Documentation

◆ allocator_traits

template<typename T , typename Allocator >

using ttg_madness::Buffer< T, Allocator >::allocator_traits = std::allocator_traits<Allocator>

Definition at line 17 of file buffer.h.

◆ allocator_type

template<typename T , typename Allocator >

using ttg_madness::Buffer< T, Allocator >::allocator_type = typename allocator_traits::allocator_type

Definition at line 18 of file buffer.h.

◆ element_type

template<typename T , typename Allocator >

using ttg_madness::Buffer< T, Allocator >::element_type = std::decay_t<T>

Definition at line 15 of file buffer.h.

Constructor & Destructor Documentation

◆ Buffer() [1/6]

template<typename T , typename Allocator >

ttg_madness::Buffer< T, Allocator >::Buffer ( )

inline

Definition at line 49 of file buffer.h.

◆ Buffer() [2/6]

template<typename T , typename Allocator >

ttg_madness::Buffer< T, Allocator >::Buffer	(	std::size_t	n,
		ttg::scope	scope = `ttg::scope::SyncIn`
	)

inline

Definition at line 52 of file buffer.h.

◆ Buffer() [3/6]

template<typename T , typename Allocator >

template<typename Deleter >

ttg_madness::Buffer< T, Allocator >::Buffer	(	std::unique_ptr< element_type[], Deleter >	ptr,
		std::size_t	n,
		ttg::scope	scope = `ttg::scope::SyncIn`
	)

inline

Definition at line 63 of file buffer.h.

◆ Buffer() [4/6]

template<typename T , typename Allocator >

ttg_madness::Buffer< T, Allocator >::Buffer	(	std::shared_ptr< element_type[]>	ptr,
		std::size_t	n,
		ttg::scope	scope = `ttg::scope::SyncIn`
	)

inline

Definition at line 74 of file buffer.h.

◆ ~Buffer()

template<typename T , typename Allocator >

virtual ttg_madness::Buffer< T, Allocator >::~Buffer ( )

inlinevirtual

Definition at line 82 of file buffer.h.

Here is the call graph for this function:

◆ Buffer() [5/6]

template<typename T , typename Allocator >

ttg_madness::Buffer< T, Allocator >::Buffer ( Buffer< T, Allocator > && db )

inline

Definition at line 91 of file buffer.h.

◆ Buffer() [6/6]

template<typename T , typename Allocator >

ttg_madness::Buffer< T, Allocator >::Buffer ( const Buffer< T, Allocator > & db )

delete

Member Function Documentation

◆ allocate_on()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::allocate_on ( const ttg::device::Device & device_id )

inline

Definition at line 198 of file buffer.h.

◆ current_device_ptr() [1/2]

template<typename T , typename Allocator >

element_type * ttg_madness::Buffer< T, Allocator >::current_device_ptr ( )

inline

Definition at line 143 of file buffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ current_device_ptr() [2/2]

template<typename T , typename Allocator >

const element_type * ttg_madness::Buffer< T, Allocator >::current_device_ptr ( ) const

inline

Definition at line 149 of file buffer.h.

Here is the call graph for this function:

◆ device_ptr_on() [1/2]

template<typename T , typename Allocator >

element_type * ttg_madness::Buffer< T, Allocator >::device_ptr_on ( const ttg::device::Device & device )

inline

Definition at line 170 of file buffer.h.

Here is the call graph for this function:

◆ device_ptr_on() [2/2]

template<typename T , typename Allocator >

const element_type * ttg_madness::Buffer< T, Allocator >::device_ptr_on ( const ttg::device::Device & device ) const

inline

Definition at line 178 of file buffer.h.

Here is the call graph for this function:

◆ empty()

template<typename T , typename Allocator >

bool ttg_madness::Buffer< T, Allocator >::empty ( ) const

inline

Definition at line 203 of file buffer.h.

◆ get_owner_device()

template<typename T , typename Allocator >

ttg::device::Device ttg_madness::Buffer< T, Allocator >::get_owner_device ( ) const

inline

Definition at line 137 of file buffer.h.

Here is the call graph for this function:

◆ host_ptr() [1/2]

template<typename T , typename Allocator >

element_type * ttg_madness::Buffer< T, Allocator >::host_ptr ( )

inline

Definition at line 184 of file buffer.h.

◆ host_ptr() [2/2]

template<typename T , typename Allocator >

const element_type * ttg_madness::Buffer< T, Allocator >::host_ptr ( ) const

inline

Definition at line 188 of file buffer.h.

◆ is_current_on()

template<typename T , typename Allocator >

bool ttg_madness::Buffer< T, Allocator >::is_current_on ( ttg::device::Device dev ) const

inline

Definition at line 130 of file buffer.h.

Here is the call graph for this function:

◆ is_valid()

template<typename T , typename Allocator >

bool ttg_madness::Buffer< T, Allocator >::is_valid ( ) const

inline

Definition at line 231 of file buffer.h.

Here is the caller graph for this function:

◆ is_valid_on()

template<typename T , typename Allocator >

bool ttg_madness::Buffer< T, Allocator >::is_valid_on ( const ttg::device::Device & device ) const

inline

Definition at line 192 of file buffer.h.

Here is the call graph for this function:

◆ operator bool()

template<typename T , typename Allocator >

ttg_madness::Buffer< T, Allocator >::operator bool ( ) const

inline

Definition at line 235 of file buffer.h.

◆ operator=() [1/2]

template<typename T , typename Allocator >

Buffer & ttg_madness::Buffer< T, Allocator >::operator= ( Buffer< T, Allocator > && db )

inline

Definition at line 108 of file buffer.h.

◆ operator=() [2/2]

template<typename T , typename Allocator >

Buffer & ttg_madness::Buffer< T, Allocator >::operator= ( const Buffer< T, Allocator > & db )

delete

◆ owner_device_ptr() [1/2]

template<typename T , typename Allocator >

element_type * ttg_madness::Buffer< T, Allocator >::owner_device_ptr ( )

inline

Definition at line 157 of file buffer.h.

Here is the call graph for this function:

◆ owner_device_ptr() [2/2]

template<typename T , typename Allocator >

const element_type * ttg_madness::Buffer< T, Allocator >::owner_device_ptr ( ) const

inline

Definition at line 163 of file buffer.h.

Here is the call graph for this function:

◆ pin()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::pin ( )

inline

Definition at line 212 of file buffer.h.

◆ pin_on()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::pin_on ( int device_id )

inline

Definition at line 222 of file buffer.h.

◆ reset() [1/2]

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::reset	(	std::shared_ptr< element_type[]>	ptr,
		std::size_t	n,
		ttg::scope	scope = `ttg::scope::SyncIn`
	)

inline

Definition at line 262 of file buffer.h.

◆ reset() [2/2]

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::reset	(	std::size_t	n,
		ttg::scope	scope = `ttg::scope::SyncIn`
	)

inline

Definition at line 244 of file buffer.h.

◆ reset_scope()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::reset_scope ( ttg::scope scope )

inline

Resets the scope of the buffer. Ignored in MADNESS.

Definition at line 277 of file buffer.h.

◆ set_current_device()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::set_current_device ( const ttg::device::Device & device )

inline

Definition at line 123 of file buffer.h.

Here is the call graph for this function:

◆ size()

template<typename T , typename Allocator >

std::size_t ttg_madness::Buffer< T, Allocator >::size ( ) const

inline

Definition at line 239 of file buffer.h.

◆ unpin()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::unpin ( )

inline

Definition at line 217 of file buffer.h.

Here is the caller graph for this function:

◆ unpin_on()

template<typename T , typename Allocator >

void ttg_madness::Buffer< T, Allocator >::unpin_on ( int device_id )

inline

Definition at line 227 of file buffer.h.

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

ttg/ttg/madness/buffer.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ allocator_traits

◆ allocator_type

◆ element_type

Constructor & Destructor Documentation

◆ Buffer() [1/6]

◆ Buffer() [2/6]

◆ Buffer() [3/6]

◆ Buffer() [4/6]

◆ ~Buffer()

◆ Buffer() [5/6]

◆ Buffer() [6/6]

Member Function Documentation

◆ allocate_on()

◆ current_device_ptr() [1/2]

◆ current_device_ptr() [2/2]

◆ device_ptr_on() [1/2]

◆ device_ptr_on() [2/2]

◆ empty()

◆ get_owner_device()

◆ host_ptr() [1/2]

◆ host_ptr() [2/2]

◆ is_current_on()

◆ is_valid()

◆ is_valid_on()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ owner_device_ptr() [1/2]

◆ owner_device_ptr() [2/2]

◆ pin()

◆ pin_on()

◆ reset() [1/2]

◆ reset() [2/2]

◆ reset_scope()

◆ set_current_device()

◆ size()

◆ unpin()

◆ unpin_on()