doc/html/scip_8h_source.php

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*                                                                           */

/*                  This file is part of the program and library             */

/*         SCIP --- Solving Constraint Integer Programs                      */

/*                                                                           */

/*  Copyright (c) 2002-2024 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   scip.h

 * @ingroup PUBLICCOREAPI

 * @brief  SCIP callable library

 * @author Tobias Achterberg

 * @author Timo Berthold

 * @author Thorsten Koch

 * @author Alexander Martin

 * @author Marc Pfetsch

 * @author Kati Wolter

 */


/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/


#ifndef __SCIP_SCIP_H__

#define __SCIP_SCIP_H__


#include <stdio.h>


#include "scip/def.h"

#include "blockmemshell/memory.h"

#include "scip/type_retcode.h"

#include "scip/type_result.h"

#include "scip/type_clock.h"

#include "scip/type_misc.h"

#include "scip/type_timing.h"

#include "scip/type_paramset.h"

#include "scip/type_event.h"

#include "scip/type_lp.h"

#include "scip/type_nlp.h"

#include "scip/type_var.h"

#include "scip/type_prob.h"

#include "scip/type_tree.h"

#include "scip/type_scip.h"


#include "scip/type_bandit.h"

#include "scip/type_branch.h"

#include "scip/type_conflict.h"

#include "scip/type_cons.h"

#include "scip/type_dialog.h"

#include "scip/type_disp.h"

#include "scip/type_expr.h"

#include "scip/type_heur.h"

#include "scip/type_compr.h"

#include "scip/type_history.h"

#include "scip/type_nodesel.h"

#include "scip/type_presol.h"

#include "scip/type_pricer.h"

#include "scip/type_reader.h"

#include "scip/type_relax.h"

#include "scip/type_reopt.h"

#include "scip/type_sepa.h"

#include "scip/type_cutsel.h"

#include "scip/type_table.h"

#include "scip/type_prop.h"

#include "scip/type_nlpi.h"

#include "scip/type_concsolver.h"

#include "scip/type_syncstore.h"

#include "scip/type_benders.h"

#include "scip/type_benderscut.h"


#include "scip/intervalarith.h"


/* include public interfaces, s.t. the user only needs to include scip.h */

#include "scip/pub_bandit.h"

#include "scip/pub_benders.h"

#include "scip/pub_benderscut.h"

#include "scip/pub_branch.h"

#include "scip/pub_conflict.h"

#include "scip/pub_cons.h"

#include "scip/pub_cutpool.h"

#include "scip/pub_dcmp.h"

#include "scip/pub_dialog.h"

#include "scip/pub_disp.h"

#include "scip/pub_event.h"

#include "scip/pub_expr.h"

#include "scip/pub_fileio.h"

#include "scip/pub_heur.h"

#include "scip/pub_compr.h"

#include "scip/pub_history.h"

#include "scip/pub_implics.h"

#include "scip/pub_lp.h"

#include "scip/pub_nlp.h"

#include "scip/pub_matrix.h"

#include "scip/pub_message.h"

#include "scip/pub_misc.h"

#include "scip/pub_nodesel.h"

#include "scip/pub_paramset.h"

#include "scip/pub_presol.h"

#include "scip/pub_pricer.h"

#include "scip/pub_reader.h"

#include "scip/pub_relax.h"

#include "scip/pub_reopt.h"

#include "scip/pub_sepa.h"

#include "scip/pub_cutsel.h"

#include "scip/pub_prop.h"

#include "scip/pub_sol.h"

#include "scip/pub_table.h"

#include "scip/pub_tree.h"

#include "scip/pub_var.h"

#include "lpi/lpi.h"


/* include global presolving, cuts, and heuristics methods */

#include "scip/presolve.h"

#include "scip/cuts.h"

#include "scip/heuristics.h"


#include "scip/scip_bandit.h"

#include "scip/scip_benders.h"

#include "scip/scip_branch.h"

#include "scip/scip_compr.h"

#include "scip/scip_concurrent.h"

#include "scip/scip_conflict.h"

#include "scip/scip_cons.h"

#include "scip/scip_copy.h"

#include "scip/scip_cut.h"

#include "scip/scip_datastructures.h"

#include "scip/scip_debug.h"

#include "scip/scip_dcmp.h"

#include "scip/scip_dialog.h"

#include "scip/scip_disp.h"

#include "scip/scip_event.h"

#include "scip/scip_expr.h"

#include "scip/scip_general.h"

#include "scip/scip_heur.h"

#include "scip/scip_lp.h"

#include "scip/scip_mem.h"

#include "scip/scip_message.h"

#include "scip/scip_nlp.h"

#include "scip/scip_nlpi.h"

#include "scip/scip_nodesel.h"

#include "scip/scip_numerics.h"

#include "scip/scip_param.h"

#include "scip/scip_presol.h"

#include "scip/scip_pricer.h"

#include "scip/scip_prob.h"

#include "scip/scip_probing.h"

#include "scip/scip_prop.h"

#include "scip/scip_randnumgen.h"

#include "scip/scip_reader.h"

#include "scip/scip_relax.h"

#include "scip/scip_reopt.h"

#include "scip/scip_sepa.h"

#include "scip/scip_cutsel.h"

#include "scip/scip_sol.h"

#include "scip/scip_solve.h"

#include "scip/scip_solvingstats.h"

#include "scip/scip_table.h"

#include "scip/scip_timing.h"

#include "scip/scip_tree.h"

#include "scip/scip_validation.h"

#include "scip/scip_var.h"


#endif

cuts.h
methods for the aggregation rows

def.h
common defines and data types used in all packages of SCIP

heuristics.h
methods commonly used by primal heuristics

intervalarith.h
interval arithmetics for provable bounds

lpi.h
interface methods for specific LP solvers

memory.h
memory allocation routines

presolve.h
methods commonly used for presolving

pub_bandit.h
public methods for bandit algorithms

pub_benders.h
public methods for Benders' decomposition

pub_benderscut.h
public methods for Benders' decomposition cuts

pub_branch.h
public methods for branching rules

pub_compr.h
public methods for tree compressions

pub_conflict.h
public methods for conflict analysis handlers

pub_cons.h
public methods for managing constraints

pub_cutpool.h
public methods for storing cuts in a cut pool

pub_cutsel.h
public methods for cut selectors

pub_dcmp.h
public methods for decompositions

pub_dialog.h
public methods for user interface dialog

pub_disp.h
public methods for displaying runtime statistics

pub_event.h
public methods for managing events

pub_expr.h
public functions to work with algebraic expressions

pub_fileio.h
wrapper functions to map file i/o to standard or zlib file i/o

pub_heur.h
public methods for primal heuristics

pub_history.h
public methods for branching and inference history structure

pub_implics.h
public methods for implications, variable bounds, and cliques

pub_lp.h
public methods for LP management

pub_matrix.h
public methods for matrix

pub_message.h
public methods for message output

pub_misc.h
public data structures and miscellaneous methods

pub_nlp.h
public methods for NLP management

pub_nodesel.h
public methods for node selectors

pub_paramset.h
public methods for handling parameter settings

pub_presol.h
public methods for presolvers

pub_pricer.h
public methods for variable pricers

pub_prop.h
public methods for propagators

pub_reader.h
public methods for input file readers

pub_relax.h
public methods for relaxation handlers

pub_reopt.h
public methods for reoptimization

pub_sepa.h
public methods for separators

pub_sol.h
public methods for primal CIP solutions

pub_table.h
public methods for displaying statistic tables

pub_tree.h
public methods for branch and bound tree

pub_var.h
public methods for problem variables

scip_bandit.h
public methods for bandit algorithms

scip_benders.h
public methods for Benders decomposition

scip_branch.h
public methods for branching rule plugins and branching

scip_compr.h
public methods for compression plugins

scip_concurrent.h
public methods for concurrent solving mode

scip_conflict.h
public methods for conflict handler plugins and conflict analysis

scip_cons.h
public methods for constraint handler plugins and constraints

scip_copy.h
public methods for problem copies

scip_cut.h
public methods for cuts and aggregation rows

scip_cutsel.h
public methods for cut selector plugins

scip_datastructures.h
public methods for data structures

scip_dcmp.h
public methods for decompositions

scip_debug.h
public methods for debugging

scip_dialog.h
public methods for dialog handler plugins

scip_disp.h
public methods for display handler plugins

scip_event.h
public methods for event handler plugins and event handlers

scip_expr.h
public functions to work with algebraic expressions

scip_general.h
general public methods

scip_heur.h
public methods for primal heuristic plugins and divesets

scip_lp.h
public methods for the LP relaxation, rows and columns

scip_mem.h
public methods for memory management

scip_message.h
public methods for message handling

scip_nlp.h
public methods for nonlinear relaxation

scip_nlpi.h
public methods for NLPI solver interfaces

scip_nodesel.h
public methods for node selector plugins

scip_numerics.h
public methods for numerical tolerances

scip_param.h
public methods for SCIP parameter handling

scip_presol.h
public methods for presolving plugins

scip_pricer.h
public methods for variable pricer plugins

scip_prob.h
public methods for global and local (sub)problems

scip_probing.h
public methods for the probing mode

scip_prop.h
public methods for propagator plugins

scip_randnumgen.h
public methods for random numbers

scip_reader.h
public methods for reader plugins

scip_relax.h
public methods for relaxator plugins

scip_reopt.h
public methods for reoptimization

scip_sepa.h
public methods for separator plugins

scip_sol.h
public methods for solutions

scip_solve.h
public solving methods

scip_solvingstats.h
public methods for querying solving statistics

scip_table.h
public methods for statistics table plugins

scip_timing.h
public methods for timing

scip_tree.h
public methods for the branch-and-bound tree

scip_validation.h
public methods for validation

scip_var.h
public methods for SCIP variables

type_bandit.h
type definitions for bandit selection algorithms

type_benders.h
type definitions for Benders' decomposition methods

type_benderscut.h
type definitions for Benders' decomposition cut

type_branch.h
type definitions for branching rules

type_clock.h
type definitions for clocks and timing issues

type_compr.h
type definitions for tree compression

type_concsolver.h
type definitions for concurrent solvers

type_conflict.h
type definitions for conflict analysis

type_cons.h
type definitions for constraints and constraint handlers

type_cutsel.h
type definitions for cut selectors

type_dialog.h
type definitions for user interface dialog

type_disp.h
type definitions for displaying runtime statistics

type_event.h
type definitions for managing events

type_expr.h
type and macro definitions related to algebraic expressions

type_heur.h
type definitions for primal heuristics

type_history.h
type definitions for branching and inference history

type_lp.h
type definitions for LP management

type_misc.h
type definitions for miscellaneous datastructures

type_nlp.h
type definitions for NLP management

type_nlpi.h
type definitions for NLP solver interfaces

type_nodesel.h
type definitions for node selectors

type_paramset.h
type definitions for handling parameter settings

type_presol.h
type definitions for presolvers

type_pricer.h
type definitions for variable pricers

type_prob.h
type definitions for storing and manipulating the main problem

type_prop.h
type definitions for propagators

type_reader.h
type definitions for input file readers

type_relax.h
type definitions for relaxators

type_reopt.h
type definitions for collecting reoptimization information

type_result.h
result codes for SCIP callback methods

type_retcode.h
type definitions for return codes for SCIP methods

type_scip.h
type definitions for SCIP's main datastructure

type_sepa.h
type definitions for separators

type_syncstore.h
the type definitions for the synchronization store

type_table.h
type definitions for displaying statistics tables

type_timing.h
timing definitions for SCIP

type_tree.h
type definitions for branch and bound tree

type_var.h
type definitions for problem variables