Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods for the creation and access of dynamic arrays

Functions

SCIP_RETCODE SCIPcreateRealarray (SCIP *scip, SCIP_REALARRAY **realarray)
 
SCIP_RETCODE SCIPfreeRealarray (SCIP *scip, SCIP_REALARRAY **realarray)
 
SCIP_RETCODE SCIPextendRealarray (SCIP *scip, SCIP_REALARRAY *realarray, int minidx, int maxidx)
 
SCIP_RETCODE SCIPclearRealarray (SCIP *scip, SCIP_REALARRAY *realarray)
 
SCIP_Real SCIPgetRealarrayVal (SCIP *scip, SCIP_REALARRAY *realarray, int idx)
 
SCIP_RETCODE SCIPsetRealarrayVal (SCIP *scip, SCIP_REALARRAY *realarray, int idx, SCIP_Real val)
 
SCIP_RETCODE SCIPincRealarrayVal (SCIP *scip, SCIP_REALARRAY *realarray, int idx, SCIP_Real incval)
 
int SCIPgetRealarrayMinIdx (SCIP *scip, SCIP_REALARRAY *realarray)
 
int SCIPgetRealarrayMaxIdx (SCIP *scip, SCIP_REALARRAY *realarray)
 
SCIP_RETCODE SCIPcreateIntarray (SCIP *scip, SCIP_INTARRAY **intarray)
 
SCIP_RETCODE SCIPfreeIntarray (SCIP *scip, SCIP_INTARRAY **intarray)
 
SCIP_RETCODE SCIPextendIntarray (SCIP *scip, SCIP_INTARRAY *intarray, int minidx, int maxidx)
 
SCIP_RETCODE SCIPclearIntarray (SCIP *scip, SCIP_INTARRAY *intarray)
 
int SCIPgetIntarrayVal (SCIP *scip, SCIP_INTARRAY *intarray, int idx)
 
SCIP_RETCODE SCIPsetIntarrayVal (SCIP *scip, SCIP_INTARRAY *intarray, int idx, int val)
 
SCIP_RETCODE SCIPincIntarrayVal (SCIP *scip, SCIP_INTARRAY *intarray, int idx, int incval)
 
int SCIPgetIntarrayMinIdx (SCIP *scip, SCIP_INTARRAY *intarray)
 
int SCIPgetIntarrayMaxIdx (SCIP *scip, SCIP_INTARRAY *intarray)
 
SCIP_RETCODE SCIPcreateBoolarray (SCIP *scip, SCIP_BOOLARRAY **boolarray)
 
SCIP_RETCODE SCIPfreeBoolarray (SCIP *scip, SCIP_BOOLARRAY **boolarray)
 
SCIP_RETCODE SCIPextendBoolarray (SCIP *scip, SCIP_BOOLARRAY *boolarray, int minidx, int maxidx)
 
SCIP_RETCODE SCIPclearBoolarray (SCIP *scip, SCIP_BOOLARRAY *boolarray)
 
SCIP_Bool SCIPgetBoolarrayVal (SCIP *scip, SCIP_BOOLARRAY *boolarray, int idx)
 
SCIP_RETCODE SCIPsetBoolarrayVal (SCIP *scip, SCIP_BOOLARRAY *boolarray, int idx, SCIP_Bool val)
 
int SCIPgetBoolarrayMinIdx (SCIP *scip, SCIP_BOOLARRAY *boolarray)
 
int SCIPgetBoolarrayMaxIdx (SCIP *scip, SCIP_BOOLARRAY *boolarray)
 
SCIP_RETCODE SCIPcreatePtrarray (SCIP *scip, SCIP_PTRARRAY **ptrarray)
 
SCIP_RETCODE SCIPfreePtrarray (SCIP *scip, SCIP_PTRARRAY **ptrarray)
 
SCIP_RETCODE SCIPextendPtrarray (SCIP *scip, SCIP_PTRARRAY *ptrarray, int minidx, int maxidx)
 
SCIP_RETCODE SCIPclearPtrarray (SCIP *scip, SCIP_PTRARRAY *ptrarray)
 
void * SCIPgetPtrarrayVal (SCIP *scip, SCIP_PTRARRAY *ptrarray, int idx)
 
SCIP_RETCODE SCIPsetPtrarrayVal (SCIP *scip, SCIP_PTRARRAY *ptrarray, int idx, void *val)
 
int SCIPgetPtrarrayMinIdx (SCIP *scip, SCIP_PTRARRAY *ptrarray)
 
int SCIPgetPtrarrayMaxIdx (SCIP *scip, SCIP_PTRARRAY *ptrarray)
 

Function Documentation

◆ SCIPcreateRealarray()

SCIP_RETCODE SCIPcreateRealarray ( SCIP scip,
SCIP_REALARRAY **  realarray 
)

creates a dynamic array of real values

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
realarraypointer to store the real array

Definition at line 130 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPrealarrayCreate().

◆ SCIPfreeRealarray()

SCIP_RETCODE SCIPfreeRealarray ( SCIP scip,
SCIP_REALARRAY **  realarray 
)

frees a dynamic array of real values

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
realarraypointer to the real array

Definition at line 147 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarrayFree().

◆ SCIPextendRealarray()

SCIP_RETCODE SCIPextendRealarray ( SCIP scip,
SCIP_REALARRAY realarray,
int  minidx,
int  maxidx 
)

extends dynamic array to be able to store indices from minidx to maxidx

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
realarraydynamic real array
minidxsmallest index to allocate storage for
maxidxlargest index to allocate storage for

Definition at line 164 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPrealarrayExtend(), and Scip::set.

◆ SCIPclearRealarray()

SCIP_RETCODE SCIPclearRealarray ( SCIP scip,
SCIP_REALARRAY realarray 
)

clears a dynamic real array

Returns
clears a dynamic real array

clears a dynamic real array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
realarraydynamic real array

Definition at line 183 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarrayClear().

◆ SCIPgetRealarrayVal()

SCIP_Real SCIPgetRealarrayVal ( SCIP scip,
SCIP_REALARRAY realarray,
int  idx 
)

gets value of entry in dynamic array

gets value of entry in dynamic array

Returns
value of entry in dynamic array
Parameters
scipSCIP data structure
realarraydynamic real array
idxarray index to get value for

Definition at line 199 of file scip_datastructures.c.

References NULL, and SCIPrealarrayGetVal().

◆ SCIPsetRealarrayVal()

SCIP_RETCODE SCIPsetRealarrayVal ( SCIP scip,
SCIP_REALARRAY realarray,
int  idx,
SCIP_Real  val 
)

sets value of entry in dynamic array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
realarraydynamic real array
idxarray index to set value for
valvalue to set array index to

Definition at line 215 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPrealarraySetVal(), and Scip::set.

◆ SCIPincRealarrayVal()

SCIP_RETCODE SCIPincRealarrayVal ( SCIP scip,
SCIP_REALARRAY realarray,
int  idx,
SCIP_Real  incval 
)

increases value of entry in dynamic array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
realarraydynamic real array
idxarray index to increase value for
incvalvalue to increase array index

Definition at line 234 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPrealarrayIncVal(), and Scip::set.

◆ SCIPgetRealarrayMinIdx()

int SCIPgetRealarrayMinIdx ( SCIP scip,
SCIP_REALARRAY realarray 
)

returns the minimal index of all stored non-zero elements

Returns
the minimal index of all stored non-zero elements
Parameters
scipSCIP data structure
realarraydynamic real array

Definition at line 252 of file scip_datastructures.c.

References NULL, and SCIPrealarrayGetMinIdx().

◆ SCIPgetRealarrayMaxIdx()

int SCIPgetRealarrayMaxIdx ( SCIP scip,
SCIP_REALARRAY realarray 
)

returns the maximal index of all stored non-zero elements

Returns
the maximal index of all stored non-zero elements
Parameters
scipSCIP data structure
realarraydynamic real array

Definition at line 266 of file scip_datastructures.c.

References NULL, and SCIPrealarrayGetMaxIdx().

◆ SCIPcreateIntarray()

SCIP_RETCODE SCIPcreateIntarray ( SCIP scip,
SCIP_INTARRAY **  intarray 
)

creates a dynamic array of int values

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
intarraypointer to store the int array

Definition at line 281 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPintarrayCreate().

◆ SCIPfreeIntarray()

SCIP_RETCODE SCIPfreeIntarray ( SCIP scip,
SCIP_INTARRAY **  intarray 
)

frees a dynamic array of int values

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
intarraypointer to the int array

Definition at line 298 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarrayFree().

◆ SCIPextendIntarray()

SCIP_RETCODE SCIPextendIntarray ( SCIP scip,
SCIP_INTARRAY intarray,
int  minidx,
int  maxidx 
)

extends dynamic array to be able to store indices from minidx to maxidx

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
intarraydynamic int array
minidxsmallest index to allocate storage for
maxidxlargest index to allocate storage for

Definition at line 315 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPintarrayExtend(), and Scip::set.

◆ SCIPclearIntarray()

SCIP_RETCODE SCIPclearIntarray ( SCIP scip,
SCIP_INTARRAY intarray 
)

clears a dynamic int array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
intarraydynamic int array

Definition at line 334 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarrayClear().

◆ SCIPgetIntarrayVal()

int SCIPgetIntarrayVal ( SCIP scip,
SCIP_INTARRAY intarray,
int  idx 
)

gets value of entry in dynamic array

Returns
value of entry in dynamic array
Parameters
scipSCIP data structure
intarraydynamic int array
idxarray index to get value for

Definition at line 350 of file scip_datastructures.c.

References NULL, and SCIPintarrayGetVal().

◆ SCIPsetIntarrayVal()

SCIP_RETCODE SCIPsetIntarrayVal ( SCIP scip,
SCIP_INTARRAY intarray,
int  idx,
int  val 
)

sets value of entry in dynamic array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
intarraydynamic int array
idxarray index to set value for
valvalue to set array index to

Definition at line 366 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPintarraySetVal(), and Scip::set.

◆ SCIPincIntarrayVal()

SCIP_RETCODE SCIPincIntarrayVal ( SCIP scip,
SCIP_INTARRAY intarray,
int  idx,
int  incval 
)

increases value of entry in dynamic array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
intarraydynamic int array
idxarray index to increase value for
incvalvalue to increase array index

Definition at line 385 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPintarrayIncVal(), and Scip::set.

◆ SCIPgetIntarrayMinIdx()

int SCIPgetIntarrayMinIdx ( SCIP scip,
SCIP_INTARRAY intarray 
)

returns the minimal index of all stored non-zero elements

Returns
the minimal index of all stored non-zero elements
Parameters
scipSCIP data structure
intarraydynamic int array

Definition at line 403 of file scip_datastructures.c.

References NULL, and SCIPintarrayGetMinIdx().

◆ SCIPgetIntarrayMaxIdx()

int SCIPgetIntarrayMaxIdx ( SCIP scip,
SCIP_INTARRAY intarray 
)

returns the maximal index of all stored non-zero elements

Returns
the maximal index of all stored non-zero elements
Parameters
scipSCIP data structure
intarraydynamic int array

Definition at line 417 of file scip_datastructures.c.

References NULL, and SCIPintarrayGetMaxIdx().

◆ SCIPcreateBoolarray()

SCIP_RETCODE SCIPcreateBoolarray ( SCIP scip,
SCIP_BOOLARRAY **  boolarray 
)

creates a dynamic array of bool values

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
boolarraypointer to store the bool array

Definition at line 432 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPboolarrayCreate().

◆ SCIPfreeBoolarray()

SCIP_RETCODE SCIPfreeBoolarray ( SCIP scip,
SCIP_BOOLARRAY **  boolarray 
)

frees a dynamic array of bool values

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
boolarraypointer to the bool array

Definition at line 449 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarrayFree().

◆ SCIPextendBoolarray()

SCIP_RETCODE SCIPextendBoolarray ( SCIP scip,
SCIP_BOOLARRAY boolarray,
int  minidx,
int  maxidx 
)

extends dynamic array to be able to store indices from minidx to maxidx

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
boolarraydynamic bool array
minidxsmallest index to allocate storage for
maxidxlargest index to allocate storage for

Definition at line 466 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPboolarrayExtend(), and Scip::set.

◆ SCIPclearBoolarray()

SCIP_RETCODE SCIPclearBoolarray ( SCIP scip,
SCIP_BOOLARRAY boolarray 
)

clears a dynamic bool array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
boolarraydynamic bool array

Definition at line 485 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarrayClear().

◆ SCIPgetBoolarrayVal()

SCIP_Bool SCIPgetBoolarrayVal ( SCIP scip,
SCIP_BOOLARRAY boolarray,
int  idx 
)

gets value of entry in dynamic array

Returns
value of entry in dynamic array at position idx
Parameters
scipSCIP data structure
boolarraydynamic bool array
idxarray index to get value for

Definition at line 501 of file scip_datastructures.c.

References NULL, and SCIPboolarrayGetVal().

◆ SCIPsetBoolarrayVal()

SCIP_RETCODE SCIPsetBoolarrayVal ( SCIP scip,
SCIP_BOOLARRAY boolarray,
int  idx,
SCIP_Bool  val 
)

sets value of entry in dynamic array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
boolarraydynamic bool array
idxarray index to set value for
valvalue to set array index to

Definition at line 517 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPboolarraySetVal(), and Scip::set.

◆ SCIPgetBoolarrayMinIdx()

int SCIPgetBoolarrayMinIdx ( SCIP scip,
SCIP_BOOLARRAY boolarray 
)

returns the minimal index of all stored non-zero elements

Returns
the minimal index of all stored non-zero elements
Parameters
scipSCIP data structure
boolarraydynamic bool array

Definition at line 535 of file scip_datastructures.c.

References NULL, and SCIPboolarrayGetMinIdx().

◆ SCIPgetBoolarrayMaxIdx()

int SCIPgetBoolarrayMaxIdx ( SCIP scip,
SCIP_BOOLARRAY boolarray 
)

returns the maximal index of all stored non-zero elements

Returns
the maximal index of all stored non-zero elements
Parameters
scipSCIP data structure
boolarraydynamic bool array

Definition at line 549 of file scip_datastructures.c.

References NULL, and SCIPboolarrayGetMaxIdx().

◆ SCIPcreatePtrarray()

SCIP_RETCODE SCIPcreatePtrarray ( SCIP scip,
SCIP_PTRARRAY **  ptrarray 
)

creates a dynamic array of pointers

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
ptrarraypointer to store the int array

Definition at line 564 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPptrarrayCreate().

◆ SCIPfreePtrarray()

SCIP_RETCODE SCIPfreePtrarray ( SCIP scip,
SCIP_PTRARRAY **  ptrarray 
)

frees a dynamic array of pointers

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
ptrarraypointer to the int array

Definition at line 581 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayFree().

◆ SCIPextendPtrarray()

SCIP_RETCODE SCIPextendPtrarray ( SCIP scip,
SCIP_PTRARRAY ptrarray,
int  minidx,
int  maxidx 
)

extends dynamic array to be able to store indices from minidx to maxidx

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
ptrarraydynamic int array
minidxsmallest index to allocate storage for
maxidxlargest index to allocate storage for

Definition at line 598 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPptrarrayExtend(), and Scip::set.

◆ SCIPclearPtrarray()

SCIP_RETCODE SCIPclearPtrarray ( SCIP scip,
SCIP_PTRARRAY ptrarray 
)

clears a dynamic pointer array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
ptrarraydynamic int array

Definition at line 617 of file scip_datastructures.c.

References NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayClear().

◆ SCIPgetPtrarrayVal()

void* SCIPgetPtrarrayVal ( SCIP scip,
SCIP_PTRARRAY ptrarray,
int  idx 
)

gets value of entry in dynamic array

Parameters
scipSCIP data structure
ptrarraydynamic int array
idxarray index to get value for

Definition at line 630 of file scip_datastructures.c.

References NULL, and SCIPptrarrayGetVal().

◆ SCIPsetPtrarrayVal()

SCIP_RETCODE SCIPsetPtrarrayVal ( SCIP scip,
SCIP_PTRARRAY ptrarray,
int  idx,
void *  val 
)

sets value of entry in dynamic array

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Parameters
scipSCIP data structure
ptrarraydynamic int array
idxarray index to set value for
valvalue to set array index to

Definition at line 646 of file scip_datastructures.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPptrarraySetVal(), and Scip::set.

◆ SCIPgetPtrarrayMinIdx()

int SCIPgetPtrarrayMinIdx ( SCIP scip,
SCIP_PTRARRAY ptrarray 
)

returns the minimal index of all stored non-zero elements

Returns
the minimal index of all stored non-zero elements
Parameters
scipSCIP data structure
ptrarraydynamic ptr array

Definition at line 664 of file scip_datastructures.c.

References NULL, and SCIPptrarrayGetMinIdx().

◆ SCIPgetPtrarrayMaxIdx()

int SCIPgetPtrarrayMaxIdx ( SCIP scip,
SCIP_PTRARRAY ptrarray 
)

returns the maximal index of all stored non-zero elements

Returns
the maximal index of all stored non-zero elements
Parameters
scipSCIP data structure
ptrarraydynamic ptr array

Definition at line 678 of file scip_datastructures.c.

References NULL, and SCIPptrarrayGetMaxIdx().