SCIP Doxygen Documentation
 
Loading...
Searching...
No Matches

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 58 of file scip_datastructures.c.

References assert(), 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 75 of file scip_datastructures.c.

References assert(), 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 92 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarrayExtend().

◆ 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 111 of file scip_datastructures.c.

References assert(), 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 127 of file scip_datastructures.c.

References assert(), 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 143 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarraySetVal().

◆ 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 162 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPrealarrayIncVal().

◆ 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 180 of file scip_datastructures.c.

References assert(), 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 194 of file scip_datastructures.c.

References assert(), 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 209 of file scip_datastructures.c.

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

Referenced by conshdlrdataCreate().

◆ 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 226 of file scip_datastructures.c.

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

Referenced by conshdlrdataFree().

◆ 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 243 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarrayExtend().

◆ 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 262 of file scip_datastructures.c.

References assert(), 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 278 of file scip_datastructures.c.

References assert(), 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 294 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarraySetVal().

◆ 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 313 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPintarrayIncVal().

◆ 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 331 of file scip_datastructures.c.

References assert(), 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 345 of file scip_datastructures.c.

References assert(), 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 360 of file scip_datastructures.c.

References assert(), 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
scipSCIP data structure
boolarraypointer to the bool array

Definition at line 377 of file scip_datastructures.c.

References assert(), 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
scipSCIP data structure
boolarraydynamic bool array
minidxsmallest index to allocate storage for
maxidxlargest index to allocate storage for

Definition at line 394 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarrayExtend().

◆ 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 413 of file scip_datastructures.c.

References assert(), 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 429 of file scip_datastructures.c.

References assert(), 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
scipSCIP data structure
boolarraydynamic bool array
idxarray index to set value for
valvalue to set array index to

Definition at line 445 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPboolarraySetVal().

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
scipSCIP data structure
boolarraydynamic bool array

Definition at line 463 of file scip_datastructures.c.

References assert(), 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 477 of file scip_datastructures.c.

References assert(), 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 492 of file scip_datastructures.c.

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

Referenced by 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
scipSCIP data structure
ptrarraypointer to the int array

Definition at line 509 of file scip_datastructures.c.

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

Referenced by 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
scipSCIP data structure
ptrarraydynamic int array
minidxsmallest index to allocate storage for
maxidxlargest index to allocate storage for

Definition at line 526 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarrayExtend().

◆ 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 545 of file scip_datastructures.c.

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

Referenced by SCIP_DECL_NLHDLRENFO().

◆ 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 558 of file scip_datastructures.c.

References assert(), NULL, and SCIPptrarrayGetVal().

Referenced by 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
scipSCIP data structure
ptrarraydynamic int array
idxarray index to set value for
valvalue to set array index to

Definition at line 574 of file scip_datastructures.c.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPptrarraySetVal().

Referenced by SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLRESTIMATE(), 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
scipSCIP data structure
ptrarraydynamic ptr array

Definition at line 592 of file scip_datastructures.c.

References assert(), NULL, and SCIPptrarrayGetMinIdx().

Referenced by 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
scipSCIP data structure
ptrarraydynamic ptr array

Definition at line 606 of file scip_datastructures.c.

References assert(), NULL, and SCIPptrarrayGetMaxIdx().

Referenced by enforceExprNlhdlr(), and SCIP_DECL_NLHDLRENFO().