Queue

Detailed Description

Functions
SCIP_RETCODE	SCIPqueueCreate (SCIP_QUEUE **queue, int initsize, SCIP_Real sizefac)
void	SCIPqueueFree (SCIP_QUEUE **queue)
void	SCIPqueueClear (SCIP_QUEUE *queue)
SCIP_RETCODE	SCIPqueueInsert (SCIP_QUEUE *queue, void *elem)
void *	SCIPqueueRemove (SCIP_QUEUE *queue)
void *	SCIPqueueFirst (SCIP_QUEUE *queue)
SCIP_Bool	SCIPqueueIsEmpty (SCIP_QUEUE *queue)
int	SCIPqueueNElems (SCIP_QUEUE *queue)

Function Documentation

SCIP_RETCODE SCIPqueueCreate	(	SCIP_QUEUE **	queue,
		int	initsize,
		SCIP_Real	sizefac
	)

creates a (circular) queue, best used if the size will be fixed or will not be increased that much

Parameters

queue	pointer to the new queue
initsize	initial number of available element slots
sizefac	memory growing factor applied, if more element slots are needed

Definition at line 742 of file misc.c.

References BMSallocMemory, MAX, NULL, queueResize(), SCIP_ALLOC, SCIP_CALL, and SCIP_OKAY.

Referenced by createReopttree(), and SCIPconshdlrCreate().

void SCIPqueueFree

(

SCIP_QUEUE **

queue

)

frees queue, but not the data elements themselves

Parameters

queue

pointer to a queue

Definition at line 766 of file misc.c.

References BMSfreeMemory, BMSfreeMemoryArray, and NULL.

Referenced by freeReoptTree(), and SCIPconshdlrFree().

void SCIPqueueClear

(

SCIP_QUEUE *

queue

)

clears the queue, but doesn't free the data elements themselves

Parameters

queue

queue

Definition at line 777 of file misc.c.

References SCIP_Queue::firstfree, SCIP_Queue::firstused, and NULL.

Referenced by clearReoptnodes().

SCIP_RETCODE SCIPqueueInsert	(	SCIP_QUEUE *	queue,
		void *	elem
	)

inserts element at the end of the queue

Parameters

queue	queue
elem	element to be inserted

Definition at line 788 of file misc.c.

References BMSmoveMemoryArray, SCIP_Queue::firstfree, SCIP_Queue::firstused, NULL, queueResize(), SCIP_CALL, SCIP_OKAY, SCIP_Queue::size, BMS_BufMem::size, and SCIP_Queue::slots.

Referenced by clearReoptnodes(), createReopttree(), deleteChildrenBelow(), reopttreeCheckMemory(), SCIPconsPushProp(), and shrinkNode().

void* SCIPqueueRemove

(

SCIP_QUEUE *

queue

)

removes and returns the first element of the queue

Parameters

queue

queue

Definition at line 832 of file misc.c.

References SCIP_Queue::firstfree, SCIP_Queue::firstused, NULL, SCIP_Queue::size, and SCIP_Queue::slots.

Referenced by addNode(), SCIPconshdlrPopProp(), SCIPreoptApplyCompression(), and SCIPreoptSplitRoot().

void* SCIPqueueFirst

(

SCIP_QUEUE *

queue

)

returns the first element of the queue without removing it

Parameters

queue

queue

Definition at line 866 of file misc.c.

References SCIP_Queue::firstfree, SCIP_Queue::firstused, NULL, SCIP_Queue::size, and SCIP_Queue::slots.

Referenced by SCIPconshdlrFrontProp().

SCIP_Bool SCIPqueueIsEmpty

(

SCIP_QUEUE *

queue

)

returns whether the queue is empty

Parameters

queue

queue

Definition at line 884 of file misc.c.

References SCIP_Queue::firstfree, SCIP_Queue::firstused, NULL, and SCIP_Queue::size.

Referenced by reopttreeCheckMemory(), SCIPconshdlrExit(), SCIPconshdlrExitpre(), SCIPconshdlrFrontProp(), and SCIPconshdlrPopProp().

int SCIPqueueNElems

(

SCIP_QUEUE *

queue

)

returns the number of elements in the queue

Parameters

queue

queue

Definition at line 897 of file misc.c.

References SCIP_Queue::firstfree, SCIP_Queue::firstused, NULL, and SCIP_Queue::size.

Referenced by clearReoptnodes(), and createReopttree().