Scippy

SCIP

Solving Constraint Integer Programs

mem.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2022 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file mem.h
17  * @ingroup INTERNALAPI
18  * @brief methods for block memory pools and memory buffers
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_MEM_H__
25 #define __SCIP_MEM_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_retcode.h"
30 #include "scip/type_mem.h"
31 #include "scip/struct_mem.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /** creates block and buffer memory structures */
39  SCIP_MEM** mem /**< pointer to block and buffer memory structure */
40  );
41 
42 /** frees block and buffer memory structures */
44  SCIP_MEM** mem /**< pointer to block and buffer memory structure */
45  );
46 
47 /** returns the total number of bytes used in block and buffer memory */
49  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
50  );
51 
52 /** returns the total number of bytes in block and buffer memory */
54  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
55  );
56 
57 /** returns the maximal number of used bytes in block memory */
59  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
60  );
61 
62 /** returns the maximal number of allocated but not used bytes in block memory */
64  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
65  );
66 
67 /** returns the maximal number of allocated bytes in block memory */
69  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
70  );
71 
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif
SCIP_RETCODE SCIPmemFree(SCIP_MEM **mem)
Definition: mem.c:60
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
SCIP_Longint SCIPmemGetTotal(SCIP_MEM *mem)
Definition: mem.c:99
SCIP_Longint SCIPmemGetUsedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:110
datastructures for block memory pools and memory buffers
type definitions for block memory pools and memory buffers
#define SCIP_Longint
Definition: def.h:162
SCIP_Longint SCIPmemGetAllocatedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:130
common defines and data types used in all packages of SCIP
SCIP_Longint SCIPmemGetUsed(SCIP_MEM *mem)
Definition: mem.c:88
SCIP_Longint SCIPmemGetUnusedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:120
SCIP_RETCODE SCIPmemCreate(SCIP_MEM **mem)
Definition: mem.c:34