Greens-code
A modular quantum transport code
List of all members
random_smooth_vector Class Reference

Fill a vector with random numbers so that the numbers lie smoothly together. More...

#include <funcs.hpp>

Inheritance diagram for random_smooth_vector:
Inheritance graph
[legend]
Collaboration diagram for random_smooth_vector:
Collaboration graph
[legend]

Additional Inherited Members

- Public Types inherited from vector_Object
typedef STD_TR1::shared_ptr< vector_Objectref
 
typedef STD_TR1::shared_ptr< const vector_Objectconst_ref
 
- Public Types inherited from loadable_Object
typedef STD_TR1::shared_ptr< loadable_Objectref
 
typedef STD_TR1::shared_ptr< const loadable_Objectconst_ref
 
typedef std::pair< std::string, ref > ref_pair
 
typedef STD_TR1::weak_ptr< loadable_Objectlink
 
typedef STD_TR1::weak_ptr< const loadable_Objectconst_link
 
- Public Member Functions inherited from vector_Object
double operator[] (const size_t i) const
 indexed access to vector elements
 
size_t size () const
 Number of elements in vector.
 
void output (std::ostream &) const
 Output a human-readable list of vector values.
 
const std::vector< double > & provide_vector () const
 Return the internal container object, use with care.
 
void set_complex_vector_real (std::vector< complex > &) const
 Set the real part of a complex vector using the elements of this vector.
 
void set_complex_vector_imag (std::vector< complex > &) const
 Set the imaginary part of a complex vector using the elements of this vector.
 
- Public Member Functions inherited from loadable_Object
void write_xml (std::ostream &) const
 Output the xml code that would construct the object to stream.
 
 loadable_Object ()
 Empty construction, objects are initialized by init routine.
 
const char * class_Name () const
 Calls virtual const char* name(), which must be redefined for derived classes.
 
bool get_param (const std::string &s, double &v) const
 get a double, integer or string parameter by name (s), return wether parameter exists
 
bool get_param (const std::string &s, int &v) const
 
bool get_param (const std::string &s, std::string &v) const
 
double get_double_param (const std::string &s) const
 get a double, integer or string parameter, throw if it does not exist
 
int get_int_param (const std::string &s) const
 
std::string get_string_param (const std::string &s) const
 
void set_param (const std::string &s, double v)
 set a double, integer or string parameter
 
void set_param (const std::string &s, int v)
 
void set_param (const std::string &s, std::string v)
 
bool get_bool (const std::string &s, const bool def) const
 return bool parameter, return def if string not found
 
void acquire_params (const const_ref &)
 import all parameters from another object
 
void insert_object (const std::string &s, ref o)
 insert an object as parameter
 
void link_object (const std::string &s, ref o)
 insert a link to an object as parameter, the refered object must be defined elsewhere
 
bool get_component (const std::string &s, const_ref &) const
 get a contained object by string s, return wether it exists
 
bool get_component (const std::string &s, ref &)
 
const_ref get_component (const std::string &s) const
 get a contained object by string s, throw if it does not exist
 
ref get_component (const std::string &s)
 
template<typename T >
STD_TR1::shared_ptr< T > get_dynamic_component (const std::string &s)
 get a contained object with a dynamic cast More...
 
template<typename T >
STD_TR1::shared_ptr< const T > get_dynamic_component (const std::string &s) const
 
ref get_ref ()
 Get a shared_ptr to this object. More...
 
const_ref get_ref () const
 
template<typename T >
STD_TR1::shared_ptr< T > get_dynamic_ref ()
 Get a dynamic reference to this object. More...
 
template<typename T >
STD_TR1::shared_ptr< const T > get_dynamic_ref () const
 
void initialize (ref me)
 called by the xml_parser to initialize the object More...
 
void set_correct_ref (ref me)
 called to set reference to object More...
 
bool is_initialized () const
 returns whether the object has been correctly initialized
 
void require_initialized () const
 throws if is_initialized returns false
 
void force_reinit ()
 call if parameters are changed, object is completely reinitialized, children are not
 
void register_Observer (Observer::ref)
 register/unregister Observer: All registered Observers will have notify() called upon state change (reinit)
 
void unregister_Observer (Observer::ref)
 
size_t nparams () const
 returns total number of parameters
 
ref clone () const
 returns a complete clone of the Object and all parameters (with correct dynamic type)
 
virtual size_t verbosity ()
 
- Static Public Member Functions inherited from loadable_Object
template<class T >
static STD_TR1::shared_ptr< const T > clone (const STD_TR1::shared_ptr< const T > r)
 
template<class T >
static STD_TR1::shared_ptr< T > clone (STD_TR1::shared_ptr< T > r)
 
- Protected Member Functions inherited from vector_Object
void set_element (const size_t i, double d) const
 
- Protected Attributes inherited from vector_Object
bool lazy_initialized
 

Detailed Description

Fill a vector with random numbers so that the numbers lie smoothly together.

Derives from vector_Object

Fill a vector with numbers from [distance, amplitude + distance]

Parameters:

amplitude: maximum random number distance: offset of random number, default 0 correlation: correlation between adjacent random numbers, possible values from 0 to infinity the bigger the correlation, the smoother the numbers(try 10 as starting value)

c_int makes sure the numbers at the beginning and the end of the vector receive the same random distribution as the other numbers


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