/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* 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 pub_nlhdlr.h * @brief public functions of nonlinear handlers of nonlinear constraints * @ingroup PUBLICCOREAPI * @author Ksenia Bestuzheva * @author Benjamin Mueller * @author Felipe Serrano * @author Stefan Vigerske */ #ifndef SCIP_PUB_NLHDLR_H_ #define SCIP_PUB_NLHDLR_H_ #include "scip/def.h" #include "scip/type_scip.h" #include "scip/type_nlhdlr.h" #ifdef NDEBUG #include "scip/struct_nlhdlr.h" #endif #ifdef __cplusplus extern "C" { #endif /**@addtogroup PublicNlhdlrInterfaceMethods * @{ */ /** sets the copy handler callback of a nonlinear handler */ SCIP_EXPORT void SCIPnlhdlrSetCopyHdlr( SCIP_NLHDLR* nlhdlr, /**< nonlinear handler */ SCIP_DECL_NLHDLRCOPYHDLR((*copy)) /**< copy callback (can be NULL) */ ); /** sets the nonlinear handler callback to free the nonlinear handler data */ SCIP_EXPORT void SCIPnlhdlrSetFreeHdlrData( SCIP_NLHDLR* nlhdlr, /**< nonlinear handler */ SCIP_DECL_NLHDLRFREEHDLRDATA((*freehdlrdata)) /**< handler free callback (can be NULL) */ ); /** sets the nonlinear handler callback to free expression specific data of nonlinear handler */ SCIP_EXPORT void SCIPnlhdlrSetFreeExprData( SCIP_NLHDLR* nlhdlr, /**< nonlinear handler */ SCIP_DECL_NLHDLRFREEEXPRDATA((*freeexprdata)) /**< nonlinear handler expression data free callback (can be NULL if data does not need to be freed) */ ); /** sets the initialization and deinitialization callback of a nonlinear handler */ SCIP_EXPORT void SCIPnlhdlrSetInitExit( SCIP_NLHDLR* nlhdlr, /**< nonlinear handler */ SCIP_DECL_NLHDLRINIT((*init)), /**< initialization callback (can be NULL) */ SCIP_DECL_NLHDLREXIT((*exit)) /**< deinitialization callback (can be NULL) */ ); /** sets the propagation callbacks of a nonlinear handler */ SCIP_EXPORT void SCIPnlhdlrSetProp( SCIP_NLHDLR* nlhdlr, /**< nonlinear handler */ SCIP_DECL_NLHDLRINTEVAL((*inteval)), /**< interval evaluation callback (can be NULL) */ SCIP_DECL_NLHDLRREVERSEPROP((*reverseprop)) /**< reverse propagation callback (can be NULL) */ ); /** sets the enforcement callbacks of a nonlinear handler */ SCIP_EXPORT void SCIPnlhdlrSetSepa( SCIP_NLHDLR* nlhdlr, /**< nonlinear handler */ SCIP_DECL_NLHDLRINITSEPA((*initsepa)), /**< separation initialization callback (can be NULL) */ SCIP_DECL_NLHDLRENFO((*enfo)), /**< enforcement callback (can be NULL if estimate is not NULL) */ SCIP_DECL_NLHDLRESTIMATE((*estimate)), /**< estimation callback (can be NULL if sepa is not NULL) */ SCIP_DECL_NLHDLREXITSEPA((*exitsepa)) /**< separation deinitialization callback (can be NULL) */ ); /** gives name of nonlinear handler */ SCIP_EXPORT const char* SCIPnlhdlrGetName( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** gives description of nonlinear handler, can be NULL */ SCIP_EXPORT const char* SCIPnlhdlrGetDesc( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** gives detection priority of nonlinear handler */ SCIP_EXPORT int SCIPnlhdlrGetDetectPriority( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** gives enforcement priority of nonlinear handler */ SCIP_EXPORT int SCIPnlhdlrGetEnfoPriority( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler is enabled */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrIsEnabled( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** gives handler data of nonlinear handler */ SCIP_EXPORT SCIP_NLHDLRDATA* SCIPnlhdlrGetData( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler implements the interval evaluation callback */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrHasIntEval( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler implements the reverse propagation callback */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrHasReverseProp( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler implements the separation initialization callback */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrHasInitSepa( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler implements the separation deinitialization callback */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrHasExitSepa( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler implements the enforcement callback */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrHasEnfo( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** returns whether nonlinear handler implements the estimator callback */ SCIP_EXPORT SCIP_Bool SCIPnlhdlrHasEstimate( SCIP_NLHDLR* nlhdlr /**< nonlinear handler */ ); /** compares two nonlinear handlers by detection priority * * if handlers have same detection priority, then compare by name */ SCIP_DECL_SORTPTRCOMP(SCIPnlhdlrComp); #ifdef NDEBUG /* If NDEBUG is defined, the function calls are overwritten by defines to reduce the number of function calls and * speed up the algorithms. */ #define SCIPnlhdlrSetCopyHdlr(nlhdlr, copy) (nlhdlr)->copyhdlr = copy #define SCIPnlhdlrSetFreeHdlrData(nlhdlr, freehdlrdata_) (nlhdlr)->freehdlrdata = freehdlrdata_ #define SCIPnlhdlrSetFreeExprData(nlhdlr, freeexprdata_) (nlhdlr)->freeexprdata = freeexprdata_ #define SCIPnlhdlrSetInitExit(nlhdlr, init_, exit_) do { (nlhdlr)->init = init_; nlhdlr->exit = exit_; } while (FALSE) #define SCIPnlhdlrSetProp(nlhdlr, inteval_, reverseprop_) do { (nlhdlr)->inteval = inteval_; nlhdlr->reverseprop = reverseprop_; } while (FALSE) #define SCIPnlhdlrSetSepa(nlhdlr, initsepa_, enfo_, estimate_, exitsepa_) do { (nlhdlr)->initsepa = initsepa_; (nlhdlr)->enfo = enfo_; (nlhdlr)->estimate = estimate_; (nlhdlr)->exitsepa = exitsepa_; } while (FALSE); #define SCIPnlhdlrGetName(nlhdlr) (nlhdlr)->name #define SCIPnlhdlrGetDesc(nlhdlr) (nlhdlr)->desc #define SCIPnlhdlrGetDetectPriority(nlhdlr) (nlhdlr)->detectpriority #define SCIPnlhdlrGetEnfoPriority(nlhdlr) (nlhdlr)->enfopriority #define SCIPnlhdlrIsEnabled(nlhdlr) (nlhdlr)->enabled #define SCIPnlhdlrGetData(nlhdlr) (nlhdlr)->data #define SCIPnlhdlrHasIntEval(nlhdlr) ((nlhdlr)->inteval != NULL) #define SCIPnlhdlrHasReverseProp(nlhdlr) ((nlhdlr)->reverseprop != NULL) #define SCIPnlhdlrHasInitSepa(nlhdlr) ((nlhdlr)->initsepa != NULL) #define SCIPnlhdlrHasExitSepa(nlhdlr) ((nlhdlr)->exitsepa != NULL) #define SCIPnlhdlrHasEnfo(nlhdlr) ((nlhdlr)->enfo != NULL) #define SCIPnlhdlrHasEstimate(nlhdlr) ((nlhdlr)->estimate != NULL) #endif /** @} */ #ifdef __cplusplus } #endif #endif /* SCIP_PUB_NLHDLR_H_ */