Changeset 561

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:

• random.cc (modified) (1 diff)
• random.h (modified) (5 diffs)

trunk/lib/random/random.cc

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

trunk/lib/random/random.h

@@ -1 +1 @@
 // $Id$
+
+/*
+  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
+
+  This file is part of thep c++ tools, http://lev.thep.lu.se/trac/c++_tools
+
+  The c++ tools library is free software; you can redistribute it
+  and/or modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2 of
+  the License, or (at your option) any later version.
+
+  The c++ tools library is distributed in the hope that it will be
+  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+  02111-1307, USA.
+*/
 
 #ifndef _theplu_random_
@@ -57 +78 @@
 
     ///
+    /// @brief Get an instance of the random number generator.
+    ///
     /// Get an instance of the random number generator. If the random
     /// number generator is not already created, the call will create
-    /// a new generator and use the default seed. I needed, the seed
-    /// must be changed with the seed or seed_from_devurandom member
+    /// a new generator and use the default seed. The seed must be
+    /// changed with the seed or seed_from_devurandom member
     /// functions.
-    ///
-    /// @brief Get an instance of the random number generator.
     ///
     /// @return A pointer to the random number generator.
@@ -91 +112 @@
     inline const gsl_rng* rng(void) const { return rng_; }
 
+    ///
+    /// @brief Set the seed \a s for the rng.
     ///
     /// Set the seed \a s for the rng. If \a s is zero, a default
     /// value from the rng's original implementation is used (cf. GSL
     /// documentation).
-    ///
-    /// @brief Set the seed \a s for the rng.
     ///
     /// @see seed_from_devurandom
@@ -137 +158 @@
 
     ///
+    /// @brief Set the seed to \a s.
+    ///
     /// Set the seed to \a s in the underlying rng. If \a s is zero, a
     /// default value from the rng's original implementation is used
     /// (cf. GSL documentation).
-    ///
-    /// @brief Set the seed to \a s.
     ///
     /// @see seed_from_devurandom, RNG::seed_from_devurandom, RNG::seed
@@ -316 +337 @@
 
     ///
+    /// @brief Set the seed to \a s.
+    ///
     /// Set the seed to \a s in the underlying rng. If \a s is zero, a
     /// default value from the rng's original implementation is used
     /// (cf. GSL documentation).
-    ///
-    /// @brief Set the seed to \a s.
     ///
     /// @see seed_from_devurandom, RNG::seed_from_devurandom, RNG::seed