Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::MemoryAllocationOptions Class Reference

Options to configure allocations. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/common/arccore/common/MemoryAllocationOptions.h>

Collaboration diagram for Arcane::MemoryAllocationOptions:

Public Member Functions

 MemoryAllocationOptions (IMemoryAllocator *allocator)
 MemoryAllocationOptions (IMemoryAllocator *allocator, eMemoryLocationHint mem_hint)
 MemoryAllocationOptions (IMemoryAllocator *allocator, eMemoryLocationHint mem_hint, Int8 device)
 MemoryAllocationOptions (const MemoryAllocationOptions &rhs)
MemoryAllocationOptions & operator= (const MemoryAllocationOptions &rhs)
IMemoryAllocator * allocator () const
void setAllocator (IMemoryAllocator *v)
eMemoryLocationHint memoryLocationHint () const
void setMemoryLocationHint (eMemoryLocationHint mem_advice)
Int16 device () const
void setDevice (Int16 device)
void setArrayName (const String &name)
String arrayName () const
MemoryAllocationArgs allocationArgs (RunQueue *queue=nullptr) const
 Arguments for 'IMemoryAllocator' associated with these options and the queue.

Private Member Functions

void _addDebugReference ()
void _removeDebugReference ()

Private Attributes

IMemoryAllocator * m_allocator = nullptr
ArrayDebugInfo * m_debug_info = nullptr
Int16 m_device = -1
eMemoryLocationHint m_memory_location_hint = eMemoryLocationHint::None

Friends

class ArrayMetaData
bool operator== (const MemoryAllocationOptions &a, const MemoryAllocationOptions &b)

Detailed Description

Options to configure allocations.

Definition at line 31 of file common/arccore/common/MemoryAllocationOptions.h.

Constructor & Destructor Documentation

◆ MemoryAllocationOptions() [1/4]

Arcane::MemoryAllocationOptions::MemoryAllocationOptions ( IMemoryAllocator * allocator)
inlineexplicit

Definition at line 39 of file common/arccore/common/MemoryAllocationOptions.h.

◆ MemoryAllocationOptions() [2/4]

Arcane::MemoryAllocationOptions::MemoryAllocationOptions ( IMemoryAllocator * allocator,
eMemoryLocationHint mem_hint )
inline

Definition at line 44 of file common/arccore/common/MemoryAllocationOptions.h.

◆ MemoryAllocationOptions() [3/4]

Arcane::MemoryAllocationOptions::MemoryAllocationOptions ( IMemoryAllocator * allocator,
eMemoryLocationHint mem_hint,
Int8 device )
inline

Definition at line 50 of file common/arccore/common/MemoryAllocationOptions.h.

◆ MemoryAllocationOptions() [4/4]

Arcane::MemoryAllocationOptions::MemoryAllocationOptions ( const MemoryAllocationOptions & rhs)
inline

Definition at line 59 of file common/arccore/common/MemoryAllocationOptions.h.

◆ ~MemoryAllocationOptions()

Arcane::MemoryAllocationOptions::~MemoryAllocationOptions ( )
inline

Definition at line 69 of file common/arccore/common/MemoryAllocationOptions.h.

Member Function Documentation

◆ _addDebugReference()

void Arcane::MemoryAllocationOptions::_addDebugReference ( )
private

Definition at line 72 of file MemoryAllocationOptions.cc.

◆ _removeDebugReference()

void Arcane::MemoryAllocationOptions::_removeDebugReference ( )
private

Definition at line 81 of file MemoryAllocationOptions.cc.

◆ allocationArgs()

MemoryAllocationArgs Arcane::MemoryAllocationOptions::allocationArgs ( RunQueue * queue = nullptr) const

Arguments for 'IMemoryAllocator' associated with these options and the queue.

Definition at line 36 of file MemoryAllocationOptions.cc.

◆ allocator()

IMemoryAllocator * Arcane::MemoryAllocationOptions::allocator ( ) const
inline

Definition at line 91 of file common/arccore/common/MemoryAllocationOptions.h.

◆ arrayName()

String Arcane::MemoryAllocationOptions::arrayName ( ) const

Definition at line 63 of file MemoryAllocationOptions.cc.

◆ device()

Int16 Arcane::MemoryAllocationOptions::device ( ) const
inline

Definition at line 97 of file common/arccore/common/MemoryAllocationOptions.h.

◆ memoryLocationHint()

eMemoryLocationHint Arcane::MemoryAllocationOptions::memoryLocationHint ( ) const
inline

Definition at line 94 of file common/arccore/common/MemoryAllocationOptions.h.

◆ operator=()

MemoryAllocationOptions & Arcane::MemoryAllocationOptions::operator= ( const MemoryAllocationOptions & rhs)
inline

Definition at line 74 of file common/arccore/common/MemoryAllocationOptions.h.

◆ setAllocator()

void Arcane::MemoryAllocationOptions::setAllocator ( IMemoryAllocator * v)
inline

Definition at line 92 of file common/arccore/common/MemoryAllocationOptions.h.

◆ setArrayName()

void Arcane::MemoryAllocationOptions::setArrayName ( const String & name)

Definition at line 50 of file MemoryAllocationOptions.cc.

◆ setDevice()

void Arcane::MemoryAllocationOptions::setDevice ( Int16 device)
inline

Definition at line 98 of file common/arccore/common/MemoryAllocationOptions.h.

◆ setMemoryLocationHint()

void Arcane::MemoryAllocationOptions::setMemoryLocationHint ( eMemoryLocationHint mem_advice)
inline

Definition at line 95 of file common/arccore/common/MemoryAllocationOptions.h.

◆ ArrayMetaData

friend class ArrayMetaData
friend

Definition at line 33 of file common/arccore/common/MemoryAllocationOptions.h.

◆ operator==

bool operator== ( const MemoryAllocationOptions & a,
const MemoryAllocationOptions & b )
friend

Definition at line 109 of file common/arccore/common/MemoryAllocationOptions.h.

Member Data Documentation

◆ m_allocator

IMemoryAllocator* Arcane::MemoryAllocationOptions::m_allocator = nullptr
private

Definition at line 122 of file common/arccore/common/MemoryAllocationOptions.h.

◆ m_debug_info

ArrayDebugInfo* Arcane::MemoryAllocationOptions::m_debug_info = nullptr
private

Definition at line 123 of file common/arccore/common/MemoryAllocationOptions.h.

◆ m_device

Int16 Arcane::MemoryAllocationOptions::m_device = -1
private

Definition at line 124 of file common/arccore/common/MemoryAllocationOptions.h.

◆ m_memory_location_hint

eMemoryLocationHint Arcane::MemoryAllocationOptions::m_memory_location_hint = eMemoryLocationHint::None
private

Definition at line 125 of file common/arccore/common/MemoryAllocationOptions.h.

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