PaGMO  1.1.5
Public Member Functions | Protected Attributes
pagmo::util::discrepancy::base Class Referenceabstract

Base low-discrepancy sequence class. More...

#include <discrepancy.h>

Inheritance diagram for pagmo::util::discrepancy::base:
Inheritance graph
[legend]

Public Member Functions

 base (unsigned int dim, unsigned int count=1)
 Constructor. More...
 
virtual std::vector< double > operator() ()=0
 Operator () More...
 
virtual std::vector< double > operator() (unsigned int n)=0
 Operator (size_t n) More...
 
virtual base_ptr clone () const =0
 Clone method for dynamic polymorphism.
 
virtual ~base ()
 Virtual destructor. Required as the class contains pure virtual methods.
 

Protected Attributes

unsigned int m_dim
 Hypercube dimension where sampling with low-discrepancy.
 
unsigned int m_count
 Starting point of the sequence (can be used to skip initial values)
 

Detailed Description

Base low-discrepancy sequence class.

This class cannot be instantiated as it contains pure virtual members. All classes that generate quasi-random sequences with low-discrepancy must inherit from this class.

Author
Dario Izzo (dario.nosp@m..izz.nosp@m.o@gma.nosp@m.il.c.nosp@m.om)

Definition at line 78 of file discrepancy.h.

Constructor & Destructor Documentation

pagmo::util::discrepancy::base::base ( unsigned int  dim,
unsigned int  count = 1 
)
inline

Constructor.

Parameters
[in]dimhypercube dimension
[in]countstarting point of the sequence

Definition at line 86 of file discrepancy.h.

Member Function Documentation

virtual std::vector<double> pagmo::util::discrepancy::base::operator() ( )
pure virtual

Operator ()

Returns the next point in the sequence. Must be implemented in the derived class

Returns
an std::vector<double> containing the next point

Implemented in pagmo::util::discrepancy::lhs, pagmo::util::discrepancy::sobol, pagmo::util::discrepancy::simplex, pagmo::util::discrepancy::faure, and pagmo::util::discrepancy::halton.

virtual std::vector<double> pagmo::util::discrepancy::base::operator() ( unsigned int  n)
pure virtual

Operator (size_t n)

Returns the n-th point in the sequence. Must be implemented in the derived class

Parameters
[in]nthe point along the sequence to be returned
Returns
an std::vector<double> containing the n-th point

Implemented in pagmo::util::discrepancy::lhs, pagmo::util::discrepancy::sobol, pagmo::util::discrepancy::simplex, pagmo::util::discrepancy::faure, and pagmo::util::discrepancy::halton.


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