/usr/include/ql/math/statistics/convergencestatistics.hpp is in libquantlib0-dev 1.7.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2005 Gary Kennedy
Copyright (C) 2006 StatPro Italia srl
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<http://quantlib.org/license.shtml>.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the license for more details.
*/
/*! \file convergencestatistics.hpp
\brief statistics tool with risk measures
*/
#ifndef quantlib_convergence_statistics_hpp
#define quantlib_convergence_statistics_hpp
#include <ql/types.hpp>
#include <vector>
namespace QuantLib {
class DoublingConvergenceSteps {
public:
Size initialSamples() const { return 1; }
Size nextSamples(Size current) { return 2 * current + 1; }
};
//! statistics class with convergence table
/*! This class decorates another statistics class adding a
convergence table calculation. The table tracks the
convergence of the mean.
It is possible to specify the number of samples at which the
mean should be stored by mean of the second template
parameter; the default is to store \f$ 2^{n-1} \f$ samples at
the \f$ n \f$-th step. Any passed class must implement the
following interface:
\code
Size initialSamples() const;
Size nextSamples(Size currentSamples) const;
\endcode
as well as a copy constructor.
\test results are tested against known good values.
*/
template <class T, class U = DoublingConvergenceSteps>
class ConvergenceStatistics : public T {
public:
typedef typename T::value_type value_type;
typedef std::vector<std::pair<Size,value_type> > table_type;
ConvergenceStatistics(const T& stats,
const U& rule = U());
ConvergenceStatistics(const U& rule = U());
void add(const value_type& value, Real weight = 1.0);
template <class DataIterator>
void addSequence(DataIterator begin, DataIterator end) {
for (; begin != end; ++begin)
add(*begin);
}
template <class DataIterator, class WeightIterator>
void addSequence(DataIterator begin, DataIterator end,
WeightIterator wbegin) {
for (; begin != end; ++begin, ++wbegin)
add(*begin,*wbegin);
}
void reset();
const std::vector<std::pair<Size,value_type> >& convergenceTable()
const;
private:
table_type table_;
U samplingRule_;
Size nextSampleSize_;
};
// inline definitions
template <class T, class U>
ConvergenceStatistics<T,U>::ConvergenceStatistics(const T& stats,
const U& rule)
: T(stats), samplingRule_(rule) {
reset();
}
template <class T, class U>
ConvergenceStatistics<T,U>::ConvergenceStatistics(const U& rule)
: samplingRule_(rule) {
reset();
}
#ifndef __DOXYGEN__
template <class T, class U>
void ConvergenceStatistics<T,U>::add(
const typename ConvergenceStatistics<T,U>::value_type& value,
Real weight) {
T::add(value,weight);
if (this->samples() == nextSampleSize_) {
table_.push_back(std::make_pair(this->samples(),this->mean()));
nextSampleSize_ = samplingRule_.nextSamples(nextSampleSize_);
}
}
#endif
template <class T, class U>
void ConvergenceStatistics<T,U>::reset() {
T::reset();
nextSampleSize_ = samplingRule_.initialSamples();
table_.clear();
}
template <class T, class U>
const typename ConvergenceStatistics<T,U>::table_type&
ConvergenceStatistics<T,U>::convergenceTable() const {
return table_;
}
}
#endif
|