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

Last change on this file since 2495 was 2495, checked in by unxusr, 8 months ago

time limit in C interface

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 26.3 KB
Line 
1/* $Id: Cbc_C_Interface.h 2495 2019-02-18 13:32:42Z unxusr $ */
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 version contributed by Bob Entriken,
17 * significantly updated by Miles Lubin.
18 * 2018: several updates by Haroldo
19 */
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25/** Current version of Cbc */
26COINLIBAPI const char *COINLINKAGE Cbc_getVersion(void);
27
28/** \name Problem creation and modification routines */
29//@{
30
31/** @brief Creates an empty problem */
32COINLIBAPI Cbc_Model *COINLINKAGE
33Cbc_newModel(void);
34
35/** @brief Sets problem name.
36     *
37     * @param model problem object
38     * @param array string with problem name
39     **/
40COINLIBAPI int COINLINKAGE
41Cbc_setProblemName(Cbc_Model *model, const char *array);
42
43/** @brief Creates a new column
44     *
45     * Creates a new column (variable)
46     *
47     * @param model problem object
48     * @param name variable name
49     * @param lb column lower bound
50     * @param ub column upper bound
51     * @param obj objective function coefficient
52     * @param isInteger 1 if variable is integral, 0 otherwise
53     * @param nz number of rows (constraints) where this column appears, can be 0 if constraints will be added later
54     * @param rows index of rows where this column appears, NULL if rows will be added later
55     * @param coefs coefficients that this column appears in its rows, NULL if rows will be added later
56     ***/
57COINLIBAPI void COINLINKAGE
58Cbc_addCol(Cbc_Model *model, const char *name, double lb,
59  double ub, double obj, char isInteger,
60  int nz, int *rows, double *coefs);
61
62/** @brief Adds a new row
63     *
64     *  Adds a new row (linear constraint) to the problem
65     *
66     *  @param model problem object
67     *  @param name constraint name
68     *  @param nz number of variables with non-zero coefficients in this row
69     *  @param cols index of variables that appear in this row
70     *  @param coefs cofficients that that variables appear
71     *  @param sense constraint sense: L if <=, G if >=, E if =, R if ranged and N if free
72     *  @param rhs right hand size
73     * */
74COINLIBAPI void COINLINKAGE
75Cbc_addRow(Cbc_Model *model, const char *name, int nz,
76  const int *cols, const double *coefs, char sense, double rhs);
77
78/** @brief Add SOS constraints to the model using row-order matrix */
79COINLIBAPI void COINLINKAGE
80Cbc_addSOS(Cbc_Model *model, int numRows, const int *rowStarts,
81  const int *colIndices, const double *weights, const int type);
82
83/** Loads a problem (the constraints on the
84        rows are given by lower and upper bounds). If a pointer is NULL then the
85        following values are the default:
86        <ul>
87        <li> <code>colub</code>: all columns have upper bound infinity
88        <li> <code>collb</code>: all columns have lower bound 0
89        <li> <code>rowub</code>: all rows have upper bound infinity
90        <li> <code>rowlb</code>: all rows have lower bound -infinity
91        <li> <code>obj</code>: all variables have 0 objective coefficient
92        </ul>
93
94     The constraint matrix is
95     given in standard compressed sparse column (without gaps).
96     <ul>
97     <li> <code>start[i]</code> stores the starting index of the ith column
98     <li> <code>index[k]</code> stores the row index of the kth nonzero element
99     <li> <code>value[k]</code> stores the coefficient of the kth nonzero element
100     </ul>
101    */
102COINLIBAPI void COINLINKAGE
103Cbc_loadProblem(Cbc_Model *model, const int numcols, const int numrows,
104  const CoinBigIndex *start, const int *index,
105  const double *value,
106  const double *collb, const double *colub,
107  const double *obj,
108  const double *rowlb, const double *rowub);
109
110/** @brief Set the name of a column
111     *
112     * @param model problem object
113     * @param iColumn column index
114     * @param column name
115     **/
116COINLIBAPI void COINLINKAGE
117Cbc_setColName(Cbc_Model *model, int iColumn, const char *name);
118
119/** @brief Set the name of a row
120     *
121     * @param model problem object
122     * @param iRow row index
123     * @param name row name
124     **/
125COINLIBAPI void COINLINKAGE
126Cbc_setRowName(Cbc_Model *model, int iRow, const char *name);
127
128/** @brief Sets optimization direction
129    *
130    * @param model problem object
131    * @param sense: direction of optimization (1 - minimize, -1 - maximize, 0 - ignore)
132    **/
133COINLIBAPI void COINLINKAGE
134Cbc_setObjSense(Cbc_Model *model, double sense);
135
136/** @brief Set the lower bound of a single constraint
137     *
138     * @param model problem object
139     * @param index row index
140     * @param value new row lower bound
141     **/
142COINLIBAPI void COINLINKAGE
143Cbc_setRowLower(Cbc_Model *model, int index, double value);
144
145/** @brief  Set the upper bound of a single constraint
146     *
147     * @param model problem object
148     * @param index row index
149     * @param value new row upper bound
150     **/
151COINLIBAPI void COINLINKAGE
152Cbc_setRowUpper(Cbc_Model *model, int index, double value);
153
154/** @brief Set the objective coefficient of a single variable
155     *
156     * @param model problem object
157     * @param index variable index
158     * @param value new objective function coefficient for this variable
159     **/
160COINLIBAPI void COINLINKAGE
161Cbc_setObjCoeff(Cbc_Model *model, int index, double value);
162
163/** @brief Set the lower bound of a single variable
164     *
165     * @param model problem object
166     * @param index variable index
167     * @param value variable lower bound
168     **/
169COINLIBAPI void COINLINKAGE
170Cbc_setColLower(Cbc_Model *model, int index, double value);
171
172/** @brief Set the upper bound of a single variable
173     *
174     * @param model problem object
175     * @param index variable index
176     * @param value new variable upper bound
177     **/
178COINLIBAPI void COINLINKAGE
179Cbc_setColUpper(Cbc_Model *model, int index, double value);
180
181/** @brief Set this variable to be continuous
182     *
183     * @param model problem object
184     * @param iColumn column index
185     **/
186COINLIBAPI void COINLINKAGE
187Cbc_setContinuous(Cbc_Model *model, int iColumn);
188
189/** @brief Set this variable to be integer
190     *
191     * @param model problem object
192     * @param iColumn column index
193     **/
194COINLIBAPI void COINLINKAGE
195Cbc_setInteger(Cbc_Model *model, int iColumn);
196
197/** @brief Cbc_Model destructor */
198COINLIBAPI void COINLINKAGE
199Cbc_deleteModel(Cbc_Model *model);
200
201/** @brief Enter initial feasible solution
202     *
203     * Enter an initial feasible solution. Only the non-zero main
204     * binary/integer decision variables need to be informed.
205     * Auxiliary and/or continuous variables are computed
206     * automatically.
207     *
208     * @param model problem object
209     * @param count number of variables
210     * @param colNames names of variables
211     * @param colValues variable values
212     *
213     **/
214COINLIBAPI void COINLINKAGE
215Cbc_setMIPStart(Cbc_Model *model, int count, const char **colNames, const double colValues[]);
216
217/** @brief Enter initial feasible solution
218     *
219     * Enter an initial feasible solution. Only the non-zero main
220     * binary/integer decision variables need to be informed.
221     * Auxiliary and/or continuous variables are computed
222     * automatically. Same as setMIPStart but using variable indexes.
223     *
224     * @param model problem object
225     * @param count number of variables
226     * @param colIdxs indexes of variables
227     * @param colValues variable values
228     *
229     **/
230COINLIBAPI void COINLINKAGE
231Cbc_setMIPStartI(Cbc_Model *model, int count, const int colIdxs[], const double colValues[]);
232
233/** @brief Creates a copy of the current model
234     *
235     * @param model problem object
236     * @return model copy
237     **/
238COINLIBAPI Cbc_Model *COINLINKAGE
239Cbc_clone(Cbc_Model *model);
240
241//@}
242
243/** \name Routines to query problem contents
244*/
245//@{
246
247/** @brief Queries problem name
248     *
249     * @param model problem object
250     * @param maxNumberCharacters space in string array
251     * @param array string where problem name will be saved
252     **/
253COINLIBAPI void COINLINKAGE
254Cbc_problemName(Cbc_Model *model, int maxNumberCharacters, char *array);
255
256/** @brief Number of nonzero elements in constraint matrix
257     *
258     * @param model problem object
259     * @return number of non-zero entries in constraint matrix
260     **/
261COINLIBAPI int COINLINKAGE
262Cbc_getNumElements(Cbc_Model *model);
263
264/** @brief Number of variables in the model
265     * @param model problem object
266     * @return number of columns (variables)
267     **/
268COINLIBAPI int COINLINKAGE
269Cbc_getNumCols(Cbc_Model *model);
270
271/** @brief Number of integer variables in the model
272     *
273     * @param model problem object
274     * @return number of integer variables in this model
275     **/
276COINLIBAPI int COINLINKAGE
277Cbc_getNumIntegers(Cbc_Model *model);
278
279/** Number of constraints in the model
280     * @param model problem object
281     * @return number of rows (constraints) in the model
282     **/
283COINLIBAPI int COINLINKAGE
284Cbc_getNumRows(Cbc_Model *model);
285
286/** @brief Queries row name
287     *
288     * @param model problem object
289     * @param row index
290     * @param name string where row name will be stored
291     * @param string where row name will be stored
292     **/
293COINLIBAPI void COINLINKAGE
294Cbc_getRowName(Cbc_Model *model, int iRow, char *name, size_t maxLength);
295
296/** Queries column name
297     *
298     * @param model problem object
299     * @param iColumn column index
300     * @param name where name will be stored
301     * @param maxLength maximum length of name string
302     **/
303COINLIBAPI void COINLINKAGE
304Cbc_getColName(Cbc_Model *model, int iColumn, char *name, size_t maxLength);
305
306/** @brief Number of non-zero entries in a row
307     *
308     * @param model problem object
309     * @param row row index
310     * @return number of non-zero entries in row
311     **/
312COINLIBAPI int COINLINKAGE
313Cbc_getRowNz(Cbc_Model *model, int row);
314
315/** @brief Indices of variables that appear on a row
316     *
317     * @param model problem object
318     * @param row row index
319     * @return vector with indexes of columns that appear on this row
320     **/
321COINLIBAPI const int *COINLINKAGE
322Cbc_getRowIndices(Cbc_Model *model, int row);
323
324/** @brief Coefficients of variables that appear on this row
325     *
326     * @param model problem object
327     * @param row row index
328     * @return coefficients of variables that appear on this row
329     **/
330COINLIBAPI const double *COINLINKAGE
331Cbc_getRowCoeffs(Cbc_Model *model, int row);
332
333/** @brief Number of non-zero entries in a column
334     *
335     * @param model problem object
336     * @param col column index
337     * @return numbef of rows that this column appears
338     **/
339COINLIBAPI int COINLINKAGE
340Cbc_getColNz(Cbc_Model *model, int col);
341
342/** @brief Indices of rows that a column appears
343     *
344     * @param model problem object
345     * @param col column index
346     * @return indices of rows that this column appears
347     **/
348COINLIBAPI const int *COINLINKAGE
349Cbc_getColIndices(Cbc_Model *model, int col);
350
351/** @brief Coefficients that a column appear in rows
352     *
353     * @param model problem object
354     * @param col column index
355     * @return coefficients of this column in rows
356     **/
357COINLIBAPI const double *COINLINKAGE
358Cbc_getColCoeffs(Cbc_Model *model, int col);
359
360/** @brief Right hand side of a row
361     *
362     * @param model problem object
363     * @param row row index
364     * @return row right hand side
365     **/
366COINLIBAPI double COINLINKAGE
367Cbc_getRowRHS(Cbc_Model *model, int row);
368
369/** @brief Sense a row
370     * @param model problem object
371     * @param row row index
372     * @return row sense: E for =, L for <=, G for >= and R for ranged row
373     **/
374COINLIBAPI char COINLINKAGE
375Cbc_getRowSense(Cbc_Model *model, int row);
376
377/** @brief Direction of optimization
378     *
379     * @param model problem object
380     * @return Direction of optimization (1 - minimize, -1 - maximize, 0 - ignore)
381     **/
382COINLIBAPI double COINLINKAGE
383Cbc_getObjSense(Cbc_Model *model);
384
385/** @brief Constraint lower bounds
386     *
387     * @param model problem object
388     * @return vector with lower bounds of constraints
389     **/
390COINLIBAPI const double *COINLINKAGE
391Cbc_getRowLower(Cbc_Model *model);
392
393/** @brief Constraint upper bounds
394     *
395     * @param model problem object
396     * @return constraint upper bounds
397     **/
398COINLIBAPI const double *COINLINKAGE
399Cbc_getRowUpper(Cbc_Model *model);
400
401/** @brief Objective vector
402     *
403     * @param model problem object
404     * @return vector with coefficients of variables in the objective function
405     **/
406COINLIBAPI const double *COINLINKAGE
407Cbc_getObjCoefficients(Cbc_Model *model);
408
409/** @brief Variable lower bounds
410     *
411     * @param model problem object
412     * @return vector with lower bounds of variables
413     **/
414COINLIBAPI const double *COINLINKAGE
415Cbc_getColLower(Cbc_Model *model);
416
417/** @brief Variable upper bounds
418     *
419     * @param model problem object
420     * @return vector with column upper bounds
421     **/
422COINLIBAPI const double *COINLINKAGE
423Cbc_getColUpper(Cbc_Model *model);
424
425/** @brief Determine whether the ith variable is integer restricted
426     *
427     * @param model problem object
428     * @param i variable index
429     * @return 1 if variable is integer, 0 otherwise
430     **/
431COINLIBAPI int COINLINKAGE
432Cbc_isInteger(Cbc_Model *model, int i);
433
434
435//@}
436
437/** \name Routines to load and save problems from disk
438*/
439//@{
440
441/** @brief Read an mps file from the given filename
442    *
443    * @param model problem object
444    * @param fileName file name
445    **/
446COINLIBAPI int COINLINKAGE
447Cbc_readMps(Cbc_Model *model, const char *filename);
448
449/** @brief Read an lp file from the given filename
450     *
451     * @param model problem object
452     * @param fileName file name
453     **/
454COINLIBAPI int COINLINKAGE
455Cbc_readLp(Cbc_Model *model, const char *filename);
456
457/** @brief Write an mps file from the given filename
458     *
459     * @param model problem object
460     * @param fileName file name
461     **/
462COINLIBAPI void COINLINKAGE
463Cbc_writeMps(Cbc_Model *model, const char *filename);
464
465/** @brief Write an lp file from the given filename
466     *
467     * @param model problem object
468     * @param fileName file name
469     **/
470COINLIBAPI void COINLINKAGE
471Cbc_writeLp(Cbc_Model *model, const char *filename);
472
473//@}
474
475/**@name Getting and setting model data
476     Note that problem access and modification methods,
477       such as getColLower and setColLower,
478       are *not valid* after calling Cbc_solve().
479       Therefore it is not recommended to reuse a Cbc_Model
480       object for multiple solves. A workaround is to call Cbc_clone()
481       before solving.
482     * */
483/*@{*/
484
485/** Provide an initial feasible solution to accelerate branch-and-bound
486     Note that feasibility of the solution is *not* verified.
487    */
488COINLIBAPI void COINLINKAGE
489Cbc_setInitialSolution(Cbc_Model *model, const double *sol);
490/** "Column start" vector of constraint matrix. Same format as Cbc_loadProblem() */
491COINLIBAPI const CoinBigIndex *COINLINKAGE
492Cbc_getVectorStarts(Cbc_Model *model);
493/** "Row index" vector of constraint matrix */
494COINLIBAPI const int *COINLINKAGE
495Cbc_getIndices(Cbc_Model *model);
496/** Coefficient vector of constraint matrix */
497COINLIBAPI const double *COINLINKAGE
498Cbc_getElements(Cbc_Model *model);
499
500/** Maximum lenght of a row or column name */
501COINLIBAPI size_t COINLINKAGE
502Cbc_maxNameLength(Cbc_Model *model);
503/** Print the model */
504COINLIBAPI void COINLINKAGE
505Cbc_printModel(Cbc_Model *model, const char *argPrefix);
506/*@}*/
507
508/**@name Solver parameters */
509/*@{*/
510/** Set parameter "name" to value "value". Note that this
511     * translates directly to using "-name value" as a
512     * command-line argument to Cbc.*/
513COINLIBAPI void COINLINKAGE
514Cbc_setParameter(Cbc_Model *model, const char *name, const char *value);
515
516
517/** returns the allowable gap
518 */
519COINLIBAPI double COINLINKAGE
520Cbc_getAllowableGap(Cbc_Model *model);
521
522/** sets the allowable gap
523 */
524COINLIBAPI void COINLINKAGE
525Cbc_setAllowableGap(Cbc_Model *model, double allowedGap);
526
527/** returns the allowable fraction gap
528 */
529COINLIBAPI double COINLINKAGE
530Cbc_getAllowableFractionGap(Cbc_Model *model);
531
532/** sets the allowable fraction gap
533 */
534COINLIBAPI void COINLINKAGE
535Cbc_setAllowableFractionGap(Cbc_Model *model, double allowedFracionGap);
536
537/** returns the allowable percentage gap
538 */
539COINLIBAPI double COINLINKAGE
540Cbc_getAllowablePercentageGap(Cbc_Model *model);
541
542/** sets the allowable percentage gap
543 */
544COINLIBAPI void COINLINKAGE
545Cbc_setAllowablePercentageGap(Cbc_Model *model, double allowedPercentageGap);
546
547/** returns the time limit for the search process
548 */
549COINLIBAPI double COINLINKAGE
550Cbc_getMaximumSeconds(Cbc_Model *model);
551
552/** sets the time limit for the search process
553 */
554COINLIBAPI void COINLINKAGE
555Cbc_setMaximumSeconds(Cbc_Model *model, double maxSeconds);
556
557
558/** returns the maximum number of nodes that can be explored in the search tree
559 */
560COINLIBAPI int COINLINKAGE
561Cbc_getMaximumNodes(Cbc_Model *model);
562
563/** sets the maximum number of nodes that can be explored in the search tree
564 */
565COINLIBAPI void COINLINKAGE
566Cbc_setMaximumNodes(Cbc_Model *model, int maxNodes);
567
568/** returns solution limit for the search process
569 */
570COINLIBAPI int COINLINKAGE
571Cbc_getMaximumSolutions(Cbc_Model *model);
572
573/** sets a solution limit as a stopping criterion
574 */
575COINLIBAPI void COINLINKAGE
576Cbc_setMaximumSolutions(Cbc_Model *model, int maxSolutions);
577
578/** returns the current log leven
579 */
580COINLIBAPI int COINLINKAGE
581Cbc_getLogLevel(Cbc_Model *model);
582
583/** sets the log level
584 */
585COINLIBAPI void COINLINKAGE
586Cbc_setLogLevel(Cbc_Model *model, int logLevel);
587
588
589/** returns the cutoff
590 */
591COINLIBAPI double COINLINKAGE
592Cbc_getCutoff(Cbc_Model *model);
593
594/** sets the cutoff
595 */
596COINLIBAPI void COINLINKAGE
597Cbc_setCutoff(Cbc_Model *model, double cutoff);
598
599
600
601/*@}*/
602/**@name Message handling.  Call backs are handled by ONE function */
603/*@{*/
604/** Pass in Callback function.
605     Message numbers up to 1000000 are Clp, Coin ones have 1000000 added */
606COINLIBAPI void COINLINKAGE
607Cbc_registerCallBack(Cbc_Model *model,
608  cbc_callback userCallBack);
609
610/** Unset Callback function */
611COINLIBAPI void COINLINKAGE
612Cbc_clearCallBack(Cbc_Model *model);
613
614COINLIBAPI void COINLINKAGE Cbc_addCutCallback( 
615    Cbc_Model *model, cbc_cut_callback cutcb, 
616    const char *name, void *appData );
617
618/*@}*/
619
620/**@name Solving the model */
621/*@{*/
622/* Solve the model with Cbc (using CbcMain1).
623    */
624COINLIBAPI int COINLINKAGE
625Cbc_solve(Cbc_Model *model);
626/*@}*/
627
628/**@name Accessing the solution and optimization status */
629/*@{*/
630
631/** @brief Best feasible solution vector
632     *
633     * @param model problem object
634     * @return vector with best solution found
635     **/
636COINLIBAPI const double *COINLINKAGE
637Cbc_getColSolution(Cbc_Model *model);
638
639
640/** @brief Best known bound on the optimal objective value
641     *
642     * @param model problem object
643     * @return best possible cost (lower bound)
644     **/
645COINLIBAPI double COINLINKAGE
646Cbc_getBestPossibleObjValue(Cbc_Model *model);
647
648/** @brief Best integer feasible solution
649     *
650     * Best integer feasible solution or NULL if no integer feas sol found
651     *
652     * @param model problem object
653     * @return vector with the best solution found or NULL if no feasible solution was found
654     **/
655COINLIBAPI double *COINLINKAGE
656Cbc_bestSolution(Cbc_Model *model);
657
658/** @brief number of integer feasible solution saved
659     *
660     * @param model problem object
661     * @return number of saved solutions
662     **/
663COINLIBAPI int COINLINKAGE
664Cbc_numberSavedSolutions(Cbc_Model *model);
665
666/** @brief Vector with the i-th saved solution
667     *
668     * @param model problem object
669     * @param whichSol index of the solution to be retrieved
670     * @return vector with integer feasible solution
671     **/
672COINLIBAPI const double *COINLINKAGE
673Cbc_savedSolution(Cbc_Model *model, int whichSol);
674
675/** @brief Cost of the whichSol solution
676     *
677     * @param model problem object
678     * @param whichSol solution index
679     * @return solution cost
680     **/
681COINLIBAPI double COINLINKAGE
682Cbc_savedSolutionObj(Cbc_Model *model, int whichSol);
683
684/** @brief Queries vector of reduced costs
685     *
686     * @param model problem object
687     * @return reduced cost vector
688     **/
689COINLIBAPI const double *COINLINKAGE
690Cbc_getReducedCost(Cbc_Model *model);
691
692/** If optimization was abandoned due to numerical difficulties
693     *
694     * @param model problem object
695     * @return 1 if numerical difficulties interrupted the optimization, 0 otherwise
696     * */
697COINLIBAPI int COINLINKAGE
698Cbc_isAbandoned(Cbc_Model *model);
699
700/** @brief If the optimal solution was found
701     *
702     * @param model problem object
703     * @return 1 if optimal solution was found, 0 otherwise
704     **/
705COINLIBAPI int COINLINKAGE
706Cbc_isProvenOptimal(Cbc_Model *model);
707
708/** @brief If infeasibility was proven
709     *
710     * If model is infeasible, please note that infeasibility can also be declared
711     * if cutoff is informed and no solution better than the cutoff exists.
712     *
713     * @param model problem object
714     * @return 1 if model is infeasible, 0 otherwise
715     **/
716COINLIBAPI int COINLINKAGE
717Cbc_isProvenInfeasible(Cbc_Model *model);
718
719/** @brief Is continuous model unbounded ?
720    *
721    * @param model problem object
722    * @return 1 if model is unbounded, 0 otherwise
723    * */
724COINLIBAPI int COINLINKAGE
725Cbc_isContinuousUnbounded(Cbc_Model *model);
726
727/** Objective value of best feasible solution
728     *
729     * @param model problem object
730     * @return cost of the best solution found
731     * */
732COINLIBAPI double COINLINKAGE
733Cbc_getObjValue(Cbc_Model *model);
734
735/** @brief Final optimization status
736     *
737     * Returns the optimization status. For more info check function
738     * isProvenOptimal, isProvenInfeasible, etc. Check also secondary status.
739     * Possible status are:
740     *
741     * -1 before branchAndBound
742     * 0 finished - check isProvenOptimal or isProvenInfeasible to see if solution found (or check value of best solution)
743     * 1 stopped - on maxnodes, maxsols, maxtime
744     * 2 execution abandoned due to numerical dificulties
745     * 5 user programmed interruption
746     *
747     * @param model problem object
748     * @return problem status
749    */
750COINLIBAPI int COINLINKAGE Cbc_status(Cbc_Model *model);
751
752/** @brief Secondary status of problem
753     *
754     * Returns additional information regarding the optimization status
755     *
756     * -1 unset (status_ will also be -1)
757     *  0 search completed with solution
758     *  1 linear relaxation not feasible (or worse than cutoff)
759     *  2 stopped on gap
760     *  3 stopped on nodes
761     *  4 stopped on time
762     *  5 stopped on user event
763     *  6 stopped on solutions
764     *  7 linear relaxation unbounded
765     *  8 stopped on iteration limit
766     *
767     *  @model problem object
768     *  @return optimization status
769    */
770COINLIBAPI int COINLINKAGE
771Cbc_secondaryStatus(Cbc_Model *model);
772
773/** Sum of primal infeasibilities */
774COINLIBAPI double COINLINKAGE
775Cbc_sumPrimalInfeasibilities(Cbc_Model *model);
776
777/** Number of primal infeasibilities */
778COINLIBAPI int COINLINKAGE
779Cbc_numberPrimalInfeasibilities(Cbc_Model *model);
780
781/** Just check solution (for external use) - sets sum of
782        infeasibilities etc */
783COINLIBAPI void COINLINKAGE
784Cbc_checkSolution(Cbc_Model *model);
785
786/** Number of iterations */
787COINLIBAPI int COINLINKAGE
788Cbc_getIterationCount(Cbc_Model *model);
789
790/** Node limit reached? */
791COINLIBAPI int COINLINKAGE
792Cbc_isNodeLimitReached(Cbc_Model *model);
793/** Time limit reached? */
794COINLIBAPI int COINLINKAGE
795Cbc_isSecondsLimitReached(Cbc_Model *model);
796/** Solution limit reached? */
797COINLIBAPI int COINLINKAGE
798Cbc_isSolutionLimitReached(Cbc_Model *model);
799/** Are there numerical difficulties (for initialSolve) ? */
800COINLIBAPI int COINLINKAGE
801Cbc_isInitialSolveAbandoned(Cbc_Model *model);
802/** Is optimality proven (for initialSolve) ? */
803COINLIBAPI int COINLINKAGE
804Cbc_isInitialSolveProvenOptimal(Cbc_Model *model);
805/** Is primal infeasiblity proven (for initialSolve) ? */
806COINLIBAPI int COINLINKAGE
807Cbc_isInitialSolveProvenPrimalInfeasible(Cbc_Model *model);
808/** "row" solution
809     *  This is the vector A*x, where A is the constraint matrix
810     *  and x is the current solution. */
811COINLIBAPI const double *COINLINKAGE
812Cbc_getRowActivity(Cbc_Model *model);
813/** Number of nodes explored in B&B tree */
814COINLIBAPI int COINLINKAGE
815Cbc_getNodeCount(Cbc_Model *model);
816/** Print the solution */
817COINLIBAPI void COINLINKAGE
818Cbc_printSolution(Cbc_Model *model);
819
820/*@}*/
821
822/** \name OsiSolverInterface related routines (used in callbacks) */
823//@{
824
825/** @brief Returns number of cols in OsiSolverInterface object */
826COINLIBAPI int COINLINKAGE
827Osi_getNumCols( void *osi );
828
829/** @brief Returns column name in OsiSolverInterface object */
830COINLIBAPI void COINLINKAGE
831Osi_getColName( void *osi, int i, char *name, int maxLen );
832
833/** @brief Returns column lower bounds in OsiSolverInterface object */
834COINLIBAPI const double * COINLINKAGE
835Osi_getColLower( void *osi );
836
837/** @brief Returns column upper bounds in OsiSolverInterface object */
838COINLIBAPI const double * COINLINKAGE
839Osi_getColUpper( void *osi );
840
841/** @brief Returns integrality information for columns in OsiSolverInterface object */
842COINLIBAPI int COINLINKAGE
843Osi_isInteger( void *osi, int col );
844
845/** @brief Returns number of rows in OsiSolverInterface object */
846COINLIBAPI int COINLINKAGE
847Osi_getNumRows( void *osi );
848
849COINLIBAPI int COINLINKAGE
850Osi_getRowNz(void *osi, int row);
851
852/** @brief Indices of variables that appear on a row */
853COINLIBAPI const int *COINLINKAGE
854Osi_getRowIndices(void *osi, int row);
855
856/** @brief Coefficients of variables that appear on this row
857     *
858     * @param model problem object
859     * @param row row index
860     * @return coefficients of variables that appear on this row
861     **/
862COINLIBAPI const double *COINLINKAGE
863Osi_getRowCoeffs(void *osi, int row);
864
865/** @brief Right hand side of a row
866     *
867     * @param model problem object
868     * @param row row index
869     * @return row right hand side
870     **/
871COINLIBAPI double COINLINKAGE
872Osi_getRowRHS(void *osi, int row);
873
874/** @brief Sense a row
875     * @param model problem object
876     * @param row row index
877     * @return row sense: E for =, L for <=, G for >= and R for ranged row
878     **/
879COINLIBAPI char COINLINKAGE
880Osi_getRowSense(void *osi, int row);
881
882/** @brief Returns solution vector in OsiSolverInterface object */
883COINLIBAPI const double * COINLINKAGE
884Osi_getColSolution( void *osi );
885
886
887/*@}*/
888
889/** \name OsiCuts related routines (used in callbacks) */
890//@{
891
892/** adds a row cut (used in callback) */
893COINLIBAPI void COINLINKAGE
894OsiCuts_addRowCut( void *osiCuts, int nz, const int *idx, const double *coef, char sense, double rhs );
895
896/*@}*/
897
898#ifdef __cplusplus
899}
900#endif
901#endif
902
903/* vi: softtabstop=2 shiftwidth=2 expandtab tabstop=2
904*/
Note: See TracBrowser for help on using the repository browser.