Detailed Description

internal methods for memory buffers for temporary objects

Author: Tobias Achterberg

Definition in file buffer.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_set.h"
#include "scip/type_buffer.h"

Functions
SCIP_RETCODE	SCIPbufferCreate (SCIP_BUFFER **buffer)

void	SCIPbufferFree (SCIP_BUFFER **buffer)

SCIP_RETCODE	SCIPbufferAllocMem (SCIP_BUFFER buffer, SCIP_SET set, void **ptr, int size)

SCIP_RETCODE	SCIPbufferDuplicateMem (SCIP_BUFFER buffer, SCIP_SET set, void *ptr, const void source, int size)

SCIP_RETCODE	SCIPbufferReallocMem (SCIP_BUFFER buffer, SCIP_SET set, void **ptr, int size)

SCIP_RETCODE	SCIPbufferAllocMemSave (SCIP_SET set, void *ptr, int num, size_t elemsize)

SCIP_RETCODE	SCIPbufferDuplicateMemSave (SCIP_SET set, void ptr, const void source, int num, size_t elemsize)

SCIP_RETCODE	SCIPbufferReallocMemSave (SCIP_SET set, void *ptr, int num, size_t elemsize)

void	SCIPbufferFreeMem (SCIP_BUFFER buffer, void *ptr, int dummysize)

int	SCIPbufferGetNUsed (SCIP_BUFFER *buffer)

void	SCIPbufferPrint (SCIP_BUFFER *buffer)

Function Documentation

SCIP_RETCODE SCIPbufferCreate ( SCIP_BUFFER ** buffer )

creates memory buffer storage

Parameters

buffer pointer to memory buffer storage

Definition at line 36 of file buffer.c.

References BMSallocMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by SCIPsetCreate().

void SCIPbufferFree ( SCIP_BUFFER ** buffer )

frees memory buffer storage

frees memory buffer

Parameters

buffer pointer to memory buffer storage

Definition at line 53 of file buffer.c.

References BMSfreeMemory, BMSfreeMemoryArrayNull, and NULL.

Referenced by SCIPsetFree().

SCIP_RETCODE SCIPbufferAllocMem	(	SCIP_BUFFER *	buffer,
		SCIP_SET *	set,
		void **	ptr,
		int	size
	)

allocates the next unused buffer

Parameters

buffer	memory buffer storage
set	global SCIP settings
ptr	pointer to store the allocated memory buffer
size	minimal required size of the buffer

Definition at line 73 of file buffer.c.

References BMSallocMemorySize, BMSreallocMemoryArray, BMSreallocMemorySize, SCIP_Buffer::data, FALSE, SCIP_Buffer::firstfree, SCIP_Buffer::ndata, NULL, SCIP_ALLOC, SCIP_OKAY, SCIPdebugMessage, SCIPsetCalcMemGrowSize(), SCIP_Buffer::size, TRUE, and SCIP_Buffer::used.

Referenced by SCIPbufferAllocMemSave(), SCIPbufferDuplicateMem(), and SCIPbufferReallocMem().

SCIP_RETCODE SCIPbufferDuplicateMem	(	SCIP_BUFFER *	buffer,
		SCIP_SET *	set,
		void **	ptr,
		const void *	source,
		int	size
	)

allocates the next unused buffer and copies the given memory into the buffer

Parameters

buffer	memory buffer storage
set	global SCIP settings
ptr	pointer to store the allocated memory buffer
source	memory block to copy into the buffer
size	minimal required size of the buffer

Definition at line 142 of file buffer.c.

References BMScopyMemorySize, NULL, SCIP_CALL, SCIP_OKAY, and SCIPbufferAllocMem().

Referenced by SCIPbufferDuplicateMemSave().

SCIP_RETCODE SCIPbufferReallocMem	(	SCIP_BUFFER *	buffer,
		SCIP_SET *	set,
		void **	ptr,
		int	size
	)

reallocates the buffer to at least the given size

Parameters

buffer	memory buffer storage
set	global SCIP settings
ptr	pointer to the allocated memory buffer
size	minimal required size of the buffer

Definition at line 162 of file buffer.c.

References BMSreallocMemorySize, SCIP_Buffer::data, SCIP_Buffer::firstfree, SCIP_Buffer::ndata, NULL, SCIP_ALLOC, SCIP_OKAY, SCIPbufferAllocMem(), SCIPdebugMessage, SCIPsetCalcMemGrowSize(), SCIP_Buffer::size, and SCIP_Buffer::used.

Referenced by SCIPbufferReallocMemSave().

SCIP_RETCODE SCIPbufferAllocMemSave	(	SCIP_SET *	set,
		void **	ptr,
		int	num,
		size_t	elemsize
	)

allocates the next unused buffer; checks for integer overflow

Parameters

set	global SCIP settings
ptr	pointer to store the allocated memory buffer
num	number of entries to allocate
elemsize	size of one element in the array

Definition at line 221 of file buffer.c.

References NULL, SCIP_CALL, SCIP_NOMEMORY, SCIP_OKAY, and SCIPbufferAllocMem().

SCIP_RETCODE SCIPbufferDuplicateMemSave	(	SCIP_SET *	set,
		void **	ptr,
		const void *	source,
		int	num,
		size_t	elemsize
	)

allocates the next unused buffer and copies the given memory into the buffer; checks for integer overflows

Parameters

set	global SCIP settings
ptr	pointer to store the allocated memory buffer
source	memory block to copy into the buffer
num	number of entries to copy
elemsize	size of one element in the array