Scippy

SCIP

Solving Constraint Integer Programs

vardata_binpacking.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 2002-2022 Zuse Institute Berlin */
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 vardata_binpacking.h
26  * @brief Variable data containing the ids of constraints in which the variable appears
27  * @author Timo Berthold
28  * @author Stefan Heinz
29  *
30  * This file implements the handling of the variable data which is attached to each file. See SCIP_VarData and \ref BINPACKING_PRICER.
31  */
32 
33 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
34 
35 #ifndef __SCIP_VARDATA_BINPACKING__
36 #define __SCIP_VARDATA_BINPACKING__
37 
38 #include "scip/scip.h"
39 
40 /** create variable data */
42  SCIP* scip, /**< SCIP data structure */
43  SCIP_VARDATA** vardata, /**< pointer to vardata */
44  int* consids, /**< array of constraints ids */
45  int nconss /**< number of constraints */
46  );
47 
48 /** get number of constraints */
50  SCIP_VARDATA* vardata /**< variable data */
51  );
52 
53 /** returns sorted constraint id array */
55  SCIP_VARDATA* vardata /**< variable data */
56  );
57 
58 /** creates variable */
60  SCIP* scip, /**< SCIP data structure */
61  SCIP_VAR** var, /**< pointer to variable object */
62  const char* name, /**< name of variable, or NULL for automatic name creation */
63  SCIP_Real obj, /**< objective function value */
64  SCIP_Bool initial, /**< should var's column be present in the initial root LP? */
65  SCIP_Bool removable, /**< is var's column removable from the LP (due to aging or cleanup)? */
66  SCIP_VARDATA* vardata /**< user data for this specific variable */
67  );
68 
69 /** prints vardata to file stream */
70 void SCIPvardataPrint(
71  SCIP* scip, /**< SCIP data structure */
72  SCIP_VARDATA* vardata, /**< variable data */
73  FILE* file /**< the text file to store the information into */
74  );
75 
76 #endif
void SCIPvardataPrint(SCIP *scip, SCIP_VARDATA *vardata, FILE *file)
struct SCIP_VarData SCIP_VARDATA
Definition: type_var.h:116
int * SCIPvardataGetConsids(SCIP_VARDATA *vardata)
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
SCIP_RETCODE SCIPvardataCreateBinpacking(SCIP *scip, SCIP_VARDATA **vardata, int *consids, int nconss)
SCIP_RETCODE SCIPcreateVarBinpacking(SCIP *scip, SCIP_VAR **var, const char *name, SCIP_Real obj, SCIP_Bool initial, SCIP_Bool removable, SCIP_VARDATA *vardata)
#define SCIP_Bool
Definition: def.h:93
int SCIPvardataGetNConsids(SCIP_VARDATA *vardata)
#define SCIP_Real
Definition: def.h:186
SCIP callable library.