COIN-OR::LEMON - Graph Library

Changeset 1536:308150155bb5 in lemon-0.x for doc


Ignore:
Timestamp:
07/04/05 18:27:54 (14 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2028
Message:

Kill several doxygen warnings

Location:
doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/groups.dox

    r1402 r1536  
    6767Map adaptors are used to create "implicit" maps from other maps.
    6868
    69 Most of them are \ref concept::ReadMap "ReadMap"s. They can
     69Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
    7070make arithmetic oprerations between one or two maps (negation, scalig,
    7171addition, multiplication etc.) or e.g. convert a map to another one
  • doc/license.dox

    r996 r1536  
    33\page license License Terms
    44
    5 \verbinclude ../../LICENSE
     5\verbinclude ../LICENSE
    66
    77*/
  • doc/named-param.dox

    r1438 r1536  
    55\section named-func-param Named "Function" Parameters
    66
    7 C++ makes it possible to use default parameter values when calling a function. In such
    8 a case we do not have to give value for parameters, the program will use the default ones.
    9 Unfortunately sometimes this is not enough. If we do not want to give values for all the parameters, only
    10 for some of them we come across problems, because an arbitrary set of parameters cannot be omitted. On the other hand parameters have a fixed order in the head of the function.
    11 C++ can apply the default values only in the back of the order, if we do not give other value for them.
    12 So we can not give the function for example the value of the first, and the third parameter, expecting that the program will aplly the default value for the second parameter.
    13 However sometimes we would like to use some functinos exactly in this way. With a crafty trick and with some little inconvenience this is possible. We have implemented this little trick as an example below.
     7C++ makes it possible to use default parameter values when calling a
     8function. In such a case we do not have to give value for parameters,
     9the program will use the default ones.  Unfortunately sometimes this
     10is not enough. If we do not want to give values for all the
     11parameters, only for some of them we come across problems, because an
     12arbitrary set of parameters cannot be omitted. On the other hand
     13parameters have a fixed order in the head of the function.  C++ can
     14apply the default values only in the back of the order, if we do not
     15give other value for them.  So we can not give the function for
     16example the value of the first, and the third parameter, expecting
     17that the program will aplly the default value for the second
     18parameter.  However sometimes we would like to use some functinos
     19exactly in this way. With a crafty trick and with some little
     20inconvenience this is possible. We have implemented this little trick
     21as an example below.
    1422
    1523\code
     
    3543The usage is the following.
    3644
    37 We have to define a class, let's call it named_fn.
    38 Let us assume that we would like to use a parameter, called X. In the named_fn class we have to define an _X attribute, and an X function. The function expects a parameter with the type of _X, and sets the value of _X. After setting the value the function returns the class itself. The class also have to have a function, called for example run(), we have to implement here the original function itself. The constructor of the class have to give all the attributes like _X the default values of them.
     45We have to define a class, let's call it named_fn.  Let us assume that
     46we would like to use a parameter, called X. In the named_fn class we
     47have to define an _X attribute, and an X function. The function
     48expects 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
     50class also have to have a function, called for example run(), we have
     51to implement here the original function itself. The constructor of the
     52class have to give all the attributes like _X the default values of
     53them.
    3954
    40 If we instantiate this class, the default values will be set for the attributes (originally the parameters), initially. If we call the X function, we get a class with the modified parameter value of X. Therefore we can modify any parameter-value, independent from the order. To run the algorithm we have to call the run() function at the end of the row.
     55If we instantiate this class, the default values will be set for the
     56attributes (originally the parameters), initially. If we call the X
     57function, we get a class with the modified parameter value of
     58X. Therefore we can modify any parameter-value, independent from the
     59order. To run the algorithm we have to call the run() function at the
     60end of the row.
    4161
    4262Example: named_fn().id(3).val(2).run();
     
    4464\section traits-classes Traits Classes
    4565
    46 The procedure above can also be applied when defining classes. In this case the type of the attributes can be changed.
    47 Initially we have to define a class with the default attribute types. This is the so called Traits Class. Later on
    48 the types of these attributes can be changed, as described below. In our software \ref DijkstraDefaultTraits is an example of how a traits class looks like.
     66The procedure above can also be applied when defining classes. In this
     67case the type of the attributes can be changed.  Initially we have to
     68define a class with the default attribute types. This is the so called
     69Traits Class. Later on the types of these attributes can be changed,
     70as described below. In our software \ref lemon::DijkstraDefaultTraits is an
     71example of how a traits class looks like.
    4972
    5073\section named-templ-param Named Class Template Parameters
    5174
    52 If we would like to change the type of an attribute in a class that was instantiated by using a traits class as a template parameter, and the class contains named parameters, we do not have to reinstantiate the class with new traits class. Instead of that, adaptor classes can be used like in the following cases.
     75If we would like to change the type of an attribute in a class that
     76was instantiated by using a traits class as a template parameter, and
     77the class contains named parameters, we do not have to reinstantiate
     78the class with new traits class. Instead of that, adaptor classes can
     79be used like in the following cases.
    5380
    5481\code
     
    6390\endcode
    6491
    65 The result will be an instantiated Dijkstra class, in which the DistMap and the PredMap is modified.
     92The result will be an instantiated Dijkstra class, in which the
     93DistMap and the PredMap is modified.
    6694
    6795\section named-templ-func-param Named "Function" Template Parameters
    6896
    69 If the class has so called wizard functions, the new class with the modified tpye of attributes can be returned
    70 by the appropriate wizard function. The usage of these wizard functions is the following:
     97If the class has so called wizard functions, the new class with the
     98modified tpye of attributes can be returned by the appropriate wizard
     99function. The usage of these wizard functions is the following:
    71100
    72101*/
Note: See TracChangeset for help on using the changeset viewer.