source: html/trunk/Cbc/ch02s04.html @ 554

Last change on this file since 554 was 554, checked in by rlh, 16 years ago

initial import of Cbc documentation

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.8 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Some Useful Set and Get Methods</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.2"><link rel="home" href="index.html" title="CBC User Guide"><link rel="up" href="ch02.html" title="Chapter 2. 
2  Basic Model Classes
3  "><link rel="previous" href="ch02s03.html" title="
4  Getting at the Solution (CbcModel methods)
5  "><link rel="next" href="ch02s05.html" title="
6  Methods which have a major impact on solution process
7  "></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Some Useful Set and Get Methods</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s03.html">Prev</a> </td><th width="60%" align="center">Chapter 2. 
8  Basic Model Classes
9  </th><td width="20%" align="right"> <a accesskey="n" href="ch02s05.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="setsandgets"></a>Some Useful Set and Get Methods</h2></div></div><div></div></div><div class="table"><a name="id2898616"></a><p class="title"><b>Table 2.4. Some Useful Set and Get Methods</b></p><table summary="Some Useful Set and Get Methods" border="0"><colgroup><col><col></colgroup><thead><tr><th>
10    Method(s)
11    </th><th>
12    Description
13    </th></tr></thead><tbody><tr><td align="left" valign="top"><tt class="function">setMaximumNodes(int value)</tt><br><tt class="function">int maximumNodes()</tt><br><tt class="function">setMaximumSeconds(double value)</tt><br><tt class="function">double maximumSeconds()</tt><tt class="function">setMaximumSolutions(double value)</tt><br><tt class="function">double maximumSolutions()</tt></td><td align="left" valign="top">
14      These methods tell CBC to stop after a given number of nodes or
15      seconds or solutions (and returns these values).
16      </td></tr><tr><td align="left" valign="top"><tt class="function">setIntegerTolerance(double)</tt><br><tt class="function">double getIntegerTolerance()</tt></td><td align="left" valign="top">
17      An integer variable
18      is deemed to be at an integral value if it is no further than this tolerance
19      away.
20      </td></tr><tr><td align="left" valign="top"><tt class="function">setAllowableGap(double)</tt><br><tt class="function">double getAllowableGap()</tt><br><tt class="function">setAllowablePercentageGap(double)</tt><br><tt class="function">double getAllowablePercentageGap()</tt><br><tt class="function">setAllowableFractionGap(double)</tt><br><tt class="function">double getAllowableFractionGap()</tt><br></td><td align="left" valign="top">
21      CbcModel returns if the gap between the best known solution and the best
22      possible solution is less than this (or as a percentage or fraction).
23      </td></tr><tr><td align="left" valign="top"><tt class="function">setNumberStrong(double) </tt><br><tt class="function">int numberStrong() </tt></td><td align="left" valign="top">
24      Get or set the maximum number of candidates at a node to
25      be evaluated for strong branching.
26      </td></tr><tr><td align="left" valign="top"><tt class="function">setPrintFrequency(int) </tt><br><tt class="function">int printFrequency()</tt></td><td align="left" valign="top">
27      Controls the number of nodes evaluated between status prints.
28      Print frequency has very slight overhead if small.
29      </td></tr><tr><td align="left" valign="top"><tt class="function">int getNodeCount() </tt></td><td align="left" valign="top">
30      Returns number of nodes search took
31      </td></tr><tr><td align="left" valign="top"><tt class="function">int numberRowsAtContinuous()</tt></td><td align="left" valign="top">
32      Returns number of rows at continuous
33      </td></tr><tr><td align="left" valign="top"><tt class="function">int  numberIntegers()</tt><br><tt class="function">const int * integerVariable()</tt></td><td align="left" valign="top">
34      Returns number of integers and an array giving which ones
35      </td></tr><tr><td align="left" valign="top"><tt class="function">bool  isBinary(int)</tt><br><tt class="function">bool  isContinuous(int)</tt><br><tt class="function">const bool isInteger(int)</tt></td><td align="left" valign="top">
36      Returns information on a variable.  You can use Osi methods
37      to set these attributes (before handing to CbcModel)
38      </td></tr><tr><td align="left" valign="top"><tt class="function">double getObjValue()</tt></td><td align="left" valign="top">
39      This method returns the best objective value.so far
40      </td></tr><tr><td align="left" valign="top"><tt class="function">double getCurrentObjValue()</tt></td><td align="left" valign="top">
41      This method returns the current objective value.
42      </td></tr><tr><td align="left" valign="top"><tt class="function">const double * getObjCoefficients()</tt><br><tt class="function">double * objective()</tt></td><td align="left" valign="top">
43      These methods return the objective coefficients.
44      </td></tr><tr><td align="left" valign="top"><tt class="function">const double * getRowLower()</tt><br><tt class="function">double * rowLower()</tt><br><tt class="function">const double * getRowUpper()</tt><br><tt class="function">double * rowUpper()</tt><br><tt class="function">const double * getColLower()</tt><br><tt class="function">double * columnLower()</tt><br><tt class="function">const double * getColUpper()</tt><br><tt class="function">double * columnUpper()</tt></td><td align="left" valign="top">
45      These methods give lower and upper bounds on row and column activities.
46      </td></tr><tr><td align="left" valign="top"><tt class="function">const CoinPackMatrix * getMatrixByRow()</tt></td><td align="left" valign="top">
47      This method returns a pointer to a row copy of matrix
48      <tt class="classname">CoinPackedMatrix</tt> which can be further examined.
49      </td></tr><tr><td align="left" valign="top"><tt class="function">const CoinPackMatrix * getMatrixByCol()</tt></td><td align="left" valign="top">
50      This method returns a pointer to a column copy of matrix
51      <tt class="classname">CoinPackedMatrix</tt> which can be further examined.
52      </td></tr><tr><td align="left" valign="top"><tt class="function">CoinBigIndex getNumElements()</tt><sup>[<a name="id2899440" href="#ftn.id2899440">a</a>]</sup></td><td align="left" valign="top">
53      Returns the number of elements in the problem matrix.
54      </td></tr><tr><td align="left" valign="top"><tt class="function">void setObjSense(double value)</tt><br><tt class="function">double objSense()</tt></td><td align="left" valign="top">
55      These methods set and get the objective sense.  The parameter
56      <i class="parameter"><tt>value</tt></i> should be +1 to minimize and -1 to maximize.
57      </td></tr></tbody><tbody class="footnotes"><tr><td colspan="2"><div class="footnote"><p><sup>[<a name="ftn.id2899440" href="#id2899440">a</a>] </sup>
58        <span class="type">CoinBigIndex</span> is a <tt class="function">typedef</tt> which in
59        most cases is the same as <span class="type">int</span>.
60        </p></div></td></tr></tbody></table></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch02s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">
61  Getting at the Solution (CbcModel methods)
62   </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 
63  Methods which have a major impact on solution process
64  </td></tr></table></div></body></html>
Note: See TracBrowser for help on using the repository browser.