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-2017 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 email to scip@zib.de. */
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 */
38 extern
40  SCIP_MEM** mem /**< pointer to block and buffer memory structure */
41  );
42 
43 /** frees block and buffer memory structures */
44 extern
46  SCIP_MEM** mem /**< pointer to block and buffer memory structure */
47  );
48 
49 /** returns the total number of bytes used in block and buffer memory */
50 extern
52  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
53  );
54 
55 /** returns the total number of bytes in block and buffer memory */
56 extern
58  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
59  );
60 
61 /** returns the maximal number of used bytes in block memory */
62 extern
64  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
65  );
66 
67 /** returns the maximal number of allocated but not used bytes in block memory */
68 extern
70  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
71  );
72 
73 /** returns the maximal number of allocated bytes in block memory */
74 extern
76  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
77  );
78 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif
SCIP_RETCODE SCIPmemFree(SCIP_MEM **mem)
Definition: mem.c:59
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
type definitions for return codes for SCIP methods
SCIP_Longint SCIPmemGetTotal(SCIP_MEM *mem)
Definition: mem.c:96
SCIP_Longint SCIPmemGetUsedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:107
datastructures for block memory pools and memory buffers
type definitions for block memory pools and memory buffers
#define SCIP_Longint
Definition: def.h:130
SCIP_Longint SCIPmemGetAllocatedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:127
common defines and data types used in all packages of SCIP
SCIP_Longint SCIPmemGetUsed(SCIP_MEM *mem)
Definition: mem.c:85
SCIP_Longint SCIPmemGetUnusedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:117
SCIP_RETCODE SCIPmemCreate(SCIP_MEM **mem)
Definition: mem.c:33