Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Sacado::Random< ScalarT > Class Template Reference

A random number generator that generates random numbers uniformly distributed in the interval (a,b). More...

#include <Sacado_Random.hpp>

Inheritance diagram for Sacado::Random< ScalarT >:
Inheritance graph
[legend]

Public Member Functions

 Random ()
 Constructor.
 
 Random (ScalarT a_, ScalarT b_)
 Constructor.
 
 Random (ScalarT a_, ScalarT b_, int s)
 Constructor with seed value s.
 
 ~Random ()
 Destructor.
 
void setSeed (int s)
 Set seed to s.
 
ScalarT number ()
 Get random number.
 

Protected Member Functions

int checkSeed (const std::string &func, int s)
 

Protected Attributes

ScalarT a
 Lower bound of interval.
 
ScalarT b
 Upper bound of interval.
 
ScalarT seed
 Random number seed
 

Detailed Description

template<typename ScalarT>
class Sacado::Random< ScalarT >

A random number generator that generates random numbers uniformly distributed in the interval (a,b).

Definition at line 46 of file Sacado_Random.hpp.

Constructor & Destructor Documentation

◆ Random() [1/3]

template<typename ScalarT >
Sacado::Random< ScalarT >::Random ( )

Constructor.

Definition at line 38 of file Sacado_RandomImp.hpp.

◆ Random() [2/3]

template<typename ScalarT >
Sacado::Random< ScalarT >::Random ( ScalarT a_,
ScalarT b_ )

Constructor.

Definition at line 50 of file Sacado_RandomImp.hpp.

◆ Random() [3/3]

template<typename ScalarT >
Sacado::Random< ScalarT >::Random ( ScalarT a_,
ScalarT b_,
int s )

Constructor with seed value s.

Definition at line 62 of file Sacado_RandomImp.hpp.

◆ ~Random()

template<typename ScalarT >
Sacado::Random< ScalarT >::~Random ( )

Destructor.

Definition at line 72 of file Sacado_RandomImp.hpp.

Member Function Documentation

◆ setSeed()

template<typename ScalarT >
void Sacado::Random< ScalarT >::setSeed ( int s)

Set seed to s.

Definition at line 79 of file Sacado_RandomImp.hpp.

◆ number()

template<typename ScalarT >
ScalarT Sacado::Random< ScalarT >::number ( )

Get random number.

Definition at line 88 of file Sacado_RandomImp.hpp.

◆ checkSeed()

template<typename ScalarT >
int Sacado::Random< ScalarT >::checkSeed ( const std::string & func,
int s )
protected

Definition at line 99 of file Sacado_RandomImp.hpp.

Member Data Documentation

◆ a

template<typename ScalarT >
ScalarT Sacado::Random< ScalarT >::a
protected

Lower bound of interval.

Definition at line 75 of file Sacado_Random.hpp.

◆ b

template<typename ScalarT >
ScalarT Sacado::Random< ScalarT >::b
protected

Upper bound of interval.

Definition at line 78 of file Sacado_Random.hpp.

◆ seed

template<typename ScalarT >
ScalarT Sacado::Random< ScalarT >::seed
protected

Random number seed

Definition at line 81 of file Sacado_Random.hpp.


The documentation for this class was generated from the following files: