source: trunk/Cbc/src/Cbc_C_Interface.h @ 2091

Last change on this file since 2091 was 2091, checked in by mlubin, 4 years ago

Update outdated comment

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1/* $Id: Cbc_C_Interface.h 2091 2014-10-03 00:46:49Z mlubin $ */
2/*
3  Copyright (C) 2004 International Business Machines Corporation and others.
4  All Rights Reserved.
5
6  This code is licensed under the terms of the Eclipse Public License (EPL).
7*/
8#ifndef CbcModelC_H
9#define CbcModelC_H
10
11/* include all defines and ugly stuff */
12#include "Coin_C_defines.h"
13#include <stddef.h>
14
15/*
16 * Original verison contributed by Bob Entriken,
17 * significantly updated by Miles Lubin.
18*/
19
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25    /**@name Constructors and destructor
26      This is a "C" interface to Cbc.
27      The user does not need to know structure of Cbc_Model.
28    */
29    /*@{*/
30
31    /** Default Cbc_Model constructor */
32    COINLIBAPI Cbc_Model * COINLINKAGE
33    Cbc_newModel(void)
34    ;
35    /** Cbc_Model Destructor */
36    COINLIBAPI void COINLINKAGE
37    Cbc_deleteModel(Cbc_Model * model)
38    ;
39    /** Current version of Cbc */
40    COINLIBAPI const char* COINLINKAGE Cbc_getVersion(void)
41    ;
42    /*@}*/
43
44    /**@name Getting and setting model data
45     Note that problem access and modification methods,
46       such as getColLower and setColLower,
47       are *not valid* after calling Cbc_solve().
48       Therefore it is not recommended to reuse a Cbc_Model
49       object for multiple solves. A workaround is to call Cbc_clone()
50       before solving.
51     * */
52    /*@{*/
53    /** Loads a problem (the constraints on the
54        rows are given by lower and upper bounds). If a pointer is NULL then the
55        following values are the default:
56        <ul>
57        <li> <code>colub</code>: all columns have upper bound infinity
58        <li> <code>collb</code>: all columns have lower bound 0
59        <li> <code>rowub</code>: all rows have upper bound infinity
60        <li> <code>rowlb</code>: all rows have lower bound -infinity
61        <li> <code>obj</code>: all variables have 0 objective coefficient
62        </ul>
63
64     The constraint matrix is
65     given in standard compressed sparse column (without gaps).
66     <ul>
67     <li> <code>start[i]</code> stores the starting index of the ith column
68     <li> <code>index[k]</code> stores the row index of the kth nonzero element
69     <li> <code>value[k]</code> stores the coefficient of the kth nonzero element
70     </ul>
71    */
72    COINLIBAPI void COINLINKAGE
73    Cbc_loadProblem (Cbc_Model * model,  const int numcols, const int numrows,
74                     const CoinBigIndex * start, const int* index,
75                     const double* value,
76                     const double* collb, const double* colub,
77                     const double* obj,
78                     const double* rowlb, const double* rowub)
79    ;
80    /** Read an mps file from the given filename */
81    COINLIBAPI int COINLINKAGE
82    Cbc_readMps(Cbc_Model * model, const char *filename)
83    ;
84    /** Write an mps file from the given filename */
85    COINLIBAPI void COINLINKAGE
86    Cbc_writeMps(Cbc_Model * model, const char *filename)
87    ;
88    /** Provide an initial feasible solution to accelerate branch-and-bound
89     Note that feasibility of the solution is *not* verified.
90    */
91    COINLIBAPI void COINLINKAGE
92    Cbc_setInitialSolution(Cbc_Model *model, const double * sol)
93    ;
94    /** Fills in array with problem name  */
95    COINLIBAPI void COINLINKAGE
96    Cbc_problemName(Cbc_Model * model, int maxNumberCharacters, char * array)
97    ;
98    /** Sets problem name.
99   
100      \p array must be a null-terminated string.
101    */
102    COINLIBAPI int COINLINKAGE
103    Cbc_setProblemName(Cbc_Model * model, const char * array)
104    ;
105
106    /** Number of nonzero elements in constraint matrix */
107    COINLIBAPI int COINLINKAGE
108    Cbc_getNumElements(Cbc_Model * model)
109    ;
110    /** "Column start" vector of constraint matrix. Same format as Cbc_loadProblem() */
111    COINLIBAPI const CoinBigIndex * COINLINKAGE
112    Cbc_getVectorStarts(Cbc_Model * model)
113    ;
114    /** "Row index" vector of constraint matrix */
115    COINLIBAPI const int * COINLINKAGE
116    Cbc_getIndices(Cbc_Model * model)
117    ;
118    /** Coefficient vector of constraint matrix */
119    COINLIBAPI const double * COINLINKAGE
120    Cbc_getElements(Cbc_Model * model)
121    ;
122
123    /** Maximum lenght of a row or column name */
124    COINLIBAPI size_t COINLINKAGE
125    Cbc_maxNameLength(Cbc_Model * model)
126    ;
127    /** Fill in first maxLength bytes of name array with a row name */
128    COINLIBAPI void COINLINKAGE
129    Cbc_getRowName(Cbc_Model * model, int iRow, char * name, size_t maxLength)
130    ;
131    /** Fill in first maxLength bytes of name array with a column name */
132    COINLIBAPI void COINLINKAGE
133    Cbc_getColName(Cbc_Model * model, int iColumn, char * name, size_t maxLength)
134    ;
135    /** Set the name of a column */
136    COINLIBAPI void COINLINKAGE
137    Cbc_setColName(Cbc_Model * model, int iColumn, const char * name)
138    ;
139    /** Set the name of a row */
140    COINLIBAPI void COINLINKAGE
141    Cbc_setRowName(Cbc_Model * model, int iRow, const char * name)
142    ;
143    /** Number of constraints in the model */
144    COINLIBAPI int COINLINKAGE
145    Cbc_getNumRows(Cbc_Model * model)
146    ;
147    /** Number of variables in the model */
148    COINLIBAPI int COINLINKAGE
149    Cbc_getNumCols(Cbc_Model * model)
150    ;
151    /** Direction of optimization (1 - minimize, -1 - maximize, 0 - ignore) */
152    COINLIBAPI void COINLINKAGE
153    Cbc_setObjSense(Cbc_Model * model, double sense)
154    ;
155    /** Direction of optimization (1 - minimize, -1 - maximize, 0 - ignore) */
156    COINLIBAPI double COINLINKAGE
157    Cbc_getObjSense(Cbc_Model * model)
158    ;
159    /** Constraint lower bounds */
160    COINLIBAPI const double* COINLINKAGE
161    Cbc_getRowLower(Cbc_Model * model)
162    ;
163    /** Set the lower bound of a single constraint */
164    COINLIBAPI void COINLINKAGE
165    Cbc_setRowLower(Cbc_Model * model, int index, double value)
166    ;
167    /** Constraint upper bounds */
168    COINLIBAPI const double* COINLINKAGE
169    Cbc_getRowUpper(Cbc_Model * model)
170    ;
171    /** Set the upper bound of a single constraint */
172    COINLIBAPI void COINLINKAGE
173    Cbc_setRowUpper(Cbc_Model * model, int index, double value)
174    ;
175    /** Objective vector */
176    COINLIBAPI const double * COINLINKAGE
177    Cbc_getObjCoefficients(Cbc_Model * model)
178    ;
179    /** Set the objective coefficient of a single variable */
180    COINLIBAPI void COINLINKAGE
181    Cbc_setObjCoeff(Cbc_Model * model, int index, double value)
182    ;
183    /** Variable lower bounds */
184    COINLIBAPI const double * COINLINKAGE
185    Cbc_getColLower(Cbc_Model * model)
186    ;
187    /** Set the lower bound of a single variable */
188    COINLIBAPI void COINLINKAGE
189    Cbc_setColLower(Cbc_Model * model, int index, double value)
190    ;
191    /** Variable upper bounds */
192    COINLIBAPI const double * COINLINKAGE
193    Cbc_getColUpper(Cbc_Model * model)
194    ;
195    /** Set the upper bound of a single variable */
196    COINLIBAPI void COINLINKAGE
197    Cbc_setColUpper(Cbc_Model * model, int index, double value)
198    ;
199    /** Determine whether the ith variable is integer restricted */
200    COINLIBAPI int COINLINKAGE
201    Cbc_isInteger(Cbc_Model * model, int i)
202    ;
203    /** Set this variable to be continuous */
204    COINLIBAPI void COINLINKAGE
205    Cbc_setContinuous(Cbc_Model * model, int iColumn)
206    ;
207    /** Set this variable to be integer */
208    COINLIBAPI void COINLINKAGE
209    Cbc_setInteger(Cbc_Model * model, int iColumn)
210    ;
211    /** Add SOS constraints to the model using row-order matrix */
212    COINLIBAPI void  COINLINKAGE
213    Cbc_addSOS(Cbc_Model * model, int numRows, const int * rowStarts,
214               const int * colIndices, const double * weights, const int type)
215    ;
216    /** Print the model */
217    COINLIBAPI void COINLINKAGE
218    Cbc_printModel(Cbc_Model * model, const char * argPrefix)
219    ;
220    /** Return a copy of this model */
221    COINLIBAPI Cbc_Model * COINLINKAGE
222    Cbc_clone(Cbc_Model * model)
223    ;
224    /*@}*/
225    /**@name Solver parameters */
226    /*@{*/
227    /** Set parameter "name" to value "value". Note that this
228     * translates directly to using "-name value" as a
229     * command-line argument to Cbc.*/
230    COINLIBAPI void COINLINKAGE
231    Cbc_setParameter(Cbc_Model * model, const char * name, const char * value)
232    ;
233
234   
235    /*@}*/
236    /**@name Message handling.  Call backs are handled by ONE function */
237    /*@{*/
238    /** Pass in Callback function.
239     Message numbers up to 1000000 are Clp, Coin ones have 1000000 added */
240    COINLIBAPI void COINLINKAGE
241    Cbc_registerCallBack(Cbc_Model * model,
242                         cbc_callback userCallBack)
243    ;
244    /** Unset Callback function */
245    COINLIBAPI void COINLINKAGE
246    Cbc_clearCallBack(Cbc_Model * model)
247    ;
248
249    /*@}*/
250
251
252    /**@name Solving the model */
253    /*@{*/
254    /* Solve the model with Cbc (using CbcMain1).
255    */
256    COINLIBAPI int COINLINKAGE
257    Cbc_solve(Cbc_Model * model)
258    ;
259    /*@}*/
260
261
262    /**@name Accessing the solution and solution status */
263    /*@{*/
264
265    /** Sum of primal infeasibilities */
266    COINLIBAPI double COINLINKAGE
267    Cbc_sumPrimalInfeasibilities(Cbc_Model * model)
268    ;
269    /** Number of primal infeasibilities */
270    COINLIBAPI int COINLINKAGE
271    Cbc_numberPrimalInfeasibilities(Cbc_Model * model)
272    ;
273
274    /** Just check solution (for external use) - sets sum of
275        infeasibilities etc */
276    COINLIBAPI void COINLINKAGE
277    Cbc_checkSolution(Cbc_Model * model)
278    ;
279
280    /** Number of iterations */
281    COINLIBAPI int COINLINKAGE
282    Cbc_getIterationCount(Cbc_Model * model)
283    ;
284    /** Are there a numerical difficulties? */
285    COINLIBAPI int COINLINKAGE
286    Cbc_isAbandoned(Cbc_Model * model)
287    ;
288    /** Is optimality proven? */
289    COINLIBAPI int COINLINKAGE
290    Cbc_isProvenOptimal(Cbc_Model * model)
291    ;
292    /** Is infeasiblity proven (or none better than cutoff)? */
293    COINLIBAPI int COINLINKAGE
294    Cbc_isProvenInfeasible(Cbc_Model * model)
295    ;
296    /** Was continuous solution unbounded? */
297    COINLIBAPI int COINLINKAGE
298    Cbc_isContinuousUnbounded(Cbc_Model * model)
299    ;
300    /** Node limit reached? */
301    COINLIBAPI int COINLINKAGE
302    Cbc_isNodeLimitReached(Cbc_Model * model)
303    ;
304    /** Time limit reached? */
305    COINLIBAPI int COINLINKAGE
306    Cbc_isSecondsLimitReached(Cbc_Model * model)
307    ;
308    /** Solution limit reached? */
309    COINLIBAPI int COINLINKAGE
310    Cbc_isSolutionLimitReached(Cbc_Model * model)
311    ;
312    /** Are there numerical difficulties (for initialSolve) ? */
313    COINLIBAPI int COINLINKAGE
314    Cbc_isInitialSolveAbandoned(Cbc_Model * model)
315    ;
316    /** Is optimality proven (for initialSolve) ? */
317    COINLIBAPI int COINLINKAGE
318    Cbc_isInitialSolveProvenOptimal(Cbc_Model * model)
319    ;
320    /** Is primal infeasiblity proven (for initialSolve) ? */
321    COINLIBAPI int COINLINKAGE
322    Cbc_isInitialSolveProvenPrimalInfeasible(Cbc_Model * model)
323    ;
324    /** "row" solution
325     *  This is the vector A*x, where A is the constraint matrix
326     *  and x is the current solution. */
327    COINLIBAPI const double * COINLINKAGE
328    Cbc_getRowActivity(Cbc_Model * model)
329    ;
330    /** Best feasible solution vector */
331    COINLIBAPI const double * COINLINKAGE
332    Cbc_getColSolution(Cbc_Model * model)
333    ;
334    /** Objective value of best feasible solution */
335    COINLIBAPI double COINLINKAGE
336    Cbc_getObjValue(Cbc_Model * model)
337    ;
338    /** Best known bound on the optimal objective value */
339    COINLIBAPI double COINLINKAGE
340    Cbc_getBestPossibleObjValue(Cbc_Model * model)
341    ;
342    /** Number of nodes explored in B&B tree */
343    COINLIBAPI int COINLINKAGE
344    Cbc_getNodeCount(Cbc_Model * model)
345    ;
346    /** Print the solution */
347    COINLIBAPI void  COINLINKAGE
348    Cbc_printSolution(Cbc_Model * model)
349    ;
350    /** Final status of problem
351        Some of these can be found out by is...... functions
352        -1 before branchAndBound
353        0 finished - check isProvenOptimal or isProvenInfeasible to see if solution found
354        (or check value of best solution)
355        1 stopped - on maxnodes, maxsols, maxtime
356        2 difficulties so run was abandoned
357        (5 event user programmed event occurred)
358    */
359    COINLIBAPI int COINLINKAGE
360    Cbc_status(Cbc_Model * model)
361    ;
362    /** Secondary status of problem
363        -1 unset (status_ will also be -1)
364        0 search completed with solution
365        1 linear relaxation not feasible (or worse than cutoff)
366        2 stopped on gap
367        3 stopped on nodes
368        4 stopped on time
369        5 stopped on user event
370        6 stopped on solutions
371        7 linear relaxation unbounded
372        8 stopped on iteration limit
373    */
374    COINLIBAPI int COINLINKAGE
375    Cbc_secondaryStatus(Cbc_Model * model)
376    ;
377    /*@}*/
378#ifdef __cplusplus
379}
380#endif
381#endif
Note: See TracBrowser for help on using the repository browser.