pub_iisfinder.h

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/*                  This file is part of the program and library             */
/*         SCIP --- Solving Constraint Integer Programs                      */
/*                                                                           */
/*  Copyright (c) 2002-2026 Zuse Institute Berlin (ZIB)                      */
/*                                                                           */
/*  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_iisfinder.h
 * @ingroup PUBLICCOREAPI
 * @brief  public methods for irreducible infeasible subsystems (IIS) finders
 * @author Mark Turner
 */
 
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
 
#ifndef __SCIP_PUB_IISFINDER_H__
#define __SCIP_PUB_IISFINDER_H__
 
 
#include "scip/def.h"
#include "scip/type_misc.h"
#include "scip/type_iisfinder.h"
#include "scip/type_cons.h"
#include "scip/type_var.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**@addtogroup PublicIISfinderMethods
 *
 * @{
 */
 
/** gets name of IIS finder */
SCIP_EXPORT
const char* SCIPiisfinderGetName(
   SCIP_IISFINDER*       iisfinder           /**< IIS finder */
   );
 
/** gets user data of IIS finder */
SCIP_EXPORT
SCIP_IISFINDERDATA* SCIPiisfinderGetData(
   SCIP_IISFINDER*       iisfinder           /**< IIS finder */
   );
 
/** gets description of IIS finder */
SCIP_EXPORT
const char* SCIPiisfinderGetDesc(
   SCIP_IISFINDER*       iisfinder           /**< IIS finder */
   );
 
/** gets priority of IIS finder */
SCIP_EXPORT
int SCIPiisfinderGetPriority(
   SCIP_IISFINDER*       iisfinder           /**< IIS finder */
   );
 
/** sets user data of IIS finder; user has to free old data in advance! */
SCIP_EXPORT
void SCIPiisfinderSetData(
   SCIP_IISFINDER*       iisfinder,          /**< IIS finder */
   SCIP_IISFINDERDATA*   iisfinderdata       /**< new IIS finder user data */
   );
 
/** gets time in seconds used in this IIS finder */
SCIP_EXPORT
SCIP_Real SCIPiisfinderGetTime(
   SCIP_IISFINDER*       iisfinder           /**< IIS finder */
   );
 
/** prints output line during IIS calculations */
SCIP_EXPORT
void SCIPiisfinderInfoMessage(
   SCIP_IIS*             iis,                /**< pointer to the IIS */
   SCIP_Bool             printheaders        /**< whether the headers should be printed instead of the info */
   );
 
/**@}
 *
 * @addtogroup PublicInfeasibilityAnalysisMethods
 *
 * @{
 */
 
/** gets time in seconds used in the IIS calculations */
SCIP_EXPORT
SCIP_Real SCIPiisGetTime(
   SCIP_IIS*             iis                 /**< IIS */
   );
 
/** Gets whether the IIS subscip is currently infeasible. */
SCIP_EXPORT
SCIP_Bool SCIPiisIsSubscipInfeasible(
   SCIP_IIS*             iis                 /**< IIS data structure */
   );
 
/** Gets whether the IIS subscip is irreducible. */
SCIP_EXPORT
SCIP_Bool SCIPiisIsSubscipIrreducible(
   SCIP_IIS*             iis                 /**< IIS data structure */
   );
 
/** Gets the number of nodes in the IIS solve. */
SCIP_EXPORT
SCIP_Longint SCIPiisGetNNodes(
   SCIP_IIS*             iis                 /**< IIS data structure */
   );
 
/** Sets the flag that states whether the IIS subscip is currently infeasible. */
SCIP_EXPORT
void SCIPiisSetSubscipInfeasible(
   SCIP_IIS*             iis,                /**< IIS data structure */
   SCIP_Bool             infeasible          /**< The new infeasibility status of the IIS */
   );
 
/** Sets the flag that states whether the IIS subscip is irreducible. */
SCIP_EXPORT
void SCIPiisSetSubscipIrreducible(
   SCIP_IIS*             iis,                /**< IIS data structure */
   SCIP_Bool             irreducible         /**< The new irreducible status of the IIS */
   );
 
/** Increments the number of nodes in the IIS solve. */
SCIP_EXPORT
void SCIPiisAddNNodes(
   SCIP_IIS*             iis,                /**< IIS data structure */
   SCIP_Longint          nnodes              /**< The number of nodes to add to the IIS */
   );
 
/** get the randnumgen of the IIS */
SCIP_EXPORT
SCIP_RANDNUMGEN* SCIPiisGetRandnumgen(
   SCIP_IIS*             iis                 /**< pointer to the IIS */
   );
 
/** get the subscip of an IIS */
SCIP_EXPORT
SCIP* SCIPiisGetSubscip(
   SCIP_IIS*             iis                 /**< pointer to the IIS */
   );
 
/** get the constraint in the IIS subscip corresponding to the given main constraint,
or NULL if it was removed */
SCIP_EXPORT
SCIP_CONS* SCIPiisGetSubscipCons(
   SCIP_IIS*             iis,                /**< pointer to the IIS */
   SCIP_CONS*            cons                /**< constraint from the original model */
   );
 
/** get the variable in the IIS subscip corresponding to the given main variable,
or NULL if it became redundant */
SCIP_EXPORT
SCIP_VAR* SCIPiisGetSubscipVar(
   SCIP_IIS*             iis,                /**< pointer to the IIS */
   SCIP_VAR*             var                 /**< variable from the original model */
   );
 
/** get the varsmap of an IIS */
SCIP_EXPORT
SCIP_HASHMAP* SCIPiisGetVarsmap(
   SCIP_IIS*             iis                 /**< pointer to the IIS */
   );
 
/** get the conssmap of an IIS */
SCIP_EXPORT
SCIP_HASHMAP* SCIPiisGetConssmap(
   SCIP_IIS*             iis                 /**< pointer to the IIS */
   );
 
/**@}
 *
 * @addtogroup PublicIISfinderMethods
 *
 * @{
 */
 
/** compares two IIS finders w. r. to their priority */
SCIP_EXPORT
SCIP_DECL_SORTPTRCOMP(SCIPiisfinderComp);
 
/** @} */
 
#ifdef __cplusplus
}
#endif
 
#endif