Scippy

SCIP

Solving Constraint Integer Programs

Macros | Functions
expriter.c File Reference
Implementation files (.c files) » Other implementation files of SCIP

Detailed Description

functions for iterating over algebraic expressions

Author
Benjamin Mueller
Stefan Vigerske

Definition in file expriter.c.

#include <assert.h>
#include "scip/expr.h"
#include "scip/pub_misc.h"
#include "scip/struct_expr.h"
#include "scip/struct_stat.h"

Go to the source code of this file.

Macros

#define MINDFSSIZE   16
 
#define MINBFSSIZE   16
 
#define storeBacktrace(subscipdepth, iterpos)
 

Functions

static void printBacktraces (int subscipdepth)
 
static void deinit (SCIP_EXPRITER *iterator)
 
static SCIP_RETCODE ensureStackSize (SCIP_EXPRITER *iterator, int size)
 
static void reverseTopologicalInsert (SCIP_EXPRITER *iterator, SCIP_EXPR *expr)
 
static SCIP_EXPR * doReverseTopologicalNext (SCIP_EXPRITER *iterator)
 
static SCIP_EXPR * doBfsNext (SCIP_EXPRITER *iterator)
 
static SCIP_EXPR * doDfsNext (SCIP_EXPRITER *iterator)
 
SCIP_RETCODE SCIPexpriterCreate (SCIP_STAT *stat, BMS_BLKMEM *blkmem, SCIP_EXPRITER **iterator)
 
void SCIPexpriterFree (SCIP_EXPRITER **iterator)
 
SCIP_Bool SCIPexpriterIsInit (SCIP_EXPRITER *iterator)
 
SCIP_RETCODE SCIPexpriterInit (SCIP_EXPRITER *iterator, SCIP_EXPR *expr, SCIP_EXPRITER_TYPE type, SCIP_Bool allowrevisit)
 
SCIP_EXPR * SCIPexpriterRestartDFS (SCIP_EXPRITER *iterator, SCIP_EXPR *expr)
 
void SCIPexpriterSetStagesDFS (SCIP_EXPRITER *iterator, SCIP_EXPRITER_STAGE stopstages)
 
SCIP_EXPR * SCIPexpriterGetCurrent (SCIP_EXPRITER *iterator)
 
SCIP_EXPRITER_STAGE SCIPexpriterGetStageDFS (SCIP_EXPRITER *iterator)
 
int SCIPexpriterGetChildIdxDFS (SCIP_EXPRITER *iterator)
 
SCIP_EXPR * SCIPexpriterGetChildExprDFS (SCIP_EXPRITER *iterator)
 
SCIP_EXPR * SCIPexpriterGetParentDFS (SCIP_EXPRITER *iterator)
 
SCIP_EXPRITER_USERDATA SCIPexpriterGetCurrentUserData (SCIP_EXPRITER *iterator)
 
SCIP_EXPRITER_USERDATA SCIPexpriterGetChildUserDataDFS (SCIP_EXPRITER *iterator)
 
SCIP_EXPRITER_USERDATA SCIPexpriterGetExprUserData (SCIP_EXPRITER *iterator, SCIP_EXPR *expr)
 
void SCIPexpriterSetCurrentUserData (SCIP_EXPRITER *iterator, SCIP_EXPRITER_USERDATA userdata)
 
void SCIPexpriterSetExprUserData (SCIP_EXPRITER *iterator, SCIP_EXPR *expr, SCIP_EXPRITER_USERDATA userdata)
 
void SCIPexpriterSetChildUserData (SCIP_EXPRITER *iterator, SCIP_EXPRITER_USERDATA userdata)
 
SCIP_EXPR * SCIPexpriterGetNext (SCIP_EXPRITER *iterator)
 
SCIP_EXPR * SCIPexpriterSkipDFS (SCIP_EXPRITER *iterator)
 
SCIP_Bool SCIPexpriterIsEnd (SCIP_EXPRITER *iterator)
 

Macro Definition Documentation

◆ MINDFSSIZE

#define MINDFSSIZE   16

minimum stack size for DFS

Definition at line 35 of file expriter.c.

Referenced by SCIPexpriterInit().

◆ MINBFSSIZE

#define MINBFSSIZE   16

minimum queue size for BFS

Definition at line 36 of file expriter.c.

Referenced by SCIPexpriterInit().

◆ storeBacktrace

#define storeBacktrace (   subscipdepth,
  iterpos 
)

Definition at line 120 of file expriter.c.

Referenced by SCIPexpriterInit().

Function Documentation

◆ printBacktraces()

static void printBacktraces ( int  subscipdepth)
static
Parameters
subscipdepthcurrent subscip depth

Definition at line 124 of file expriter.c.

References SCIPerrorMessage.

Referenced by SCIPexpriterInit().

◆ deinit()

static void deinit ( SCIP_EXPRITER *  iterator)
static
Parameters
iteratorexpression iterator

Definition at line 134 of file expriter.c.

References SCIP_ExprIter::blkmem, BMSfreeBlockMemoryArray, SCIP_ExprIter::dfsexprs, SCIP_ExprIter::dfsnvisited, SCIP_ExprIter::dfssize, SCIP_ExprIter::initialized, SCIP_ExprIter::iterindex, SCIP_ExprIter::itertype, SCIP_Stat::nactiveexpriter, NULL, SCIP_ExprIter::queue, SCIP_EXPRITER_BFS, SCIP_EXPRITER_DFS, SCIP_EXPRITER_RTOPOLOGIC, SCIPqueueFree(), and SCIP_ExprIter::stat.

Referenced by SCIPexpriterFree(), and SCIPexpriterInit().

◆ ensureStackSize()

static SCIP_RETCODE ensureStackSize ( SCIP_EXPRITER *  iterator,
int  size 
)
static

ensures minimum stack size of iterator's data

Parameters
iteratorexpression iterator
sizeminimum requires size

Definition at line 185 of file expriter.c.

References SCIP_ExprIter::blkmem, BMSreallocBlockMemoryArray, SCIP_ExprIter::dfsexprs, SCIP_ExprIter::dfsnvisited, SCIP_ExprIter::dfssize, SCIP_ExprIter::itertype, NULL, SCIP_ALLOC, SCIP_EXPRITER_RTOPOLOGIC, and SCIP_OKAY.

Referenced by reverseTopologicalInsert(), and SCIPexpriterInit().

◆ reverseTopologicalInsert()

static void reverseTopologicalInsert ( SCIP_EXPRITER *  iterator,
SCIP_EXPR *  expr 
)
static

adds an expression to the DFS stack

Parameters
iteratorexpression iterator
exprexpression

Definition at line 209 of file expriter.c.

References SCIP_ExprIter::dfsexprs, SCIP_ExprIter::dfsnexprs, SCIP_ExprIter::dfsnvisited, ensureStackSize(), NULL, and SCIP_CALL_ABORT.

Referenced by doReverseTopologicalNext(), and SCIPexpriterInit().

◆ doReverseTopologicalNext()

static SCIP_EXPR* doReverseTopologicalNext ( SCIP_EXPRITER *  iterator)
static

moves to the next expression according to a reverse topological order

Parameters
iteratorexpression iterator

Definition at line 225 of file expriter.c.

References SCIP_ExprIter::dfsexprs, SCIP_ExprIter::dfsnexprs, SCIP_ExprIter::dfsnvisited, SCIP_ExprIter::itertype, NULL, reverseTopologicalInsert(), SCIP_EXPRITER_RTOPOLOGIC, SCIPexprGetChildren(), and SCIPexprGetNChildren().

Referenced by SCIPexpriterGetNext().

◆ doBfsNext()

static SCIP_EXPR* doBfsNext ( SCIP_EXPRITER *  iterator)
static

moves to the next expression according to the BFS rule

Parameters
iteratorexpression iterator

Definition at line 277 of file expriter.c.

References SCIP_Expr::iterdata, SCIP_ExprIter::iterindex, SCIP_ExprIter::itertype, NULL, SCIP_ExprIter::queue, SCIP_CALL_ABORT, SCIP_EXPRITER_BFS, SCIP_EXPRITER_MAXNACTIVE, SCIPexprGetChildren(), SCIPexprGetNChildren(), SCIPqueueInsert(), SCIPqueueIsEmpty(), SCIPqueueRemove(), and SCIP_ExprIter::visitedtag.

Referenced by SCIPexpriterGetNext().

◆ doDfsNext()

static SCIP_EXPR* doDfsNext ( SCIP_EXPRITER *  iterator)
static

moves to the next expression according to the DFS rule

Parameters
iteratorexpression iterator

Definition at line 328 of file expriter.c.

References SCIP_Expr::children, SCIP_ExprIter::curr, SCIP_ExprIter::dfsstage, SCIP_Expr::iterdata, SCIP_ExprIter::iterindex, SCIP_ExprIter::itertype, SCIP_Expr::nchildren, NULL, SCIP_EXPRITER_DFS, SCIP_EXPRITER_ENTEREXPR, SCIP_EXPRITER_LEAVEEXPR, SCIP_EXPRITER_VISITEDCHILD, SCIP_EXPRITER_VISITINGCHILD, SCIPABORT, and SCIP_ExprIter::visitedtag.

Referenced by SCIPexpriterGetNext(), and SCIPexpriterSkipDFS().

◆ SCIPexpriterCreate()

SCIP_RETCODE SCIPexpriterCreate ( SCIP_STAT *  stat,
BMS_BLKMEM *  blkmem,
SCIP_EXPRITER **  iterator 
)

creates an expression iterator

Parameters
statdynamic problem statistics
blkmemblock memory
iteratorbuffer to store expression iterator

Definition at line 417 of file expriter.c.

References BMSallocClearBlockMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by evalAndDiff(), nlpAddNlRows(), nlpDelVarPos(), SCIPcomputeExprCurvature(), SCIPcomputeExprIntegrality(), SCIPcreateExpriter(), SCIPexprCopy(), SCIPexprDismantle(), SCIPexprEval(), SCIPexprEvalActivity(), SCIPexprEvalGradient(), SCIPexprEvalHessianDir(), SCIPexprPrint(), SCIPexprPrintDotInit(), SCIPexprRelease(), SCIPexprSimplify(), SCIPgetExprNVars(), SCIPgetExprVarExprs(), SCIPhashExpr(), SCIPnlpGetVarsNonlinearity(), and SCIPnlpHasContinuousNonlinearity().

◆ SCIPexpriterFree()

void SCIPexpriterFree ( SCIP_EXPRITER **  iterator)

frees an expression iterator

Parameters
iteratorpointer to the expression iterator

Definition at line 436 of file expriter.c.

References BMSfreeBlockMemory, deinit(), and NULL.

Referenced by evalAndDiff(), nlpAddNlRows(), nlpDelVarPos(), SCIPcomputeExprCurvature(), SCIPcomputeExprIntegrality(), SCIPexprCopy(), SCIPexprDismantle(), SCIPexprEval(), SCIPexprEvalActivity(), SCIPexprEvalGradient(), SCIPexprEvalHessianDir(), SCIPexprPrint(), SCIPexprPrintDotFinal(), SCIPexprRelease(), SCIPexprSimplify(), SCIPfreeExpriter(), SCIPgetExprNVars(), SCIPgetExprVarExprs(), SCIPhashExpr(), SCIPnlpGetVarsNonlinearity(), SCIPnlpHasContinuousNonlinearity(), and SCIPreplaceCommonSubexpressions().