Changeset 561


Ignore:
Timestamp:
Mar 15, 2006, 10:14:45 AM (16 years ago)
Author:
Jari Häkkinen
Message:

Fixed documentation, added copyright statement.

Location:
trunk/lib/random
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/random/random.cc

    r425 r561  
    11// $Id$
     2
     3/*
     4  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
     5
     6  This file is part of thep c++ tools, http://lev.thep.lu.se/trac/c++_tools
     7
     8  The c++ tools library is free software; you can redistribute it
     9  and/or modify it under the terms of the GNU General Public License
     10  as published by the Free Software Foundation; either version 2 of
     11  the License, or (at your option) any later version.
     12
     13  The c++ tools library is distributed in the hope that it will be
     14  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
     15  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     16  General Public License for more details.
     17
     18  You should have received a copy of the GNU General Public License
     19  along with this program; if not, write to the Free Software
     20  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
     21  02111-1307, USA.
     22*/
    223
    324#include <c++_tools/random/random.h>
  • trunk/lib/random/random.h

    r443 r561  
    11// $Id$
     2
     3/*
     4  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
     5
     6  This file is part of thep c++ tools, http://lev.thep.lu.se/trac/c++_tools
     7
     8  The c++ tools library is free software; you can redistribute it
     9  and/or modify it under the terms of the GNU General Public License
     10  as published by the Free Software Foundation; either version 2 of
     11  the License, or (at your option) any later version.
     12
     13  The c++ tools library is distributed in the hope that it will be
     14  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
     15  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     16  General Public License for more details.
     17
     18  You should have received a copy of the GNU General Public License
     19  along with this program; if not, write to the Free Software
     20  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
     21  02111-1307, USA.
     22*/
    223
    324#ifndef _theplu_random_
     
    5778
    5879    ///
     80    /// @brief Get an instance of the random number generator.
     81    ///
    5982    /// Get an instance of the random number generator. If the random
    6083    /// number generator is not already created, the call will create
    61     /// a new generator and use the default seed. I needed, the seed
    62     /// must be changed with the seed or seed_from_devurandom member
     84    /// a new generator and use the default seed. The seed must be
     85    /// changed with the seed or seed_from_devurandom member
    6386    /// functions.
    64     ///
    65     /// @brief Get an instance of the random number generator.
    6687    ///
    6788    /// @return A pointer to the random number generator.
     
    91112    inline const gsl_rng* rng(void) const { return rng_; }
    92113
     114    ///
     115    /// @brief Set the seed \a s for the rng.
    93116    ///
    94117    /// Set the seed \a s for the rng. If \a s is zero, a default
    95118    /// value from the rng's original implementation is used (cf. GSL
    96119    /// documentation).
    97     ///
    98     /// @brief Set the seed \a s for the rng.
    99120    ///
    100121    /// @see seed_from_devurandom
     
    137158
    138159    ///
     160    /// @brief Set the seed to \a s.
     161    ///
    139162    /// Set the seed to \a s in the underlying rng. If \a s is zero, a
    140163    /// default value from the rng's original implementation is used
    141164    /// (cf. GSL documentation).
    142     ///
    143     /// @brief Set the seed to \a s.
    144165    ///
    145166    /// @see seed_from_devurandom, RNG::seed_from_devurandom, RNG::seed
     
    316337
    317338    ///
     339    /// @brief Set the seed to \a s.
     340    ///
    318341    /// Set the seed to \a s in the underlying rng. If \a s is zero, a
    319342    /// default value from the rng's original implementation is used
    320343    /// (cf. GSL documentation).
    321     ///
    322     /// @brief Set the seed to \a s.
    323344    ///
    324345    /// @see seed_from_devurandom, RNG::seed_from_devurandom, RNG::seed
Note: See TracChangeset for help on using the changeset viewer.