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-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file mem.h
26  * @ingroup INTERNALAPI
27  * @brief methods for block memory pools and memory buffers
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_MEM_H__
34 #define __SCIP_MEM_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_retcode.h"
39 #include "scip/type_mem.h"
40 #include "scip/struct_mem.h"
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /** creates block and buffer memory structures */
48  SCIP_MEM** mem /**< pointer to block and buffer memory structure */
49  );
50 
51 /** frees block and buffer memory structures */
53  SCIP_MEM** mem /**< pointer to block and buffer memory structure */
54  );
55 
56 /** returns the total number of bytes used in block and buffer memory */
58  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
59  );
60 
61 /** returns the total number of bytes in block and buffer memory */
63  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
64  );
65 
66 /** returns the maximal number of used bytes in block memory */
68  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
69  );
70 
71 /** returns the maximal number of allocated but not used bytes in block memory */
73  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
74  );
75 
76 /** returns the maximal number of allocated bytes in block memory */
78  SCIP_MEM* mem /**< pointer to block and buffer memory structure */
79  );
80 
81 #ifdef __cplusplus
82 }
83 #endif
84 
85 #endif
SCIP_RETCODE SCIPmemFree(SCIP_MEM **mem)
Definition: mem.c:69
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
SCIP_Longint SCIPmemGetTotal(SCIP_MEM *mem)
Definition: mem.c:108
SCIP_Longint SCIPmemGetUsedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:119
datastructures for block memory pools and memory buffers
type definitions for block memory pools and memory buffers
#define SCIP_Longint
Definition: def.h:171
SCIP_Longint SCIPmemGetAllocatedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:139
common defines and data types used in all packages of SCIP
SCIP_Longint SCIPmemGetUsed(SCIP_MEM *mem)
Definition: mem.c:97
SCIP_Longint SCIPmemGetUnusedBlockmemoryMax(SCIP_MEM *mem)
Definition: mem.c:129
SCIP_RETCODE SCIPmemCreate(SCIP_MEM **mem)
Definition: mem.c:43