Sacado_Random.hpp

Go to the documentation of this file.

// $Id$ 
// $Source$ 
// @HEADER
// ***********************************************************************
// 
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This 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
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef SACADO_RANDOM_HPP
#define SACADO_RANDOM_HPP

#include "Sacado_ConfigDefs.h"

#include <string>

namespace Sacado {

  template <typename ScalarT>
  class Random {
  public:

    Random();
    
    Random(ScalarT a_, ScalarT b_);

    Random(ScalarT a_, ScalarT b_, int s);

    ~Random();
    
    void setSeed(int s);

    ScalarT number();

  protected:

    // Check seed is valid
    int checkSeed(const std::string& func, int s);
  
  protected:

    ScalarT a;
    
    ScalarT b;

    ScalarT seed;

  }; // class Random

} // namespace Sacdo

#ifdef HAVE_SACADO_COMPLEX
#include <complex>

namespace Sacado {

  template <typename T>
  class Random< std::complex<T> > {
  public:

    Random();
    
    Random(const std::complex<T>& a, const std::complex<T>& b);

    Random(const std::complex<T>& a, const std::complex<T>& b, int s);

    ~Random();
    
    void setSeed(int s);

    std::complex<T> number();
  
  protected:

    Random<T> rand_real;
    
    Random<T> rand_imag;

  }; // class Random

} // namespace Sacado

#endif // HAVE_SACADO_COMPLEX

#include "Sacado_RandomImp.hpp"

#endif // SACADO_RANDOM_HPP