source: html/trunk/Clp/userguide/ch02s06.html @ 956

Last change on this file since 956 was 956, checked in by ddelanu, 16 years ago

First revision of user guide

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.2 KB
RevLine 
[956]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.65.1"><link rel="home" href="index.html" title="CLP User Manual"><link rel="up" href="ch02.html" title="Chapter 2. 
2  Basic Model Classes
3  "><link rel="previous" href="ch02s05.html" title="Tolerances"><link rel="next" href="ch02s07.html" title="
4  Simplex-specific Methods
5  "></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="ch02s05.html">Prev</a> </td><th width="60%" align="center">Chapter 2. 
6  Basic Model Classes
7  </th><td width="20%" align="right"> <a accesskey="n" href="ch02s07.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="id4758484"></a>Some Useful Set and Get Methods</h2></div></div><div></div></div><div class="table"><a name="id4758490"></a><p class="title"><b>Table 2.2. 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>
8    Method(s)
9    </th><th>
10    Description
11    </th></tr></thead><tbody><tr><td align="left" valign="top"><tt class="function">setMaximumIterations(int value)</tt><br><tt class="function">int maximumIterations()</tt><br><tt class="function">setMaximumSeconds(double value)</tt><br><tt class="function">double maximumIterations()</tt></td><td align="left" valign="top">
12      These methods tell CLP to stop after a given number of iterations or
13      seconds (and returns these values).
14      </td></tr><tr><td align="left" valign="top"><tt class="function">double objectiveValue()</tt></td><td align="left" valign="top">
15      This method returns the objective value.
16      </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">
17      These methods return the objective coefficients.
18      </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">
19      These methods give lower and upper bounds on row and column activities.
20      </td></tr><tr><td align="left" valign="top"><tt class="function">double * infeasibilityRay()</tt><br><tt class="function">double * unboundedRay()</tt></td><td align="left" valign="top">
21      If the problem was primal or dual infeasible, these methods will give a
22      pointer to a ray proving infeasibility.
23      </td></tr><tr><td align="left" valign="top"><tt class="function">CoinPackMatrix * matrix()</tt></td><td align="left" valign="top">
24      There are more options as the user has great flexibility in how the problem
25      matrix is stored, but the default matrix class is
26      <tt class="classname">CoinPackedMatrix</tt> (see
27      <a href="ch03s02.html" title="Matrix Classes">the section called &#8220;Matrix Classes&#8221;</a>).
28      So we have that this method returns a pointer to a
29      <tt class="classname">CoinPackedMatrix</tt> which can be further manipulated.
30      </td></tr><tr><td align="left" valign="top"><tt class="function">CoinBigIndex getNumElements()</tt><sup>[<a name="id4758792" href="#ftn.id4758792">a</a>]</sup></td><td align="left" valign="top">
31      Returns the number of elements in the problem matrix.
32      </td></tr><tr><td align="left" valign="top"><tt class="function">void setOptimizationDirection(double value)</tt><br><tt class="function">double optimizationDirection()</tt></td><td align="left" valign="top">
33      These methods set and get the objective sense.  The parameter
34      <i class="parameter"><tt>value</tt></i> should be +1 to minimize, -1 to maximize,
35      and 0 to ignore.
36      </td></tr></tbody><tbody class="footnotes"><tr><td colspan="2"><div class="footnote"><p><sup>[<a name="ftn.id4758792" href="#id4758792">a</a>] </sup>
37        <span class="type">CoinBigIndex</span> is a <tt class="function">typedef</tt> which in
38        most cases is the same as <span class="type">int</span>.
39        </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="ch02s05.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="ch02s07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Tolerances </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 
40  Simplex-specific Methods
41  </td></tr></table></div></body></html>
Note: See TracBrowser for help on using the repository browser.