Changeset 1600 for trunk/Cbc


Ignore:
Timestamp:
Feb 19, 2011 2:24:26 PM (9 years ago)
Author:
lou
Message:

Kill off doxydoc complaints.

Location:
trunk/Cbc/src
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/Cbc/src/CbcClique.hpp

    r1573 r1600  
    1313  A clique is defined to be a set of binary variables where fixing any one
    1414  variable to its `strong' value fixes all other variables. An example is the
    15   most common SOS1 construction: a set of binary variables x<j> s.t.  SUM{j}
    16   x<j> = 1.  Setting any one variable to 1 forces all other variables to 0.
     15  most common SOS1 construction: a set of binary variables x_j s.t.  SUM{j}
     16  x_j = 1.  Setting any one variable to 1 forces all other variables to 0.
    1717  (See comments for CbcSOS below.)
    1818
     
    2525  of mind, here's an example.
    2626 
    27   Consider the following sequence, where x<i> = (1-y<i>):
     27  Consider the following sequence, where x_j = (1-y_j):
     28  \verbatim
    2829     x1 + x2 + x3 <=  1         all strong at 1
    2930     x1 - y2 + x3 <=  0         y2 strong at 0; x1, x3 strong at 1
    3031    -y1 - y2 + x3 <= -1         y1, y2 strong at 0, x3 strong at 1
    3132    -y1 - y2 - y3 <= -2         all strong at 0
     33  \endverbatim
    3234  The first line is a standard SOS1 on binary variables.
    3335 
    3436  Variables with +1 coefficients are `SOS-style' and variables with -1
    35   coefficients are `non-SOS-style'. So numberNonSOSMembers_ simply tells you
     37  coefficients are `non-SOS-style'. So #numberNonSOSMembers_ simply tells you
    3638  how many variables have -1 coefficients. The implicit rhs for a clique is
    3739  1-numberNonSOSMembers_.
    3840*/
    39 
    40 /// Define a clique class
    41 
    4241class CbcClique : public CbcObject {
    4342
    4443public:
    4544
    46     // Default Constructor
     45    /// Default Constructor
    4746    CbcClique ();
    4847
    49   /** Useful constructor (which are integer indices) slack can denote a slack
    50   // Useful constructor (which are integer indices)
    51       in set.  If type == NULL then as if 1
    52   */
     48    /** Useful constructor (which are integer indices) slack can denote a slack
     49        in set.  If type == NULL then as if 1
     50    */
    5351    CbcClique (CbcModel * model, int cliqueType, int numberMembers,
    5452               const int * which, const char * type,
    5553               int identifier, int slack = -1);
    5654
    57     // Copy constructor
     55    /// Copy constructor
    5856    CbcClique ( const CbcClique &);
    5957
     
    6159    virtual CbcObject * clone() const;
    6260
    63     // Assignment operator
     61    /// Assignment operator
    6462    CbcClique & operator=( const CbcClique& rhs);
    6563
    66     // Destructor
     64    /// Destructor
    6765    virtual ~CbcClique ();
    6866
     
    8179        return numberMembers_;
    8280    }
    83         /** \brief Number of variables with -1 coefficient
    84          
    85           Original comment: Number of Non SOS members i.e. fixing to zero is strong.
    86           See comments at head of class, and comments for type_.
    87         */
    88 
     81    /** \brief Number of variables with -1 coefficient
     82     
     83      Number of non-SOS members, i.e., fixing to zero is strong.
     84      See comments at head of class, and comments for #type_.
     85    */
    8986    inline int numberNonSOSMembers() const {
    9087        return numberNonSOSMembers_;
     
    9693    }
    9794
    98     /** \brief Type of each member, i.e. which way is strong
     95    /*! \brief Type of each member, i.e., which way is strong.
    9996 
    100     This also specifies whether a variable has a +1 or -1 coefficient.
    101       0 => -1 coefficient, 0 is strong value
    102       1 -> +1 coefficient, 1 is strong value
    103     If unspecified, all coefficients are assumed to be positive.
    104    
    105     Indexed as 0 .. numberMembers_-1
    106     */
    107         inline char type(int index) const {
     97      This also specifies whether a variable has a +1 or -1 coefficient.
     98        - 0 => -1 coefficient, 0 is strong value
     99        - 1 => +1 coefficient, 1 is strong value
     100      If unspecified, all coefficients are assumed to be positive.
     101     
     102      Indexed as 0 .. numberMembers_-1
     103    */
     104    inline char type(int index) const {
    108105        if (type_) return type_[index];
    109106        else return 1;
    110107    }
    111108
    112     /// Clique type - 0 <=, 1 ==
     109    /// Clique type: 0 is <=, 1 is ==
    113110    inline int cliqueType() const {
    114111        return cliqueType_;
     
    131128
    132129      This also specifies whether a variable has a +1 or -1 coefficient.
    133         0 => -1 coefficient, 0 is strong value
    134         1 -> +1 coefficient, 1 is strong value
     130        - 0 => -1 coefficient, 0 is strong value
     131        - 1 => +1 coefficient, 1 is strong value
    135132      If unspecified, all coefficients are assumed to be positive.
    136133   
  • trunk/Cbc/src/CbcEventHandler.hpp

    r1590 r1600  
    1 /*! \legal
     1/*
    22  Copyright (C) 2006, International Business Machines Corporation and others.
    33  All Rights Reserved.
  • trunk/Cbc/src/CbcGenMessages.hpp

    r1573 r1600  
    1 /*! \legal
     1/*
    22  Copyright (C) 2007
    33  Lou Hafer, International Business Machines Corporation and others. All
     
    55
    66  This code is licensed under the terms of the Eclipse Public License (EPL).
    7 
    8   $Id$
    97*/
    108/*
  • trunk/Cbc/src/CbcHeuristic.hpp

    r1573 r1600  
    297297        return numCouldRun_;
    298298    }
    299     /** Clone but ..
    300         type 0 clone solver, 1 clone continuous solver
    301         Add 2 to say without integer variables which are at low priority
    302         Add 4 to say quite likely infeasible so give up easily.*/
     299    /*! \brief Clone, but ...
     300
     301      If type is
     302        - 0 clone the solver for the model,
     303        - 1 clone the continuous solver for the model
     304        - Add 2 to say without integer variables which are at low priority
     305        - Add 4 to say quite likely infeasible so give up easily (clp only).
     306    */
    303307    OsiSolverInterface * cloneBut(int type);
    304308protected:
  • trunk/Cbc/src/CbcSolver.hpp

    r1573 r1600  
    277277    /*! \brief Export
    278278
    279       \param mode
     279      Values for mode:
    280280      - 1 OsiClpSolver
    281281      - 2 CbcModel
     
    357357    /*! \brief Import
    358358
    359       \param whereFrom
     359      Values for whereFrom:
    360360       - 1 after initial solve by dualsimplex etc
    361361       - 2 after preprocessing
  • trunk/Cbc/src/CbcSolverHeuristics.hpp

    r1573 r1600  
    55
    66
    7 /*! \file CbcSolverHeuristic.hpp
     7/*! \file CbcSolverHeuristics.hpp
    88    \brief Routines for doing heuristics.
    99*/
  • trunk/Cbc/src/Cbc_C_Interface.h

    r1573 r1600  
    175175    Cbc_problemName(Cbc_Model * model, int maxNumberCharacters, char * array)
    176176    ;
    177     /** Sets problem name.  Must have \0 at end.  */
     177    /** Sets problem name.
     178   
     179      \p array must be a null-terminated string.
     180    */
    178181    COINLIBAPI int COINLINKAGE
    179182    Cbc_setProblemName(Cbc_Model * model, int maxNumberCharacters, char * array)
Note: See TracChangeset for help on using the changeset viewer.