/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* 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 pricer.h * @ingroup INTERNALAPI * @brief internal methods for variable pricers * @author Tobias Achterberg */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_PRICER_H__ #define __SCIP_PRICER_H__ #include "scip/def.h" #include "blockmemshell/memory.h" #include "scip/type_retcode.h" #include "scip/type_result.h" #include "scip/type_set.h" #include "scip/type_lp.h" #include "scip/type_prob.h" #include "scip/type_pricestore.h" #include "scip/type_pricer.h" #include "scip/pub_pricer.h" #ifdef __cplusplus extern "C" { #endif /** copies the given pricer to a new scip */ SCIP_RETCODE SCIPpricerCopyInclude( SCIP_PRICER* pricer, /**< pricer */ SCIP_SET* set, /**< SCIP_SET of SCIP to copy to */ SCIP_Bool* valid /**< was the copying process valid? */ ); /** creates a variable pricer */ SCIP_RETCODE SCIPpricerCreate( SCIP_PRICER** pricer, /**< pointer to variable pricer data structure */ SCIP_SET* set, /**< global SCIP settings */ SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */ BMS_BLKMEM* blkmem, /**< block memory for parameter settings */ const char* name, /**< name of variable pricer */ const char* desc, /**< description of variable pricer */ int priority, /**< priority of the variable pricer */ SCIP_Bool delay, /**< should the pricer be delayed until no other pricers or already existing * problem variables with negative reduced costs are found */ SCIP_DECL_PRICERCOPY ((*pricercopy)), /**< copy method of pricer or NULL if you don't want to copy your plugin into sub-SCIPs */ SCIP_DECL_PRICERFREE ((*pricerfree)), /**< destructor of variable pricer */ SCIP_DECL_PRICERINIT ((*pricerinit)), /**< initialize variable pricer */ SCIP_DECL_PRICEREXIT ((*pricerexit)), /**< deinitialize variable pricer */ SCIP_DECL_PRICERINITSOL((*pricerinitsol)),/**< solving process initialization method of variable pricer */ SCIP_DECL_PRICEREXITSOL((*pricerexitsol)),/**< solving process deinitialization method of variable pricer */ SCIP_DECL_PRICERREDCOST((*pricerredcost)),/**< reduced cost pricing method of variable pricer for feasible LPs */ SCIP_DECL_PRICERFARKAS((*pricerfarkas)), /**< Farkas pricing method of variable pricer for infeasible LPs */ SCIP_PRICERDATA* pricerdata /**< variable pricer data */ ); /** calls destructor and frees memory of variable pricer */ SCIP_RETCODE SCIPpricerFree( SCIP_PRICER** pricer, /**< pointer to variable pricer data structure */ SCIP_SET* set /**< global SCIP settings */ ); /** initializes variable pricer */ SCIP_RETCODE SCIPpricerInit( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set /**< global SCIP settings */ ); /** calls exit method of variable pricer */ SCIP_RETCODE SCIPpricerExit( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set /**< global SCIP settings */ ); /** informs variable pricer that the branch and bound process is being started */ SCIP_RETCODE SCIPpricerInitsol( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set /**< global SCIP settings */ ); /** informs variable pricer that the branch and bound process data is being freed */ SCIP_RETCODE SCIPpricerExitsol( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set /**< global SCIP settings */ ); /** activates pricer such that it is called in LP solving loop */ SCIP_RETCODE SCIPpricerActivate( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set /**< global SCIP settings */ ); /** deactivates pricer such that it is no longer called in LP solving loop */ SCIP_RETCODE SCIPpricerDeactivate( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set /**< global SCIP settings */ ); /** enables or disables all clocks of \p pricer, depending on the value of the flag */ void SCIPpricerEnableOrDisableClocks( SCIP_PRICER* pricer, /**< the pricer for which all clocks should be enabled or disabled */ SCIP_Bool enable /**< should the clocks of the pricer be enabled? */ ); /** calls reduced cost pricing method of variable pricer */ SCIP_RETCODE SCIPpricerRedcost( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set, /**< global SCIP settings */ SCIP_PROB* prob, /**< transformed problem */ SCIP_Real* lowerbound, /**< local lower bound computed by the pricer */ SCIP_Bool* stopearly, /**< should pricing be stopped, although new variables were added? */ SCIP_RESULT* result /**< result of the pricing process */ ); /** calls Farkas pricing method of variable pricer */ SCIP_RETCODE SCIPpricerFarkas( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set, /**< global SCIP settings */ SCIP_PROB* prob, /**< transformed problem */ SCIP_RESULT* result /**< result of the pricing process */ ); /** depending on the LP's solution status, calls reduced cost or Farkas pricing method of variable pricer */ SCIP_RETCODE SCIPpricerExec( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set, /**< global SCIP settings */ SCIP_PROB* prob, /**< transformed problem */ SCIP_LP* lp, /**< LP data */ SCIP_PRICESTORE* pricestore, /**< pricing storage */ SCIP_Real* lowerbound, /**< local lower bound computed by the pricer */ SCIP_Bool* stopearly, /**< should pricing be stopped, although new variables were added? */ SCIP_RESULT* result /**< result of the pricing process */ ); /** sets priority of variable pricer */ void SCIPpricerSetPriority( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_SET* set, /**< global SCIP settings */ int priority /**< new priority of the variable pricer */ ); /** sets copy callback of pricer */ void SCIPpricerSetCopy( SCIP_PRICER* pricer, /**< variable pricer */ SCIP_DECL_PRICERCOPY ((*pricercopy)) /**< copy callback of pricer */ ); /** sets destructor callback of pricer */ void SCIPpricerSetFree( SCIP_PRICER* pricer, /**< pricer */ SCIP_DECL_PRICERFREE ((*pricerfree)) /**< destructor of pricer */ ); /** sets initialization callback of pricer */ void SCIPpricerSetInit( SCIP_PRICER* pricer, /**< pricer */ SCIP_DECL_PRICERINIT ((*pricerinit)) /**< initialize pricer */ ); /** sets deinitialization callback of pricer */ void SCIPpricerSetExit( SCIP_PRICER* pricer, /**< pricer */ SCIP_DECL_PRICEREXIT ((*pricerexit)) /**< deinitialize pricer */ ); /** sets solving process initialization callback of pricer */ void SCIPpricerSetInitsol( SCIP_PRICER* pricer, /**< pricer */ SCIP_DECL_PRICERINITSOL ((*pricerinitsol))/**< solving process initialization callback of pricer */ ); /** sets solving process deinitialization callback of pricer */ void SCIPpricerSetExitsol( SCIP_PRICER* pricer, /**< pricer */ SCIP_DECL_PRICEREXITSOL ((*pricerexitsol))/**< solving process deinitialization callback of pricer */ ); #ifdef __cplusplus } #endif #endif