max_fixed_size Class

Describes a max class object that limits a freelist object to a fixed maximum length.

Syntax

template <std::size_t Max>
class max_fixed_size

Parameters

Max
The max class that determines the maximum number of elements to store in the freelist.

Constructors

Member functions

Requirements

Header: <allocators>

Namespace: stdext

max_fixed_size::allocated

Increments the count of allocated memory blocks.

void allocated(std::size_t _Nx = 1);

Parameters

_Nx
The increment value.

Remarks

The member function does nothing. This member function is called after each successful call by cache_freelist::allocate to operator new. The argument _Nx is the number of memory blocks in the chunk allocated by operator new.

max_fixed_size::deallocated

Decrements the count of allocated memory blocks.

void deallocated(std::size_t _Nx = 1);

Parameters

_Nx
The increment value.

Remarks

The member function does nothing. This member function is called after each call by cache_freelist::deallocate to operator delete. The argument _Nx is the number of memory blocks in the chunk deallocated by operator delete.

max_fixed_size::full

Returns a value that specifies whether more memory blocks should be added to the free list.

bool full();

Return Value

true if Max <= _Nblocks; otherwise, false.

Remarks

This member function is called by cache_freelist::deallocate. If the call returns true, deallocate puts the memory block on the free list; if it returns false, deallocate calls operator delete to deallocate the block.

max_fixed_size::max_fixed_size

Constructs an object of type max_fixed_size.

max_fixed_size();

Remarks

This constructor initializes the stored value _Nblocks to zero.

max_fixed_size::released

Decrements the count of memory blocks on the free list.

void released();

Remarks

Decrements the stored value _Nblocks. The released member function of the current max class is called by cache_freelist::allocate whenever it removes a memory block from the free list.

max_fixed_size::saved

Increments the count of memory blocks on the free list.

void saved();

Remarks

This member function increments the stored value _Nblocks. This member function is called by cache_freelist::deallocate whenever it puts a memory block on the free list.

See also

<allocators>