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 47858 of file scip.c.

References 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 47875 of file scip.c.

References 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 47892 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 47911 of file scip.c.

References 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 47927 of file scip.c.

References 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 47943 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 47962 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 47980 of file scip.c.

References 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 47994 of file scip.c.

References 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 48009 of file scip.c.

References 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 48026 of file scip.c.

References 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 48043 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48062 of file scip.c.

References 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 48078 of file scip.c.

References 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 48094 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48113 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48131 of file scip.c.

References 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 48145 of file scip.c.

References 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 48160 of file scip.c.

References 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 48177 of file scip.c.

References 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 48194 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48213 of file scip.c.

References 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 48229 of file scip.c.

References 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 48245 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48263 of file scip.c.

References 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 48277 of file scip.c.

References 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 48292 of file scip.c.

References 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 48309 of file scip.c.

References 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 48326 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48345 of file scip.c.

References 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 48358 of file scip.c.

References 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 48374 of file scip.c.

References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, 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 48392 of file scip.c.

References 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 48406 of file scip.c.

References SCIPptrarrayGetMaxIdx().