Changeset 2461 for trunk/Cbc


Ignore:
Timestamp:
Dec 31, 2018 7:05:04 PM (12 months ago)
Author:
unxusr
Message:

doc for C interface

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/Cbc/src/Cbc_C_Interface.h

    r2460 r2461  
    219219    ;
    220220
     221    /** @brief Creates a copy of the current model
     222     *
     223     * @param model problem object
     224     * @return model copy
     225     **/
     226    COINLIBAPI Cbc_Model * COINLINKAGE
     227    Cbc_clone(Cbc_Model * model)
     228    ;
     229
     230
    221231    //@}
    222232   
    223     /** \name Routines to query problem contents
    224     */
    225     //@{
     233/** \name Routines to query problem contents
     234*/
     235//@{
    226236
    227237 
     
    517527    Cbc_printModel(Cbc_Model * model, const char * argPrefix)
    518528    ;
    519     /** Return a copy of this model */
    520     COINLIBAPI Cbc_Model * COINLINKAGE
    521     Cbc_clone(Cbc_Model * model)
    522     ;
    523529    /*@}*/
    524530
     
    560566
    561567
    562     /**@name Accessing the solution and solution status */
    563     /*@{*/
     568/**@name Accessing the solution and optimization status */
     569/*@{*/
    564570
    565571    /** @brief Best feasible solution vector
     
    611617    Cbc_savedSolution(Cbc_Model * model, int whichSol)
    612618    ;
    613 
    614619   
    615620    /** @brief Cost of the whichSol solution
     
    632637    ;
    633638
     639    /** If optimization was abandoned due to numerical difficulties
     640     *
     641     * @param model problem object
     642     * @return 1 if numerical difficulties interrupted the optimization, 0 otherwise
     643     * */
     644    COINLIBAPI int COINLINKAGE
     645    Cbc_isAbandoned(Cbc_Model * model)
     646    ;
     647
     648    /** @brief If the optimal solution was found
     649     *
     650     * @param model problem object
     651     * @return 1 if optimal solution was found, 0 otherwise
     652     **/
     653    COINLIBAPI int COINLINKAGE
     654    Cbc_isProvenOptimal(Cbc_Model * model)
     655    ;
     656
     657    /** @brief If infeasibility was proven
     658     *
     659     * If model is infeasible, please note that infeasibility can also be declared
     660     * if cutoff is informed and no solution better than the cutoff exists.
     661     *
     662     * @param model problem object
     663     * @return 1 if model is infeasible, 0 otherwise
     664     **/
     665    COINLIBAPI int COINLINKAGE
     666    Cbc_isProvenInfeasible(Cbc_Model * model)
     667    ;
     668
     669   /** @brief Is continuous model unbounded ?
     670    *
     671    * @param model problem object
     672    * @return 1 if model is unbounded, 0 otherwise
     673    * */
     674    COINLIBAPI int COINLINKAGE
     675    Cbc_isContinuousUnbounded(Cbc_Model * model)
     676    ;
     677
     678    /** Objective value of best feasible solution
     679     *
     680     * @param model problem object
     681     * @return cost of the best solution found
     682     * */
     683    COINLIBAPI double COINLINKAGE
     684    Cbc_getObjValue(Cbc_Model * model)
     685    ;
     686
     687    /** @brief Final optimization status
     688     *
     689     * Returns the optimization status. For more info check function
     690     * isProvenOptimal, isProvenInfeasible, etc. Check also secondary status.
     691     * Possible status are:
     692     *
     693     * -1 before branchAndBound
     694     * 0 finished - check isProvenOptimal or isProvenInfeasible to see if solution found (or check value of best solution)
     695     * 1 stopped - on maxnodes, maxsols, maxtime
     696     * 2 execution abandoned due to numerical dificulties
     697     * 5 user programmed interruption
     698     *
     699     * @param model problem object
     700     * @return problem status
     701    */
     702    COINLIBAPI int COINLINKAGE Cbc_status(Cbc_Model * model) ;
     703
     704    /** @brief Secondary status of problem
     705     *
     706     * Returns additional information regarding the optimization status
     707     *
     708     * -1 unset (status_ will also be -1)
     709     *  0 search completed with solution
     710     *  1 linear relaxation not feasible (or worse than cutoff)
     711     *  2 stopped on gap
     712     *  3 stopped on nodes
     713     *  4 stopped on time
     714     *  5 stopped on user event
     715     *  6 stopped on solutions
     716     *  7 linear relaxation unbounded
     717     *  8 stopped on iteration limit
     718     *
     719     *  @model problem object
     720     *  @return optimization status
     721    */
     722    COINLIBAPI int COINLINKAGE
     723    Cbc_secondaryStatus(Cbc_Model * model)
     724    ;
     725 
    634726    /** Sum of primal infeasibilities */
    635727    COINLIBAPI double COINLINKAGE
     
    652744    Cbc_getIterationCount(Cbc_Model * model)
    653745    ;
    654     /** Are there a numerical difficulties? */
    655     COINLIBAPI int COINLINKAGE
    656     Cbc_isAbandoned(Cbc_Model * model)
    657     ;
    658     /** Is optimality proven? */
    659     COINLIBAPI int COINLINKAGE
    660     Cbc_isProvenOptimal(Cbc_Model * model)
    661     ;
    662     /** Is infeasiblity proven (or none better than cutoff)? */
    663     COINLIBAPI int COINLINKAGE
    664     Cbc_isProvenInfeasible(Cbc_Model * model)
    665     ;
    666     /** Was continuous solution unbounded? */
    667     COINLIBAPI int COINLINKAGE
    668     Cbc_isContinuousUnbounded(Cbc_Model * model)
    669     ;
     746
    670747    /** Node limit reached? */
    671748    COINLIBAPI int COINLINKAGE
     
    698775    Cbc_getRowActivity(Cbc_Model * model)
    699776    ;
    700     /** Objective value of best feasible solution */
    701     COINLIBAPI double COINLINKAGE
    702     Cbc_getObjValue(Cbc_Model * model)
    703     ;
    704777    /** Number of nodes explored in B&B tree */
    705778    COINLIBAPI int COINLINKAGE
     
    710783    Cbc_printSolution(Cbc_Model * model)
    711784    ;
    712     /** Final status of problem
    713         Some of these can be found out by is...... functions
    714         -1 before branchAndBound
    715         0 finished - check isProvenOptimal or isProvenInfeasible to see if solution found
    716         (or check value of best solution)
    717         1 stopped - on maxnodes, maxsols, maxtime
    718         2 difficulties so run was abandoned
    719         (5 event user programmed event occurred)
    720     */
    721     COINLIBAPI int COINLINKAGE
    722     Cbc_status(Cbc_Model * model)
    723     ;
    724     /** Secondary status of problem
    725         -1 unset (status_ will also be -1)
    726         0 search completed with solution
    727         1 linear relaxation not feasible (or worse than cutoff)
    728         2 stopped on gap
    729         3 stopped on nodes
    730         4 stopped on time
    731         5 stopped on user event
    732         6 stopped on solutions
    733         7 linear relaxation unbounded
    734         8 stopped on iteration limit
    735     */
    736     COINLIBAPI int COINLINKAGE
    737     Cbc_secondaryStatus(Cbc_Model * model)
    738     ;
     785
    739786    /*@}*/
    740787#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.