Detailed Description
methods for managing data trees
Function Documentation
◆ SCIPdatatreeGetBool()
| SCIP_RETCODE SCIPdatatreeGetBool | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_Bool * | value | ||
| ) |
gets a SCIP_Bool value from a SCIP_DATATREE object
gets a bool value from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up value buffer to store value
Definition at line 600 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_bool, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREE_BOOL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
Referenced by SCIPprintDatatreeAsTable().
◆ SCIPdatatreeGetLong()
| SCIP_RETCODE SCIPdatatreeGetLong | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_Longint * | value | ||
| ) |
gets a long value from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up value buffer to store value
Definition at line 629 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_long, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREE_LONG, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
Referenced by SCIPprintDatatreeAsTable().
◆ SCIPdatatreeGetReal()
| SCIP_RETCODE SCIPdatatreeGetReal | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_Real * | value | ||
| ) |
gets a SCIP_Real value from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up value buffer to store value
Definition at line 658 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_real, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREE_REAL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
Referenced by SCIPprintDatatreeAsTable().
◆ SCIPdatatreeGetString()
| SCIP_RETCODE SCIPdatatreeGetString | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| const char ** | value | ||
| ) |
gets a string value from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up value buffer to store pointer to string
Definition at line 687 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_string, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREE_STRING, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
Referenced by SCIPprintDatatreeAsTable().
◆ SCIPdatatreeGetBoolArray()
| SCIP_RETCODE SCIPdatatreeGetBoolArray | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_Bool ** | values, | ||
| int * | nvalues | ||
| ) |
gets a SCIP_Bool array from a SCIP_DATATREE object
gets a bool array from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up values buffer to store pointer to values nvalues buffer to store number of values
Definition at line 716 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_boolarray, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREEVALUE::nvalues, SCIP_DATATREE_BOOLARRAY, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
◆ SCIPdatatreeGetLongArray()
| SCIP_RETCODE SCIPdatatreeGetLongArray | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_Longint ** | values, | ||
| int * | nvalues | ||
| ) |
gets a SCIP_Longint array from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up values buffer to store pointer to values nvalues buffer to store number of values
Definition at line 752 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_longarray, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREEVALUE::nvalues, SCIP_DATATREE_LONGARRAY, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
◆ SCIPdatatreeGetRealArray()
| SCIP_RETCODE SCIPdatatreeGetRealArray | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_Real ** | values, | ||
| int * | nvalues | ||
| ) |
gets a SCIP_Real array from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up values buffer to store pointer to values nvalues buffer to store number of values
Definition at line 788 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_realarray, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREEVALUE::nvalues, SCIP_DATATREE_REALARRAY, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
◆ SCIPdatatreeGetStringArray()
| SCIP_RETCODE SCIPdatatreeGetStringArray | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| char *** | values, | ||
| int * | nvalues | ||
| ) |
gets a string array from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up values buffer to store pointer to values nvalues buffer to store number of values
Definition at line 825 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_stringarray, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREEVALUE::nvalues, SCIP_DATATREE_STRINGARRAY, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
◆ SCIPdatatreeGetTree()
| SCIP_RETCODE SCIPdatatreeGetTree | ( | SCIP_DATATREE * | datatree, |
| const char * | name, | ||
| SCIP_DATATREE ** | value | ||
| ) |
gets a data tree value from a SCIP_DATATREE object
gets a datatree value from a SCIP_DATATREE object
- Parameters
-
datatree data tree name name to look up value buffer to store pointer to datatree
Definition at line 861 of file datatree.c.
References SCIP_DATATREEVALUEUNION::as_dtree, SCIP_DATATREEVALUE::data, datatreeValueTypeToString(), SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_DATATREE_DATATREE, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
Referenced by SCIPprintDatatreeAsTable().
◆ SCIPcreateDatatree()
| SCIP_RETCODE SCIPcreateDatatree | ( | SCIP * | scip, |
| SCIP_DATATREE ** | datatree, | ||
| int | capacity | ||
| ) |
creates a new SCIP_DATATREE
- Parameters
-
scip SCIP data structure datatree buffer to store created data tree capacity desired capacity, or -1 for default
Definition at line 46 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeCreate().
Referenced by scip::SCIP_DECL_TABLEOUTPUT(), and SCIPprintStatisticsJson().
◆ SCIPcreateDatatreeInTree()
| SCIP_RETCODE SCIPcreateDatatreeInTree | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| SCIP_DATATREE ** | newtree, | ||
| const char * | name, | ||
| int | capacity | ||
| ) |
creates a new SCIP_DATATREE and inserts it into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree where to insert new tree newtree buffer to store pointer to created data tree name name of entry to add capacity capacity of new tree, or -1 for default
Definition at line 61 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPdatatreeCreate(), and SCIPdatatreeInsertTree().
Referenced by collectDivingHeurStatistics(), collectNeighborhoodStatistics(), SCIP_DECL_TABLECOLLECT(), SCIPcollectBendersStatistics(), SCIPcollectBranchingStatistics(), SCIPcollectBranchruleStatistics(), SCIPcollectCompressionStatistics(), SCIPcollectConcsolverStatistics(), SCIPcollectConstraintStatistics(), SCIPcollectConstraintTimingStatistics(), SCIPcollectCutselectorStatistics(), SCIPcollectExpressionHandlerStatistics(), SCIPcollectHeuristicStatistics(), SCIPcollectLPStatistics(), SCIPcollectNLPIStatistics(), SCIPcollectPresolverStatistics(), SCIPcollectPricerStatistics(), SCIPcollectPropagatorStatistics(), SCIPcollectRelaxatorStatistics(), SCIPcollectSeparatorStatistics(), SCIPcollectTreeStatistics(), SCIPnlhdlrCollectStatistics(), and SCIPprintStatisticsJson().
◆ SCIPinsertDatatreeBool()
| SCIP_RETCODE SCIPinsertDatatreeBool | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| SCIP_Bool | value | ||
| ) |
inserts a bool value into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add value value to add
Definition at line 82 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertBool().
Referenced by collectNeighborhoodStatistics(), and SCIPcollectSolutionStatistics().
◆ SCIPinsertDatatreeInt()
| SCIP_RETCODE SCIPinsertDatatreeInt | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| int | value | ||
| ) |
inserts an int value into a SCIP_DATATREE object
The value will be stored as SCIP_Longint.
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add value value to add
Definition at line 102 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_Longint, SCIP_OKAY, and SCIPdatatreeInsertLong().
Referenced by collectDivingHeurStatistics(), collectNeighborhoodStatistics(), SCIP_DECL_TABLECOLLECT(), SCIPcollectBendersStatistics(), SCIPcollectBranchingStatistics(), SCIPcollectConcsolverStatistics(), SCIPcollectConflictStatistics(), SCIPcollectConstraintStatistics(), SCIPcollectHeuristicStatistics(), SCIPcollectNLPIStatistics(), SCIPcollectNLPStatistics(), SCIPcollectPresolverStatistics(), SCIPcollectPricerStatistics(), SCIPcollectSolutionStatistics(), and SCIPcollectTreeStatistics().
◆ SCIPinsertDatatreeLong()
| SCIP_RETCODE SCIPinsertDatatreeLong | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| SCIP_Longint | value | ||
| ) |
inserts a long value into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add value value to add
Definition at line 119 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertLong().
Referenced by collectDivingHeurStatistics(), collectNeighborhoodStatistics(), SCIP_DECL_TABLECOLLECT(), SCIPcollectBendersStatistics(), SCIPcollectBranchingStatistics(), SCIPcollectBranchruleStatistics(), SCIPcollectCompressionStatistics(), SCIPcollectConcsolverStatistics(), SCIPcollectConflictStatistics(), SCIPcollectConstraintStatistics(), SCIPcollectCutselectorStatistics(), SCIPcollectExpressionHandlerStatistics(), SCIPcollectHeuristicStatistics(), SCIPcollectLPStatistics(), SCIPcollectNLPIStatistics(), SCIPcollectNLPStatistics(), SCIPcollectPresolverStatistics(), SCIPcollectPropagatorStatistics(), SCIPcollectRelaxatorStatistics(), SCIPcollectRootStatistics(), SCIPcollectSeparatorStatistics(), SCIPcollectSolutionStatistics(), SCIPcollectTransProblemStatistics(), SCIPcollectTreeStatistics(), and SCIPnlhdlrCollectStatistics().
◆ SCIPinsertDatatreeReal()
| SCIP_RETCODE SCIPinsertDatatreeReal | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| SCIP_Real | value | ||
| ) |
inserts a SCIP_Real value into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add value value to add
Definition at line 136 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertReal().
Referenced by collectDivingHeurStatistics(), collectNeighborhoodStatistics(), SCIP_DECL_TABLECOLLECT(), SCIPcollectBendersStatistics(), SCIPcollectBranchingStatistics(), SCIPcollectBranchruleStatistics(), SCIPcollectCompressionStatistics(), SCIPcollectConcsolverStatistics(), SCIPcollectConflictStatistics(), SCIPcollectConstraintTimingStatistics(), SCIPcollectCutselectorStatistics(), SCIPcollectExpressionHandlerStatistics(), SCIPcollectHeuristicStatistics(), SCIPcollectLPStatistics(), SCIPcollectNLPIStatistics(), SCIPcollectNLPStatistics(), SCIPcollectPresolverStatistics(), SCIPcollectPricerStatistics(), SCIPcollectPropagatorStatistics(), SCIPcollectRelaxatorStatistics(), SCIPcollectRootStatistics(), SCIPcollectSeparatorStatistics(), SCIPcollectSolutionStatistics(), SCIPcollectTimingStatistics(), SCIPcollectTreeStatistics(), and SCIPnlhdlrCollectStatistics().
◆ SCIPinsertDatatreeString()
| SCIP_RETCODE SCIPinsertDatatreeString | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| const char * | value | ||
| ) |
inserts a string value into a SCIP_DATATREE object
The string value will be copied.
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add value value to add
Definition at line 156 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertString().
Referenced by SCIPcollectBendersStatistics(), SCIPcollectBranchingStatistics(), SCIPcollectBranchruleStatistics(), SCIPcollectCompressionStatistics(), SCIPcollectConstraintStatistics(), SCIPcollectCutselectorStatistics(), SCIPcollectExpressionHandlerStatistics(), SCIPcollectHeuristicStatistics(), SCIPcollectNLPIStatistics(), SCIPcollectNLPStatistics(), SCIPcollectPresolverStatistics(), SCIPcollectPropagatorStatistics(), SCIPcollectSeparatorStatistics(), SCIPcollectSolutionStatistics(), SCIPcollectStatusStatistics(), SCIPnlhdlrCollectStatistics(), and SCIPtableCollect().
◆ SCIPinsertDatatreeBoolArray()
| SCIP_RETCODE SCIPinsertDatatreeBoolArray | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| const SCIP_Bool * | values, | ||
| int | nvalues | ||
| ) |
inserts a SCIP_Bool array into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add values values of entry nvalues number of values
Definition at line 174 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertBoolArray().
◆ SCIPinsertDatatreeIntArray()
| SCIP_RETCODE SCIPinsertDatatreeIntArray | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| const int * | values, | ||
| int | nvalues | ||
| ) |
inserts an int array into a SCIP_DATATREE object
The value will be stored as array of SCIP_Longint.
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add values values of entry nvalues number of values
Definition at line 197 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_Longint, SCIP_OKAY, SCIPallocBufferArray, SCIPdatatreeInsertLongArray(), and SCIPfreeBufferArray.
◆ SCIPinsertDatatreeLongArray()
| SCIP_RETCODE SCIPinsertDatatreeLongArray | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| const SCIP_Longint * | values, | ||
| int | nvalues | ||
| ) |
inserts a SCIP_Longint array into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add values values of entry nvalues number of values
Definition at line 246 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertLongArray().
◆ SCIPinsertDatatreeRealArray()
| SCIP_RETCODE SCIPinsertDatatreeRealArray | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| const SCIP_Real * | values, | ||
| int | nvalues | ||
| ) |
inserts a SCIP_Real array into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add values values of entry nvalues number of values
Definition at line 226 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertRealArray().
◆ SCIPinsertDatatreeStringArray()
| SCIP_RETCODE SCIPinsertDatatreeStringArray | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| const char *const * | values, | ||
| int | nvalues | ||
| ) |
inserts a string array into a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add values values of entry nvalues number of values
Definition at line 266 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertStringArray().
◆ SCIPinsertDatatreeTree()
| SCIP_RETCODE SCIPinsertDatatreeTree | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| const char * | name, | ||
| SCIP_DATATREE * | value | ||
| ) |
inserts a data tree value into a SCIP_DATATREE object
The data tree assumes ownership of value.
- Parameters
-
scip SCIP data structure datatree data tree name name of entry to add value value to add
Definition at line 289 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeInsertTree().
◆ SCIPfreeDatatree()
| void SCIPfreeDatatree | ( | SCIP * | scip, |
| SCIP_DATATREE ** | datatree | ||
| ) |
frees a SCIP_DATATREE object
- Parameters
-
scip SCIP data structure datatree pointer to data tree to free
Definition at line 307 of file scip_datatree.c.
References NULL, and SCIPdatatreeFree().
Referenced by scip::SCIP_DECL_TABLEOUTPUT(), and SCIPprintStatisticsJson().
◆ SCIPwriteDatatreeJson()
| SCIP_RETCODE SCIPwriteDatatreeJson | ( | SCIP * | scip, |
| FILE * | file, | ||
| SCIP_DATATREE * | datatree | ||
| ) |
writes a SCIP_DATATREE object as JSON to a file
- Parameters
-
scip SCIP data structure file file to write to, or NULL for stdout datatree data tree to write
Definition at line 319 of file scip_datatree.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdatatreeWriteJson().
Referenced by SCIPprintStatisticsJson().
◆ SCIPprintDatatreeAsTable()
| SCIP_RETCODE SCIPprintDatatreeAsTable | ( | SCIP * | scip, |
| SCIP_DATATREE * | datatree, | ||
| FILE * | file, | ||
| const char * | sectionname, | ||
| const char * | tablename | ||
| ) |
prints a generic table from a data store
prints a generic table from a data tree
- Parameters
-
scip SCIP data structure datatree data tree file output file sectionname section name to process, e.g., "plugins" tablename table name to process, e.g., "heuristics"
Definition at line 333 of file scip_datatree.c.
References SCIP_Datatree::items, SCIP_DATATREEITEM::name, SCIP_Datatree::nitems, NULL, SCIP_Bool, SCIP_CALL, SCIP_DATATREE_BOOL, SCIP_DATATREE_BOOLARRAY, SCIP_DATATREE_DATATREE, SCIP_DATATREE_LONG, SCIP_DATATREE_LONGARRAY, SCIP_DATATREE_REAL, SCIP_DATATREE_REALARRAY, SCIP_DATATREE_STRING, SCIP_DATATREE_STRINGARRAY, SCIP_Longint, SCIP_LONGINT_FORMAT, SCIP_OKAY, SCIP_Real, SCIPdatatreeGetBool(), SCIPdatatreeGetLong(), SCIPdatatreeGetReal(), SCIPdatatreeGetString(), SCIPdatatreeGetTree(), SCIPinfoMessage(), SCIPwarningMessage(), SCIP_DATATREEVALUE::type, and SCIP_DATATREEITEM::value.
Referenced by scip::SCIP_DECL_TABLEOUTPUT(), and SCIPtableOutput().