Scippy

    SCIP

    Solving Constraint Integer Programs

    type_lp.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-2025 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 type_lp.h
    26 * @ingroup TYPEDEFINITIONS
    27 * @brief type definitions for LP management
    28 * @author Tobias Achterberg
    29 */
    30
    31/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
    32
    33#ifndef __SCIP_TYPE_LP_H__
    34#define __SCIP_TYPE_LP_H__
    35
    36#ifdef __cplusplus
    37extern "C" {
    38#endif
    39
    40/** solution status after solving LP */
    42{
    43 SCIP_LPSOLSTAT_NOTSOLVED = 0, /**< LP was not solved, no solution exists */
    44 SCIP_LPSOLSTAT_OPTIMAL = 1, /**< LP was solved to optimality */
    45 SCIP_LPSOLSTAT_INFEASIBLE = 2, /**< LP is primal infeasible */
    46 SCIP_LPSOLSTAT_UNBOUNDEDRAY = 3, /**< LP has a primal unbounded ray */
    47 SCIP_LPSOLSTAT_OBJLIMIT = 4, /**< objective limit was reached during optimization */
    48 SCIP_LPSOLSTAT_ITERLIMIT = 5, /**< iteration limit was reached during optimization */
    49 SCIP_LPSOLSTAT_TIMELIMIT = 6, /**< time limit was reached during optimization */
    50 SCIP_LPSOLSTAT_ERROR = 7 /**< an error occured during optimization */
    51};
    53
    54/** type of variable bound: lower or upper bound */
    56{
    57 SCIP_BOUNDTYPE_LOWER = 0, /**< lower bound */
    58 SCIP_BOUNDTYPE_UPPER = 1 /**< upper bound */
    59};
    61
    62/** type of row side: left hand or right hand side */
    64{
    65 SCIP_SIDETYPE_LEFT = 0, /**< left hand side */
    66 SCIP_SIDETYPE_RIGHT = 1 /**< right hand side */
    67};
    69
    70/** type of origin of row */
    72{
    73 SCIP_ROWORIGINTYPE_UNSPEC = 0, /**< unspecified origin of row */
    74 SCIP_ROWORIGINTYPE_CONSHDLR = 1, /**< row created by a constraint handler */
    75 SCIP_ROWORIGINTYPE_CONS = 2, /**< row created by a constraint */
    76 SCIP_ROWORIGINTYPE_SEPA = 3, /**< row created by separator */
    77 SCIP_ROWORIGINTYPE_REOPT = 4 /**< row created by reoptimization */
    78};
    80
    81/** type of LP algorithm */
    83{
    84 SCIP_LPALGO_PRIMALSIMPLEX = 0, /**< primal simplex */
    85 SCIP_LPALGO_DUALSIMPLEX = 1, /**< dual simplex */
    86 SCIP_LPALGO_BARRIER = 2, /**< barrier algorithm */
    87 SCIP_LPALGO_BARRIERCROSSOVER = 3 /**< barrier algorithm with crossover */
    88};
    90
    91typedef struct SCIP_ColSolVals SCIP_COLSOLVALS; /**< collected values of a column which depend on the LP solution */
    92typedef struct SCIP_RowSolVals SCIP_ROWSOLVALS; /**< collected values of a row which depend on the LP solution */
    93typedef struct SCIP_LpSolVals SCIP_LPSOLVALS; /**< collected values of the LP data which depend on the LP solution */
    94
    95/** column of an LP
    96 *
    97 * - \ref PublicColumnMethods "List of all available methods"
    98 */
    99typedef struct SCIP_Col SCIP_COL;
    100
    101/** row of an LP
    102 *
    103 * - \ref PublicRowMethods "List of all available methods"
    104 */
    105typedef struct SCIP_Row SCIP_ROW;
    106
    107/** LP structure
    108 *
    109 * - \ref PublicLPMethods "List of all available methods"
    110 */
    111typedef struct SCIP_Lp SCIP_LP;
    112
    113#ifdef __cplusplus
    114}
    115#endif
    116
    117#endif
    enum SCIP_RowOriginType SCIP_ROWORIGINTYPE
    Definition: type_lp.h:79
    SCIP_LPAlgo
    Definition: type_lp.h:83
    @ SCIP_LPALGO_BARRIER
    Definition: type_lp.h:86
    @ SCIP_LPALGO_PRIMALSIMPLEX
    Definition: type_lp.h:84
    @ SCIP_LPALGO_BARRIERCROSSOVER
    Definition: type_lp.h:87
    @ SCIP_LPALGO_DUALSIMPLEX
    Definition: type_lp.h:85
    enum SCIP_LPSolStat SCIP_LPSOLSTAT
    Definition: type_lp.h:52
    SCIP_RowOriginType
    Definition: type_lp.h:72
    @ SCIP_ROWORIGINTYPE_CONSHDLR
    Definition: type_lp.h:74
    @ SCIP_ROWORIGINTYPE_REOPT
    Definition: type_lp.h:77
    @ SCIP_ROWORIGINTYPE_UNSPEC
    Definition: type_lp.h:73
    @ SCIP_ROWORIGINTYPE_SEPA
    Definition: type_lp.h:76
    @ SCIP_ROWORIGINTYPE_CONS
    Definition: type_lp.h:75
    SCIP_BoundType
    Definition: type_lp.h:56
    @ SCIP_BOUNDTYPE_UPPER
    Definition: type_lp.h:58
    @ SCIP_BOUNDTYPE_LOWER
    Definition: type_lp.h:57
    enum SCIP_BoundType SCIP_BOUNDTYPE
    Definition: type_lp.h:60
    SCIP_SideType
    Definition: type_lp.h:64
    @ SCIP_SIDETYPE_RIGHT
    Definition: type_lp.h:66
    @ SCIP_SIDETYPE_LEFT
    Definition: type_lp.h:65
    SCIP_LPSolStat
    Definition: type_lp.h:42
    @ SCIP_LPSOLSTAT_ERROR
    Definition: type_lp.h:50
    @ SCIP_LPSOLSTAT_NOTSOLVED
    Definition: type_lp.h:43
    @ SCIP_LPSOLSTAT_OPTIMAL
    Definition: type_lp.h:44
    @ SCIP_LPSOLSTAT_TIMELIMIT
    Definition: type_lp.h:49
    @ SCIP_LPSOLSTAT_UNBOUNDEDRAY
    Definition: type_lp.h:46
    @ SCIP_LPSOLSTAT_INFEASIBLE
    Definition: type_lp.h:45
    @ SCIP_LPSOLSTAT_OBJLIMIT
    Definition: type_lp.h:47
    @ SCIP_LPSOLSTAT_ITERLIMIT
    Definition: type_lp.h:48
    enum SCIP_LPAlgo SCIP_LPALGO
    Definition: type_lp.h:89
    enum SCIP_SideType SCIP_SIDETYPE
    Definition: type_lp.h:68