Scippy

SCIP

Solving Constraint Integer Programs

probdata_scflp.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 probdata_scflp.h
26  * @brief Problem data for Stochastic Capacitated Facility Location problem
27  * @author Stephen J. Maher
28  *
29  * This file handles the main problem data used in that project. For more details see \ref SCFLP_PROBLEMDATA page.
30  */
31 
32 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
33 
34 #ifndef __SCIP_PROBDATA_SCFLP__
35 #define __SCIP_PROBDATA_SCFLP__
36 
37 #include "scip/scip.h"
38 
39 /** sets up the problem data */
41  SCIP* scip, /**< SCIP data structure */
42  const char* probname, /**< problem name */
43  SCIP_Real** costs, /**< the transportation costs from a facility to a customer */
44  SCIP_Real** demands, /**< the customer demands */
45  SCIP_Real* capacity, /**< the capacity of each facility */
46  SCIP_Real* fixedcost, /**< the fixed cost of opening a facility */
47  int ncustomers, /**< the number of customers */
48  int nfacilities, /**< the number of facilities */
49  int nsubproblems, /**< the number of Benders' decomposition subproblems */
50  SCIP_Bool usebenders, /**< will Benders' decomposition be used to solve the problem */
51  SCIP_Bool quadcosts /**< should the problem be formulated with quadratic costs */
52  );
53 
54 /** returns the number of facilities */
56  SCIP_PROBDATA* probdata /**< problem data */
57  );
58 
59 /** returns the number of customers */
61  SCIP_PROBDATA* probdata /**< problem data */
62  );
63 
64 /** returns the facility variables */
66  SCIP_PROBDATA* probdata /**< problem data */
67  );
68 
69 #endif
int SCIPprobdataGetNCustomers(SCIP_PROBDATA *probdata)
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
int SCIPprobdataGetNFacilities(SCIP_PROBDATA *probdata)
#define SCIP_Bool
Definition: def.h:91
struct SCIP_ProbData SCIP_PROBDATA
Definition: type_prob.h:53
SCIP_VAR ** SCIPprobdataGetFacilityVars(SCIP_PROBDATA *probdata)
#define SCIP_Real
Definition: def.h:173
SCIP_RETCODE SCIPprobdataCreate(SCIP *scip, const char *probname, SCIP_Real **costs, SCIP_Real **demands, SCIP_Real *capacity, SCIP_Real *fixedcost, int ncustomers, int nfacilities, int nsubproblems, SCIP_Bool usebenders, SCIP_Bool quadcosts)
SCIP callable library.