Instrument Neutral Distributed Interface INDI 2.2.5
Public Member Functions | Static Public Member Functions | List of all members
INDI::AlignmentSubsystem::HaltonSequence Class Reference

Generic 2-D Halton quasi-random generator. More...

#include <HaltonSequence.h>

Public Member Functions

 HaltonSequence (int baseX=2, int baseY=3)
 Construct a generator with specified prime bases.
 
std::pair< double, double > getRaw (int n) const
 Get the n-th 2-D point in the sequence.
 
double getX (int n) const
 Get the n-th value of the individual X dimension.
 
double getY (int n) const
 Get the n-th value of the individual Y dimension.
 

Static Public Member Functions

static double term (int i, int base)
 Compute the i-th raw Halton term in the given base.
 

Detailed Description

Generic 2-D Halton quasi-random generator.

Definition at line 24 of file HaltonSequence.h.

Constructor & Destructor Documentation

◆ HaltonSequence()

INDI::AlignmentSubsystem::HaltonSequence::HaltonSequence ( int  baseX = 2,
int  baseY = 3 
)
inline

Construct a generator with specified prime bases.

Parameters
baseXPrime base for the first dimension (default: 2).
baseYPrime base for the second dimension (default: 3).

Definition at line 30 of file HaltonSequence.h.

Member Function Documentation

◆ getRaw()

std::pair< double, double > INDI::AlignmentSubsystem::HaltonSequence::getRaw ( int  n) const
inline

Get the n-th 2-D point in the sequence.

Parameters
n1-indexed point index.
Returns
A pair of values in the range [0, 1).

Definition at line 52 of file HaltonSequence.h.

◆ getX()

double INDI::AlignmentSubsystem::HaltonSequence::getX ( int  n) const
inline

Get the n-th value of the individual X dimension.

Definition at line 58 of file HaltonSequence.h.

◆ getY()

double INDI::AlignmentSubsystem::HaltonSequence::getY ( int  n) const
inline

Get the n-th value of the individual Y dimension.

Definition at line 64 of file HaltonSequence.h.

◆ term()

static double INDI::AlignmentSubsystem::HaltonSequence::term ( int  i,
int  base 
)
inlinestatic

Compute the i-th raw Halton term in the given base.

Parameters
i1-indexed position in the sequence.
basePrime base.
Returns
Value in [0, 1).

Definition at line 36 of file HaltonSequence.h.


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