Scippy

SCIP

Solving Constraint Integer Programs

heur_indicatordiving.h
Go to the documentation of this file.
1/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2/* */
3/* This file is part of the program and library */
4/* SCIP --- Solving Constraint Integer Programs */
5/* */
6/* Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB) */
7/* */
8/* Licensed under the Apache License, Version 2.0 (the "License"); */
9/* you may not use this file except in compliance with the License. */
10/* You may obtain a copy of the License at */
11/* */
12/* http://www.apache.org/licenses/LICENSE-2.0 */
13/* */
14/* Unless required by applicable law or agreed to in writing, software */
15/* distributed under the License is distributed on an "AS IS" BASIS, */
16/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17/* See the License for the specific language governing permissions and */
18/* limitations under the License. */
19/* */
20/* You should have received a copy of the Apache-2.0 license */
21/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22/* */
23/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24
25/**@file heur_indicatordiving.h
26 * @ingroup PRIMALHEURISTICS
27 * @brief LP diving heuristic that fixes indicator variables controlling semicontinuous variables
28 * @author Katrin Halbig
29 * @author Alexander Hoen
30 *
31 * A diving heuristic iteratively rounds some fractional variables or variables determined by constraint handlers,
32 * and resolves the LP relaxation. Thereby simulating a depth-first-search in the tree.
33 *
34 * Indicatordiving focuses on indicator variables, which control semicontinuous variables.
35 * If the semicontinuous variable is unbounded, the indicator constraint is not part of the LP and,
36 * therefore, the indicator variable is not set to an useful value in the LP solution.
37 *
38 * For these indicator variables the score depends on the LP value and the bounds of the corresponding semicontinuous variable.
39 * If parameter usevarbounds=TRUE, also varbound constraints modeling semicontinuous variables are considered.
40 * For all other variables the Farkas score (scaled) is returned.
41 */
42
43/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
44
45#ifndef __SCIP_HEUR_INDICATORDIVING_H__
46#define __SCIP_HEUR_INDICATORDIVING_H__
47
48#include "scip/def.h"
49#include "scip/type_retcode.h"
50#include "scip/type_scip.h"
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56/** creates the indicatordiving heuristic and includes it in SCIP
57 *
58 * @ingroup PrimalHeuristicIncludes
59 */
60SCIP_EXPORT
62 SCIP* scip /**< SCIP data structure */
63 );
64
65#ifdef __cplusplus
66}
67#endif
68
69#endif
common defines and data types used in all packages of SCIP
SCIP_RETCODE SCIPincludeHeurIndicatordiving(SCIP *scip)
type definitions for return codes for SCIP methods
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for SCIP's main datastructure