/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* 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 relax.h * @ingroup INTERNALAPI * @brief internal methods for relaxators * @author Tobias Achterberg */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_RELAX_H__ #define __SCIP_RELAX_H__ #include "scip/def.h" #include "blockmemshell/memory.h" #include "scip/type_primal.h" #include "scip/type_relax.h" #include "scip/type_result.h" #include "scip/type_retcode.h" #include "scip/type_set.h" #include "scip/type_sol.h" #include "scip/type_stat.h" #include "scip/type_tree.h" #include "scip/type_var.h" #include "scip/pub_relax.h" #ifdef __cplusplus extern "C" { #endif /** copies the given relaxator to a new scip */ SCIP_RETCODE SCIPrelaxCopyInclude( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set /**< SCIP_SET of SCIP to copy to */ ); /** creates a relaxator */ SCIP_RETCODE SCIPrelaxCreate( SCIP_RELAX** relax, /**< pointer to relaxator 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 relaxator */ const char* desc, /**< description of relaxator */ int priority, /**< priority of the relaxator (negative: after LP, non-negative: before LP) */ int freq, /**< frequency for calling relaxator */ SCIP_DECL_RELAXCOPY ((*relaxcopy)), /**< copy method of relaxator or NULL if you don't want to copy your plugin into sub-SCIPs */ SCIP_DECL_RELAXFREE ((*relaxfree)), /**< destructor of relaxator */ SCIP_DECL_RELAXINIT ((*relaxinit)), /**< initialize relaxator */ SCIP_DECL_RELAXEXIT ((*relaxexit)), /**< deinitialize relaxator */ SCIP_DECL_RELAXINITSOL((*relaxinitsol)), /**< solving process initialization method of relaxator */ SCIP_DECL_RELAXEXITSOL((*relaxexitsol)), /**< solving process deinitialization method of relaxator */ SCIP_DECL_RELAXEXEC ((*relaxexec)), /**< execution method of relaxator */ SCIP_RELAXDATA* relaxdata /**< relaxator data */ ); /** calls destructor and frees memory of relaxator */ SCIP_RETCODE SCIPrelaxFree( SCIP_RELAX** relax, /**< pointer to relaxator data structure */ SCIP_SET* set /**< global SCIP settings */ ); /** initializes relaxator */ SCIP_RETCODE SCIPrelaxInit( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set /**< global SCIP settings */ ); /** calls exit method of relaxator */ SCIP_RETCODE SCIPrelaxExit( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set /**< global SCIP settings */ ); /** informs relaxator that the branch and bound process is being started */ SCIP_RETCODE SCIPrelaxInitsol( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set /**< global SCIP settings */ ); /** informs relaxator that the branch and bound process data is being freed */ SCIP_RETCODE SCIPrelaxExitsol( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set /**< global SCIP settings */ ); /** calls execution method of relaxator */ SCIP_RETCODE SCIPrelaxExec( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set, /**< global SCIP settings */ SCIP_TREE* tree, /**< branch and bound tree */ SCIP_STAT* stat, /**< dynamic problem statistics */ int depth, /**< depth of current node */ SCIP_Real* lowerbound, /**< pointer to lower bound computed by the relaxator */ SCIP_RESULT* result /**< pointer to store the result of the callback method */ ); /** sets priority of relaxator */ void SCIPrelaxSetPriority( SCIP_RELAX* relax, /**< relaxator */ SCIP_SET* set, /**< global SCIP settings */ int priority /**< new priority of the relaxator */ ); /** set copy callback of relaxation handler */ void SCIPrelaxSetCopy( SCIP_RELAX* relax, /**< relaxation handler */ SCIP_DECL_RELAXCOPY ((*relaxcopy)) /**< copy method of relaxation handler */ ); /** set destructor callback of relaxation handler */ void SCIPrelaxSetFree( SCIP_RELAX* relax, /**< relaxation handler */ SCIP_DECL_RELAXFREE ((*relaxfree)) /**< destructor of relaxation handler */ ); /** set initialization callback of relaxation handler */ void SCIPrelaxSetInit( SCIP_RELAX* relax, /**< relaxation handler */ SCIP_DECL_RELAXINIT ((*relaxinit)) /**< initialize relaxation handler */ ); /** set deinitialization callback of relaxation handler */ void SCIPrelaxSetExit( SCIP_RELAX* relax, /**< relaxation handler */ SCIP_DECL_RELAXEXIT ((*relaxexit)) /**< deinitialize relaxation handler */ ); /** set solving process initialization callback of relaxation handler */ void SCIPrelaxSetInitsol( SCIP_RELAX* relax, /**< relaxation handler */ SCIP_DECL_RELAXINITSOL((*relaxinitsol)) /**< solving process initialization method of relaxation handler */ ); /** set solving process deinitialization callback of relaxation handler */ void SCIPrelaxSetExitsol( SCIP_RELAX* relax, /**< relaxation handler */ SCIP_DECL_RELAXEXITSOL((*relaxexitsol)) /**< solving process deinitialization callback relaxation handler */ ); /** returns whether the relaxation was completely solved at the current node */ SCIP_Bool SCIPrelaxIsSolved( SCIP_RELAX* relax, /**< relaxator */ SCIP_STAT* stat /**< dynamic problem statistics */ ); /* * methods for the global relaxation data */ /** enables or disables all clocks of \p relax, depending on the value of the flag */ void SCIPrelaxEnableOrDisableClocks( SCIP_RELAX* relax, /**< the relaxation handler for which all clocks should be enabled or disabled */ SCIP_Bool enable /**< should the clocks of the relaxation handler be enabled? */ ); /** creates global relaxation data */ SCIP_RETCODE SCIPrelaxationCreate( SCIP_RELAXATION** relaxation, /**< global relaxation data */ BMS_BLKMEM* blkmem, /**< block memory */ SCIP_SET* set, /**< global SCIP settings */ SCIP_STAT* stat, /**< problem statistics data */ SCIP_PRIMAL* primal, /**< primal data */ SCIP_TREE* tree /**< branch and bound tree */ ); /** frees global relaxation data */ SCIP_RETCODE SCIPrelaxationFree( SCIP_RELAXATION** relaxation /**< global relaxation data */ ); /** sets the relaxsolzero flag in the relaxation data to the given value */ void SCIPrelaxationSetSolZero( SCIP_RELAXATION* relaxation, /**< global relaxation data */ SCIP_Bool iszero /**< are all values of the relaxation solution set to zero? */ ); /** returns whether the global relaxation solution is cleared and all values are set to zero */ SCIP_Bool SCIPrelaxationIsSolZero( SCIP_RELAXATION* relaxation /**< global relaxation data */ ); /** sets the relaxsolvalid and includeslp flags in the relaxation data to the given values */ void SCIPrelaxationSetSolValid( SCIP_RELAXATION* relaxation, /**< global relaxation data */ SCIP_Bool isvalid, /**< is the stored solution valid? */ SCIP_Bool includeslp /**< does the relaxator contain all cuts in the LP? */ ); /** returns whether the global relaxation solution is valid */ SCIP_Bool SCIPrelaxationIsSolValid( SCIP_RELAXATION* relaxation /**< global relaxation data */ ); /** returns whether the global relaxation solution was computed by a relaxator which included all LP cuts */ SCIP_Bool SCIPrelaxationIsLpIncludedForSol( SCIP_RELAXATION* relaxation /**< global relaxation data */ ); /** sets the objective value of the global relaxation solution */ void SCIPrelaxationSetSolObj( SCIP_RELAXATION* relaxation, /**< global relaxation data */ SCIP_Real obj /**< objective value */ ); /** returns the objective value of the global relaxation solution w.r.t. the transformed problem */ SCIP_Real SCIPrelaxationGetSolObj( SCIP_RELAXATION* relaxation /**< global relaxation data */ ); /** adds the given value to the global relaxation solution's objective value */ void SCIPrelaxationSolObjAdd( SCIP_RELAXATION* relaxation, /**< global relaxation data */ SCIP_Real val /**< value to add to the objective value */ ); /** updates objective value of current relaxation solution after change of objective coefficient */ void SCIPrelaxationUpdateVarObj( SCIP_RELAXATION* relaxation, /**< global relaxation data */ SCIP_SET* set, /**< global SCIP settings */ SCIP_VAR* var, /**< variable with changed objective coefficient */ SCIP_Real oldobj, /**< old objective coefficient */ SCIP_Real newobj /**< new objective coefficient */ ); /** store the most recent relaxation handler \p relax responsible for the solution */ void SCIPrelaxationSetSolRelax( SCIP_RELAXATION* relaxation, /**< global relaxation data */ SCIP_RELAX* relax /**< relaxation handler responsible for the most recent relaxation solution */ ); /** returns the most recent relaxation handler responsible for the solution, or NULL if unspecified */ SCIP_RELAX* SCIPrelaxationGetSolRelax( SCIP_RELAXATION* relaxation /**< global relaxation data */ ); #ifdef __cplusplus } #endif #endif