NCollection_AlignedAllocator Class Reference

NCollection allocator with managed memory alignment capabilities. More...

#include <NCollection_AlignedAllocator.hxx>

Inheritance diagram for NCollection_AlignedAllocator:

Public Member Functions
	NCollection_AlignedAllocator (const size_t theAlignment)
	Constructor. The alignment should be specified explicitly: 16 bytes for SSE instructions 32 bytes for AVX instructions.
virtual void *	Allocate (const size_t theSize) override
	Allocate memory with given size. Returns NULL on failure.
void *	AllocateOptimal (const size_t theSize) override
	Allocate memory with given size. Returns NULL on failure.
virtual void	Free (void *thePtr) override
	Free a previously allocated memory.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
size_t	myAlignment
	alignment in bytes

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from NCollection_BaseAllocator
static const Handle< NCollection_BaseAllocator > &	CommonBaseAllocator (void)
	CommonBaseAllocator This method is designed to have the only one BaseAllocator (to avoid useless copying of collections). However one can use operator new to create more BaseAllocators, but it is injurious.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Member Functions inherited from NCollection_BaseAllocator
	NCollection_BaseAllocator ()
	Constructor - prohibited.

Detailed Description

NCollection allocator with managed memory alignment capabilities.

Constructor & Destructor Documentation

NCollection_AlignedAllocator()

NCollection_AlignedAllocator::NCollection_AlignedAllocator

(

const size_t

theAlignment

)

Constructor. The alignment should be specified explicitly: 16 bytes for SSE instructions 32 bytes for AVX instructions.

Member Function Documentation

Allocate()

virtual void * NCollection_AlignedAllocator::Allocate ( const size_t  theSize )

overridevirtual

Allocate memory with given size. Returns NULL on failure.

Reimplemented from NCollection_BaseAllocator.

AllocateOptimal()

void * NCollection_AlignedAllocator::AllocateOptimal ( const size_t  theSize )

inlineoverridevirtual

Allocate memory with given size. Returns NULL on failure.

Reimplemented from NCollection_BaseAllocator.

Free()

virtual void NCollection_AlignedAllocator::Free ( void *  thePtr )

overridevirtual

Free a previously allocated memory.

Reimplemented from NCollection_BaseAllocator.

Field Documentation

myAlignment

size_t NCollection_AlignedAllocator::myAlignment

protected

alignment in bytes

---

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

• NCollection_AlignedAllocator.hxx