COIN-OR::LEMON - Graph Library

Changeset 1624:61cc647dac99 in lemon-0.x for doc


Ignore:
Timestamp:
08/11/05 16:31:06 (14 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2132
Message:

Several docfices

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/named-param.dox

    r1619 r1624  
    1 *!
     1/*!
    22
    33\page named-param Named Parameters
    44
    5 \section named-func-param Named "Function" Parameters
     5\section named-func-param Named Function Parameters
    66
    77C++ makes it possible to use default parameter values when calling a
     
    4343The usage is the following.
    4444
    45 We have to define a class, let's call it named_fn.  Let us assume that
    46 we would like to use a parameter, called X. In the named_fn class we
    47 have to define an _X attribute, and a function X. The function
    48 expects a parameter with the type of _X, and sets the value of
    49 _X. After setting the value the function returns the class itself. The
    50 class also have to have a function, called for example run(), we have
     45We have to define a class, let's call it \c named_fn.  Let us assume that
     46we would like to use a parameter, called \c X. In the \c named_fn class we
     47have to define an \c _X attribute, and a function \c X. The function
     48expects a parameter with the type of \c _X, and sets the value of
     49\c _X. After setting the value the function returns the class itself. The
     50class also have to have a function, called for example <tt>run()</tt>, we have
    5151to implement here the original function itself. The constructor of the
    52 class have to give all the attributes like _X the default values of
     52class have to give all the attributes like \c _X the default values of
    5353them.
    5454
    5555If we instantiate this class, the default values will be set for the
    5656attributes (originally the parameters), initially. If we call function
    57 X, we get a class with the modified parameter value of
    58 X. Therefore we can modify any parameter-value, independent from the
    59 order. To run the algorithm we have to call the run() function at the
     57\c X, we get a class with the modified parameter value of
     58\c X. Therefore we can modify any parameter-value, independent from the
     59order. To run the algorithm we have to call the <tt>run()</tt> function at the
    6060end of the row.
    6161
    62 Example: named_fn().id(3).val(2).run();
     62Example:
     63\code
     64named_fn().id(3).val(2).run();
     65\endcode
    6366
    6467\section traits-classes Traits Classes
     
    9396DistMap and the PredMap is modified.
    9497
    95 \section named-templ-func-param Named "Function" Template Parameters
     98\section named-templ-func-param Named Function Template Parameters
    9699
    97100If the class has so called wizard functions, the new class with the
Note: See TracChangeset for help on using the changeset viewer.