Coverage Report

Created: 2026-06-08 06:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/quantlib/ql/math/randomnumbers/faurersg.cpp
Line
Count
Source
1
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3
/*
4
 Copyright (C) 2004 Ferdinando Ametrano
5
 Copyright (C) 2004 Gianni Piolanti
6
7
 This file is part of QuantLib, a free-software/open-source library
8
 for financial quantitative analysts and developers - http://quantlib.org/
9
10
 QuantLib is free software: you can redistribute it and/or modify it
11
 under the terms of the QuantLib license.  You should have received a
12
 copy of the license along with this program; if not, please email
13
 <quantlib-dev@lists.sf.net>. The license is also available online at
14
 <https://www.quantlib.org/license.shtml>.
15
16
 This program is distributed in the hope that it will be useful, but WITHOUT
17
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18
 FOR A PARTICULAR PURPOSE.  See the license for more details.
19
*/
20
21
#include <ql/math/randomnumbers/faurersg.hpp>
22
#include <ql/math/primenumbers.hpp>
23
24
namespace QuantLib {
25
26
    FaureRsg::FaureRsg(Size dimensionality)
27
0
    : dimensionality_(dimensionality),
28
//      sequenceCounter_(0),
29
0
      sequence_(std::vector<Real> (dimensionality), 1.0),
30
0
      integerSequence_(dimensionality, 0) {
31
32
0
        QL_REQUIRE(dimensionality>0, 
33
0
                   "dimensionality must be greater than 0");
34
35
        // base is the lowest prime number >= dimensionality_
36
0
        Size i, j, k=1;
37
0
        base_=2;
38
0
        while (base_<dimensionality_) {
39
0
            base_ = (Size)PrimeNumbers::get(k);
40
0
            k++;
41
0
        }
42
43
44
0
        mbit_=(Size)(std::log((double)std::numeric_limits<long int>::max())/
45
0
            std::log((double)base_));
46
0
        gray_ = std::vector<std::vector<long int> >(dimensionality_,
47
0
            std::vector<long int>(mbit_+1, 0));
48
0
        bary_ = std::vector<long int>(mbit_+1, 0);
49
50
51
        //setMatrixValues();
52
0
        powBase_ = std::vector<std::vector<long int> >(mbit_,
53
0
            std::vector<long int>(2*base_-1, 0));
54
0
        powBase_[mbit_-1][base_] = 1;
55
0
        for (int i2=mbit_-2; i2>=0; --i2)
56
0
            powBase_[i2][base_] = powBase_[i2+1][base_] * base_;
57
0
        for (int ii=0; ii<(int)mbit_; ii++) {
58
0
            for (int j1=base_+1; j1<2*(int)base_-1; j1++ )
59
0
                powBase_[ii][j1] = powBase_[ii][j1-1] + powBase_[ii][base_];
60
0
            for (int j2=base_-1; j2>=0; --j2)
61
0
                powBase_[ii][j2] = powBase_[ii][j2+1] - powBase_[ii][base_];
62
0
        }
63
64
0
        addOne_.resize(base_);
65
0
        for (j=0; j<base_ ; j++)
66
0
            addOne_[j] = (j+1) % base_;
67
68
69
        //setPascalMatrix();
70
0
        for (k=0; k<mbit_; k++) {
71
0
            std::vector<std::vector<long int> > mm(dimensionality_+1,
72
0
                std::vector<long int>(k+1, 0));
73
0
            pascal3D.push_back(mm);
74
0
            pascal3D[k][0][k] = 1;
75
0
            pascal3D[k][1][0] = 1;
76
0
            pascal3D[k][1][k] = 1;
77
0
        }
78
79
0
        long int p1, p2;
80
0
        for (k=2; k<mbit_ ; k++) {
81
0
            for (i=1; i<k ; i++) {
82
0
                p1 = pascal3D[k-1][1][i-1];
83
0
                p2 = pascal3D[k-1][1][i];
84
0
                pascal3D[k][1][i] = (p1+p2) % base_;
85
0
            }
86
0
        }
87
88
0
        long int fact = 1, diag;
89
0
        for (j=2; j<dimensionality_; j++) {
90
0
          for (long int kk=mbit_-1; kk>=0 ; --kk) {
91
0
              diag = mbit_ - kk - 1;
92
0
              if (diag==0)
93
0
                  fact = 1;
94
0
              else
95
0
                  fact = (fact*j) % base_;
96
0
              for (long int ii=0; ii<=kk; ii++)
97
0
                  pascal3D[diag+ii][j][ii] = (fact*
98
0
                    pascal3D[diag+ii][1][ii]) % base_;
99
0
          }
100
0
        }
101
102
103
0
        normalizationFactor_ = (double)base_ * (double)powBase_[0][base_];
104
        // std::cout << IntegerFormatter::toString(dimensionality_) << ", " ;
105
        // std::cout << IntegerFormatter::toString(normalizationFactor_);
106
        // std::cout << std::endl;
107
0
  }
108
109
0
    void FaureRsg::generateNextIntSequence() const {
110
        // sequenceCounter_++;
111
112
0
        Size bit = 0;
113
0
        bary_[bit] = addOne_[bary_[bit]];
114
0
        while (bary_[bit] == 0) {
115
0
            bit++;
116
0
            bary_[bit] = addOne_[bary_[bit]];
117
0
        };
118
0
        QL_REQUIRE(bit != mbit_,
119
0
            "Error processing Faure sequence." );
120
121
0
        long int tmp, g1, g2;
122
0
        for (Size i=0; i<dimensionality_ ; i++) {
123
0
            for (Size j=0; j<=bit ; j++) {
124
0
                tmp = gray_[i][j];
125
0
                gray_[i][j] = (pascal3D[bit][i][j] + tmp) % base_;
126
0
                g1 = gray_[i][j];
127
0
                g2 = base_ - 1 + g1 - tmp;
128
0
                integerSequence_[i] += powBase_[j][g2];
129
0
            }
130
0
        }
131
0
    }
132
133
}
134
135