[#BloombergLP-ball-CountingAllocator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::CountingAllocator
:relfileprefix: ../../
:mrdocs:

This class maintains a count of the total number of allocated bytes&period;

== Synopsis

Declared in `&lt;ball&lowbar;countingallocator&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class CountingAllocator
    : public xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]
----

== Description

The running byte count is initialized to 0 upon construction, is increased by the `allocate` method, and may be reset to 0 by the `resetNumBytesTotal` method&period; The `deallocate` method appropriately decrement the byte count&period; The precise definition of byte count is described in the &quot;Byte Count&quot; section of the component&hyphen;level documentation&period;

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]`
| Pure abstract protocol for clients and suppliers of raw memory&period;
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/size_type.adoc[`size&lowbar;type`] 
| Alias for an unsigned integral type capable of representing the number of bytes in this platform&apos;s virtual address space&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/CountingAllocator/2constructor.adoc[`CountingAllocator`]         [.small]#[constructor]#
| Create a counting allocator having an initial byte count of 0&period;
| xref:BloombergLP/ball/CountingAllocator/2destructor.adoc[`&#126;CountingAllocator`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this counting allocator&period;
| xref:BloombergLP/bslma/Allocator/operator_assign.adoc[`operator&equals;`] 
| 
| xref:BloombergLP/ball/CountingAllocator/allocate-0f.adoc[`allocate`] 
| Allocate a maximally aligned block of the specified `size`&period;
| xref:BloombergLP/ball/CountingAllocator/deallocate-02.adoc[`deallocate`] 
| Return the memory at the specified `address` to this allocator&period;
| xref:BloombergLP/bslma/Allocator/deleteObject-09.adoc[`deleteObject`] 
| `deleteObject` overloads
| xref:BloombergLP/bslma/Allocator/deleteObjectRaw-06f.adoc[`deleteObjectRaw`] 
| `deleteObjectRaw` overloads
| xref:BloombergLP/bslma/Allocator/is_equal.adoc[`is&lowbar;equal`] 
| 
| xref:BloombergLP/ball/CountingAllocator/numBytesTotal.adoc[`numBytesTotal`] 
| Return the byte count maintained by this counting allocator&period;
| xref:BloombergLP/ball/CountingAllocator/resetNumBytesTotal.adoc[`resetNumBytesTotal`] 
| Reset the byte count maintained by this counting allocator to 0&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/throwBadAlloc.adoc[`throwBadAlloc`] 
| Throw `std&colon;&colon;bad&lowbar;alloc` or abort the program&period;
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/do_allocate.adoc[`do&lowbar;allocate`]  [.small]#[virtual]#
| Return a newly allocated block of at least `bytes` with `alignment`&period;
| xref:BloombergLP/bslma/Allocator/do_deallocate.adoc[`do&lowbar;deallocate`]  [.small]#[virtual]#
| Return the memory block at `p` having `bytes` and `alignment`&period;
| xref:BloombergLP/bslma/Allocator/do_is_equal.adoc[`do&lowbar;is&lowbar;equal`]  [.small]#[virtual]#
| Return whether this allocator can exchange memory with `other`&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
