Detailed Description
methods for the creation and access of dynamic arrays
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
-
scip SCIP data structure realarray pointer to store the real array
Definition at line 58 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
-
scip SCIP data structure realarray pointer to the real array
Definition at line 75 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
-
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 92 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
-
scip SCIP data structure realarray dynamic real array
Definition at line 111 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
-
scip SCIP data structure realarray dynamic real array idx array index to get value for
Definition at line 127 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
-
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 143 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
-
scip SCIP data structure realarray dynamic real array idx array index to increase value for incval value to increase array index
Definition at line 162 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
-
scip SCIP data structure realarray dynamic real array
Definition at line 180 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
-
scip SCIP data structure realarray dynamic real array
Definition at line 194 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
-
scip SCIP data structure intarray pointer to store the int array
Definition at line 209 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
-
scip SCIP data structure intarray pointer to the int array
Definition at line 226 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
-
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 243 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
-
scip SCIP data structure intarray dynamic int array
Definition at line 262 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
-
scip SCIP data structure intarray dynamic int array idx array index to get value for
Definition at line 278 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
-
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 294 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
-
scip SCIP data structure intarray dynamic int array idx array index to increase value for incval value to increase array index
Definition at line 313 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
-
scip SCIP data structure intarray dynamic int array
Definition at line 331 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
-
scip SCIP data structure intarray dynamic int array
Definition at line 345 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
-
scip SCIP data structure boolarray pointer to store the bool array
Definition at line 360 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPboolarrayCreate().
Referenced by SCIP_DECL_NLHDLRENFO().
◆ 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
-
scip SCIP data structure boolarray pointer to the bool array
Definition at line 377 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarrayFree().
Referenced by SCIP_DECL_NLHDLRENFO().
◆ 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
-
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 394 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
-
scip SCIP data structure boolarray dynamic bool array
Definition at line 413 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
-
scip SCIP data structure boolarray dynamic bool array idx array index to get value for
Definition at line 429 of file scip_datastructures.c.
References NULL, and SCIPboolarrayGetVal().
Referenced by SCIP_DECL_NLHDLRENFO().
◆ 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
-
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 445 of file scip_datastructures.c.
References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPboolarraySetVal(), and Scip::set.
Referenced by SCIP_DECL_NLHDLRENFO().
◆ 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
-
scip SCIP data structure boolarray dynamic bool array
Definition at line 463 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
-
scip SCIP data structure boolarray dynamic bool array
Definition at line 477 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
-
scip SCIP data structure ptrarray pointer to store the int array
Definition at line 492 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPblkmem(), and SCIPptrarrayCreate().
Referenced by addTightEstimatorCuts(), enforceExprNlhdlr(), and SCIP_DECL_NLHDLRENFO().
◆ 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
-
scip SCIP data structure ptrarray pointer to the int array
Definition at line 509 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayFree().
Referenced by addTightEstimatorCuts(), enforceExprNlhdlr(), and SCIP_DECL_NLHDLRENFO().
◆ 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
-
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 526 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
-
scip SCIP data structure ptrarray dynamic int array
Definition at line 545 of file scip_datastructures.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayClear().
Referenced by addTightEstimatorCut(), and SCIP_DECL_NLHDLRENFO().
◆ SCIPgetPtrarrayVal()
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 558 of file scip_datastructures.c.
References NULL, and SCIPptrarrayGetVal().
Referenced by addTightEstimatorCut(), enforceExprNlhdlr(), and SCIP_DECL_NLHDLRENFO().
◆ 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
-
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 574 of file scip_datastructures.c.
References SCIP_Set::mem_arraygrowfac, SCIP_Set::mem_arraygrowinit, NULL, SCIP_CALL, SCIP_OKAY, SCIPptrarraySetVal(), and Scip::set.
Referenced by SCIP_DECL_NLHDLRENFO(), and SCIP_DECL_NLHDLRESTIMATE().
◆ 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
-
scip SCIP data structure ptrarray dynamic ptr array
Definition at line 592 of file scip_datastructures.c.
References NULL, and SCIPptrarrayGetMinIdx().
Referenced by addTightEstimatorCut(), enforceExprNlhdlr(), and SCIP_DECL_NLHDLRENFO().
◆ 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
-
scip SCIP data structure ptrarray dynamic ptr array
Definition at line 606 of file scip_datastructures.c.
References NULL, and SCIPptrarrayGetMaxIdx().
Referenced by addTightEstimatorCut(), enforceExprNlhdlr(), and SCIP_DECL_NLHDLRENFO().