/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* This file is part of the program and library */ /* SCIP --- Solving Constraint Integer Programs */ /* */ /* Copyright 2002-2022 Zuse Institute Berlin */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ /* You may obtain a copy of the License at */ /* */ /* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ /* Unless required by applicable law or agreed to in writing, software */ /* distributed under the License is distributed on an "AS IS" BASIS, */ /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ /* See the License for the specific language governing permissions and */ /* limitations under the License. */ /* */ /* You should have received a copy of the Apache-2.0 license */ /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /**@file struct_branch.h * @ingroup INTERNALAPI * @brief datastructures for branching rules and branching candidate storage * @author Tobias Achterberg */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_STRUCT_BRANCH_H__ #define __SCIP_STRUCT_BRANCH_H__ #include "scip/def.h" #include "scip/type_var.h" #include "scip/type_branch.h" #ifdef __cplusplus extern "C" { #endif /** branching candidate storage */ struct SCIP_BranchCand { SCIP_VAR** lpcands; /**< candidates for branching on LP solution (fractional integer variables) */ SCIP_Real* lpcandssol; /**< solution values of LP candidates */ SCIP_Real* lpcandsfrac; /**< fractionalities of LP candidates */ SCIP_VAR** externcands; /**< external candidates for branching, e.g. given by relaxation */ SCIP_Real* externcandsscore; /**< scores of external candidates, e.g. infeasibilities */ SCIP_Real* externcandssol; /**< values in solution of external candidates */ SCIP_VAR** pseudocands; /**< candidates for branching on pseudo solution (non-fixed integer variables) */ SCIP_Longint validlpcandslp; /**< lp number for which lpcands are valid */ int lpcandssize; /**< number of available slots in lpcands array */ int nlpcands; /**< number of candidates for branching on LP solution */ int npriolpcands; /**< number of LP candidates with largest branch priority value */ int npriolpbins; /**< number of binary LP candidates with largest branch priority value */ int nimpllpfracs; /**< number of implicit variables with fractional LP solution value */ int lpmaxpriority; /**< maximal branch priority of all LP candidates */ int externcandssize; /**< number of available slots in externcands array */ int nexterncands; /**< number of external candidates for branching */ int nprioexterncands; /**< number of external candidates with largest branch priority value */ int nprioexternbins; /**< number of binary external candidates with largest branch priority value */ int nprioexternints; /**< number of integer external candidates with largest branch priority value */ int nprioexternimpls; /**< number of implicit integer external candidates with largest branch priority value */ int externmaxpriority; /**< maximal branch priority of all external candidates */ int pseudocandssize; /**< number of available slots in pseudocands array */ int npseudocands; /**< number of candidates for branching on pseudo solution */ int npriopseudocands; /**< number of pseudo candidates with largest branch priority value */ int npriopseudobins; /**< number of binary pseudo candidates with largest branch priority value */ int npriopseudoints; /**< number of integer pseudo candidates with largest branch priority value */ int pseudomaxpriority; /**< maximal branch priority of all pseudo candidates */ }; /** branching rule */ struct SCIP_Branchrule { SCIP_Real maxbounddist; /**< maximal relative distance from current node's dual bound to primal bound * compared to best node's dual bound for applying branching rule * (0.0: only on current best node, 1.0: on all nodes) */ SCIP_Longint nlpcalls; /**< number of times, this branching rule was called on an LP solution */ SCIP_Longint nexterncalls; /**< number of times, this branching rule was called on external candidates */ SCIP_Longint npseudocalls; /**< number of times, this branching rule was called on a pseudo solution */ SCIP_Longint ncutoffs; /**< number of cutoffs found so far by this branching rule */ SCIP_Longint ncutsfound; /**< number of cutting planes found so far by this branching rule */ SCIP_Longint nconssfound; /**< number of cutting constraints added so far by this branching rule (not * counting constraint additions to child nodes used for branching) */ SCIP_Longint ndomredsfound; /**< number of domain reductions found so far by this branching rule */ SCIP_Longint nchildren; /**< number of children created so far by this branching rule */ char* name; /**< name of branching rule */ char* desc; /**< description of branching rule */ SCIP_DECL_BRANCHCOPY ((*branchcopy)); /**< copy method of branching rule or NULL if you don't want to copy your plugin into sub-SCIPs */ SCIP_DECL_BRANCHFREE ((*branchfree)); /**< destructor of branching rule */ SCIP_DECL_BRANCHINIT ((*branchinit)); /**< initialize branching rule */ SCIP_DECL_BRANCHEXIT ((*branchexit)); /**< deinitialize branching rule */ SCIP_DECL_BRANCHINITSOL((*branchinitsol));/**< solving process initialization method of branching rule */ SCIP_DECL_BRANCHEXITSOL((*branchexitsol));/**< solving process deinitialization method of branching rule */ SCIP_DECL_BRANCHEXECLP((*branchexeclp)); /**< branching execution method for fractional LP solutions */ SCIP_DECL_BRANCHEXECEXT((*branchexecext));/**< branching execution method for external candidates */ SCIP_DECL_BRANCHEXECPS((*branchexecps)); /**< branching execution method for not completely fixed pseudo solutions */ SCIP_BRANCHRULEDATA* branchruledata; /**< branching rule data */ SCIP_CLOCK* setuptime; /**< time spend for setting up this branchrule for the next stages */ SCIP_CLOCK* branchclock; /**< branching rule execution time */ int priority; /**< priority of the branching rule */ int maxdepth; /**< maximal depth level, up to which this branching rule should be used (or -1) */ SCIP_Bool initialized; /**< is branching rule initialized? */ SCIP_Bool isobjbranchrule; /**< is branching rule an obj branching rule? */ }; #ifdef __cplusplus } #endif #endif