COIN-OR::LEMON - Graph Library

Changeset 584:33c6b6e755cd in lemon-main for lemon/lp_base.h


Ignore:
Timestamp:
04/15/09 02:04:37 (15 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Small doc improvements (#263)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/lp_base.h

    r576 r584  
    5353    ///Possible outcomes of an LP solving procedure
    5454    enum SolveExitStatus {
    55       ///This means that the problem has been successfully solved: either
     55      /// = 0. It means that the problem has been successfully solved: either
    5656      ///an optimal solution has been found or infeasibility/unboundedness
    5757      ///has been proved.
    5858      SOLVED = 0,
    59       ///Any other case (including the case when some user specified
    60       ///limit has been exceeded)
     59      /// = 1. Any other case (including the case when some user specified
     60      ///limit has been exceeded).
    6161      UNSOLVED = 1
    6262    };
     
    7272    ///Enum for \c messageLevel() parameter
    7373    enum MessageLevel {
    74       /// no output (default value)
     74      /// No output (default value).
    7575      MESSAGE_NOTHING,
    76       /// error messages only
     76      /// Error messages only.
    7777      MESSAGE_ERROR,
    78       /// warnings
     78      /// Warnings.
    7979      MESSAGE_WARNING,
    80       /// normal output
     80      /// Normal output.
    8181      MESSAGE_NORMAL,
    82       /// verbose output
     82      /// Verbose output.
    8383      MESSAGE_VERBOSE
    8484    };
     
    10061006    const char* solverName() const {return _solverName();}
    10071007
    1008     ///\name Build up and modify the LP
     1008    ///\name Build Up and Modify the LP
    10091009
    10101010    ///@{
     
    17891789    /// The problem types for primal and dual problems
    17901790    enum ProblemType {
    1791       ///Feasible solution hasn't been found (but may exist).
     1791      /// = 0. Feasible solution hasn't been found (but may exist).
    17921792      UNDEFINED = 0,
    1793       ///The problem has no feasible solution
     1793      /// = 1. The problem has no feasible solution.
    17941794      INFEASIBLE = 1,
    1795       ///Feasible solution found
     1795      /// = 2. Feasible solution found.
    17961796      FEASIBLE = 2,
    1797       ///Optimal solution exists and found
     1797      /// = 3. Optimal solution exists and found.
    17981798      OPTIMAL = 3,
    1799       ///The cost function is unbounded
     1799      /// = 4. The cost function is unbounded.
    18001800      UNBOUNDED = 4
    18011801    };
     
    18531853    ///@}
    18541854
    1855     ///\name Obtain the solution
     1855    ///\name Obtain the Solution
    18561856
    18571857    ///@{
     
    19751975    /// The problem types for MIP problems
    19761976    enum ProblemType {
    1977       ///Feasible solution hasn't been found (but may exist).
     1977      /// = 0. Feasible solution hasn't been found (but may exist).
    19781978      UNDEFINED = 0,
    1979       ///The problem has no feasible solution
     1979      /// = 1. The problem has no feasible solution.
    19801980      INFEASIBLE = 1,
    1981       ///Feasible solution found
     1981      /// = 2. Feasible solution found.
    19821982      FEASIBLE = 2,
    1983       ///Optimal solution exists and found
     1983      /// = 3. Optimal solution exists and found.
    19841984      OPTIMAL = 3,
    1985       ///The cost function is unbounded
    1986       ///
    1987       ///The Mip or at least the relaxed problem is unbounded
     1985      /// = 4. The cost function is unbounded.
     1986      ///The Mip or at least the relaxed problem is unbounded.
    19881987      UNBOUNDED = 4
    19891988    };
     
    20072006    ///@}
    20082007
    2009     ///\name Setting column type
     2008    ///\name Set Column Type
    20102009    ///@{
    20112010
    20122011    ///Possible variable (column) types (e.g. real, integer, binary etc.)
    20132012    enum ColTypes {
    2014       ///Continuous variable (default)
     2013      /// = 0. Continuous variable (default).
    20152014      REAL = 0,
    2016       ///Integer variable
     2015      /// = 1. Integer variable.
    20172016      INTEGER = 1
    20182017    };
     
    20352034    ///@}
    20362035
    2037     ///\name Obtain the solution
     2036    ///\name Obtain the Solution
    20382037
    20392038    ///@{
Note: See TracChangeset for help on using the changeset viewer.