Detailed Description
methods for the creation and access of dynamic arrays
Function Documentation
◆ SCIPcreateRealarray()
SCIP_EXPORT 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
-
scip SCIP data structure realarray pointer to store the real array
Definition at line 49 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPrealarrayCreate().
◆ SCIPfreeRealarray()
SCIP_EXPORT 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
-
scip SCIP data structure realarray pointer to the real array
Definition at line 66 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarrayFree().
◆ SCIPextendRealarray()
SCIP_EXPORT 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
-
scip SCIP data structure realarray dynamic real array minidx smallest index to allocate storage for maxidx largest index to allocate storage for
Definition at line 83 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_EXPORT 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
-
scip SCIP data structure realarray dynamic real array
Definition at line 102 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarrayClear().
◆ SCIPgetRealarrayVal()
SCIP_EXPORT 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
-
scip SCIP data structure realarray dynamic real array idx array index to get value for
Definition at line 118 of file scip_datastructures.c.
References NULL, and SCIPrealarrayGetVal().
◆ SCIPsetRealarrayVal()
SCIP_EXPORT 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
-
scip SCIP data structure realarray dynamic real array idx array index to set value for val value to set array index to
Definition at line 134 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_EXPORT 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
-
scip SCIP data structure realarray dynamic real array idx array index to increase value for incval value to increase array index
Definition at line 153 of file scip_datastructures.c.
References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPrealarrayIncVal(), and Scip::set.
◆ SCIPgetRealarrayMinIdx()
SCIP_EXPORT 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
-
scip SCIP data structure realarray dynamic real array
Definition at line 171 of file scip_datastructures.c.
References NULL, and SCIPrealarrayGetMinIdx().
◆ SCIPgetRealarrayMaxIdx()
SCIP_EXPORT 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
-
scip SCIP data structure realarray dynamic real array
Definition at line 185 of file scip_datastructures.c.
References NULL, and SCIPrealarrayGetMaxIdx().
◆ SCIPcreateIntarray()
SCIP_EXPORT 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
-
scip SCIP data structure intarray pointer to store the int array
Definition at line 200 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPintarrayCreate().
◆ SCIPfreeIntarray()
SCIP_EXPORT 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
-
scip SCIP data structure intarray pointer to the int array
Definition at line 217 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarrayFree().
◆ SCIPextendIntarray()
SCIP_EXPORT 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
-
scip SCIP data structure intarray dynamic int array minidx smallest index to allocate storage for maxidx largest index to allocate storage for
Definition at line 234 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_EXPORT 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
-
scip SCIP data structure intarray dynamic int array
Definition at line 253 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarrayClear().
◆ SCIPgetIntarrayVal()
SCIP_EXPORT int SCIPgetIntarrayVal | ( | SCIP * | scip, |
SCIP_INTARRAY * | intarray, | ||
int | idx | ||
) |
gets value of entry in dynamic array
- Returns
- value of entry in dynamic array
- Parameters
-
scip SCIP data structure intarray dynamic int array idx array index to get value for
Definition at line 269 of file scip_datastructures.c.
References NULL, and SCIPintarrayGetVal().
◆ SCIPsetIntarrayVal()
SCIP_EXPORT 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
-
scip SCIP data structure intarray dynamic int array idx array index to set value for val value to set array index to
Definition at line 285 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_EXPORT 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
-
scip SCIP data structure intarray dynamic int array idx array index to increase value for incval value to increase array index
Definition at line 304 of file scip_datastructures.c.
References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPintarrayIncVal(), and Scip::set.
◆ SCIPgetIntarrayMinIdx()
SCIP_EXPORT 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
-
scip SCIP data structure intarray dynamic int array
Definition at line 322 of file scip_datastructures.c.
References NULL, and SCIPintarrayGetMinIdx().
◆ SCIPgetIntarrayMaxIdx()
SCIP_EXPORT 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
-
scip SCIP data structure intarray dynamic int array
Definition at line 336 of file scip_datastructures.c.
References NULL, and SCIPintarrayGetMaxIdx().
◆ SCIPcreateBoolarray()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray pointer to store the bool array
Definition at line 351 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPboolarrayCreate().
◆ SCIPfreeBoolarray()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray pointer to the bool array
Definition at line 368 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarrayFree().
◆ SCIPextendBoolarray()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray dynamic bool array minidx smallest index to allocate storage for maxidx largest index to allocate storage for
Definition at line 385 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_EXPORT 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
-
scip SCIP data structure boolarray dynamic bool array
Definition at line 404 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarrayClear().
◆ SCIPgetBoolarrayVal()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray dynamic bool array idx array index to get value for
Definition at line 420 of file scip_datastructures.c.
References NULL, and SCIPboolarrayGetVal().
◆ SCIPsetBoolarrayVal()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray dynamic bool array idx array index to set value for val value to set array index to
Definition at line 436 of file scip_datastructures.c.
References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPboolarraySetVal(), and Scip::set.
◆ SCIPgetBoolarrayMinIdx()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray dynamic bool array
Definition at line 454 of file scip_datastructures.c.
References NULL, and SCIPboolarrayGetMinIdx().
◆ SCIPgetBoolarrayMaxIdx()
SCIP_EXPORT 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
-
scip SCIP data structure boolarray dynamic bool array
Definition at line 468 of file scip_datastructures.c.
References NULL, and SCIPboolarrayGetMaxIdx().
◆ SCIPcreatePtrarray()
SCIP_EXPORT 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
-
scip SCIP data structure ptrarray pointer to store the int array
Definition at line 483 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPptrarrayCreate().
◆ SCIPfreePtrarray()
SCIP_EXPORT 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
-
scip SCIP data structure ptrarray pointer to the int array
Definition at line 500 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayFree().
◆ SCIPextendPtrarray()
SCIP_EXPORT 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
-
scip SCIP data structure ptrarray dynamic int array minidx smallest index to allocate storage for maxidx largest index to allocate storage for
Definition at line 517 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_EXPORT 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
-
scip SCIP data structure ptrarray dynamic int array
Definition at line 536 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayClear().
◆ SCIPgetPtrarrayVal()
SCIP_EXPORT void* SCIPgetPtrarrayVal | ( | SCIP * | scip, |
SCIP_PTRARRAY * | ptrarray, | ||
int | idx | ||
) |
gets value of entry in dynamic array
- Parameters
-
scip SCIP data structure ptrarray dynamic int array idx array index to get value for
Definition at line 549 of file scip_datastructures.c.
References NULL, and SCIPptrarrayGetVal().
◆ SCIPsetPtrarrayVal()
SCIP_EXPORT 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
-
scip SCIP data structure ptrarray dynamic int array idx array index to set value for val value to set array index to
Definition at line 565 of file scip_datastructures.c.
References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPptrarraySetVal(), and Scip::set.
◆ SCIPgetPtrarrayMinIdx()
SCIP_EXPORT 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
-
scip SCIP data structure ptrarray dynamic ptr array
Definition at line 583 of file scip_datastructures.c.
References NULL, and SCIPptrarrayGetMinIdx().
◆ SCIPgetPtrarrayMaxIdx()
SCIP_EXPORT 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
-
scip SCIP data structure ptrarray dynamic ptr array
Definition at line 597 of file scip_datastructures.c.
References NULL, and SCIPptrarrayGetMaxIdx().