TPIE

2362a60
tpie::linear_memory_structure_doc Struct Reference

Description of the methods that must be implemented to support the linear_memory_structure_concept. More...

#include <tpie/concept_doc.h>

Static Public Member Functions

static double memory_coefficient ()
 Return the memory coefficient of the structure. More...
 
static double memory_overhead ()
 Return the memory overhead of the structure. More...
 

Detailed Description

Description of the methods that must be implemented to support the linear_memory_structure_concept.

Definition at line 30 of file concept_doc.h.

Member Function Documentation

static double tpie::linear_memory_structure_doc::memory_coefficient ( )
static

Return the memory coefficient of the structure.

Allocating a structure with n elements will use at most $ \lfloor \mathrm{memory\_coefficient} \cdot n + \mathrm{memory\_overhead} \rfloor $ bytes. This does not include memory overhead incurred if the structure is allocated using new.

Returns
The memory coefficient of the structure.
static double tpie::linear_memory_structure_doc::memory_overhead ( )
static

Return the memory overhead of the structure.

See also
memory_coefficient()
Returns
The memory overhead.

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