Sacado_Random.hpp

Go to the documentation of this file.
00001 // $Id$ 
00002 // $Source$ 
00003 // @HEADER
00004 // ***********************************************************************
00005 // 
00006 //                           Sacado Package
00007 //                 Copyright (2006) Sandia Corporation
00008 // 
00009 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00010 // the U.S. Government retains certain rights in this software.
00011 // 
00012 // This library is free software; you can redistribute it and/or modify
00013 // it under the terms of the GNU Lesser General Public License as
00014 // published by the Free Software Foundation; either version 2.1 of the
00015 // License, or (at your option) any later version.
00016 //  
00017 // This library is distributed in the hope that it will be useful, but
00018 // WITHOUT ANY WARRANTY; without even the implied warranty of
00019 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020 // Lesser General Public License for more details.
00021 //  
00022 // You should have received a copy of the GNU Lesser General Public
00023 // License along with this library; if not, write to the Free Software
00024 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00025 // USA
00026 // Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
00027 // (etphipp@sandia.gov).
00028 // 
00029 // ***********************************************************************
00030 // @HEADER
00031 
00032 #ifndef SACADO_RANDOM_HPP
00033 #define SACADO_RANDOM_HPP
00034 
00035 #include "Sacado_ConfigDefs.h"
00036 
00037 #include <string>
00038 
00039 namespace Sacado {
00040 
00045   template <typename ScalarT>
00046   class Random {
00047   public:
00048 
00050     Random();
00051     
00053     Random(ScalarT a_, ScalarT b_);
00054 
00056     Random(ScalarT a_, ScalarT b_, int s);
00057 
00059     ~Random();
00060     
00062     void setSeed(int s);
00063 
00065     ScalarT number();
00066 
00067   protected:
00068 
00069     // Check seed is valid
00070     int checkSeed(const std::string& func, int s);
00071   
00072   protected:
00073 
00075     ScalarT a;
00076     
00078     ScalarT b;
00079 
00081     ScalarT seed;
00082 
00083   }; // class Random
00084 
00085 } // namespace Sacdo
00086 
00087 #ifdef HAVE_SACADO_COMPLEX
00088 #include <complex>
00089 
00090 namespace Sacado {
00091 
00097   template <typename T>
00098   class Random< std::complex<T> > {
00099   public:
00100 
00102     Random();
00103     
00105     Random(const std::complex<T>& a, const std::complex<T>& b);
00106 
00108     Random(const std::complex<T>& a, const std::complex<T>& b, int s);
00109 
00111     ~Random();
00112     
00114     void setSeed(int s);
00115 
00117     std::complex<T> number();
00118   
00119   protected:
00120 
00122     Random<T> rand_real;
00123     
00125     Random<T> rand_imag;
00126 
00127   }; // class Random
00128 
00129 } // namespace Sacado
00130 
00131 #endif // HAVE_SACADO_COMPLEX
00132 
00133 #include "Sacado_RandomImp.hpp"
00134 
00135 #endif // SACADO_RANDOM_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:19:34 2011 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.6.3