File: random_util.h

package info (click to toggle)
seqan2 2.5.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 228,748 kB
  • sloc: cpp: 257,602; ansic: 91,967; python: 8,326; sh: 1,056; xml: 570; makefile: 229; awk: 51; javascript: 21
file content (133 lines) | stat: -rw-r--r-- 5,856 bytes parent folder | download
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
132
133
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2026, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Manuel Holtgrewe <manuel.holtgrewe@fu-berlin.de>
// Author: Rene Rahn <rene.rahn@fu-berlin.de>
// ==========================================================================
// Shuffling and conversion
// ==========================================================================

#ifndef INCLUDE_SEQAN_RANDOM_RANDOM_UTIL_H_
#define INCLUDE_SEQAN_RANDOM_RANDOM_UTIL_H_

namespace seqan2 {

// ===========================================================================
// Forwards, Tags.
// ===========================================================================

// ===========================================================================
// Classes
// ===========================================================================

// ===========================================================================
// Metafunctions
// ===========================================================================

// ===========================================================================
// Functions
// ===========================================================================

/*!
 * @fn shuffle
 * @headerfile <seqan/random.h>
 * @brief Shuffle the given container.
 *
 * @signature void shuffle(container, rng);
 *
 * @param[in,out] container The container to shuffle.
 * @param[in,out] rng       The random number generator to use.
 */

template <typename TContainer, typename TRNG>
void shuffle(TContainer & container, TRNG & rng)
{
    typedef typename Position<TContainer>::Type TPosition;
    typedef typename Value<TContainer>::Type TValue;

    TValue tmp;
    for (TPosition i = 0, iend = length(container); i < iend; ++i) {
        std::uniform_int_distribution<TPosition> uniformDist(i, iend - 1);
        TPosition j = uniformDist(rng);
        // swap
        move(tmp, container[i]);
        move(container[i], container[j]);
        move(container[j], tmp);
    }
}

/*!
 * @fn calcBetaDistParam
 * @headerfile <seqan/random.h>
 * @brief Computes alpha and beta paramters for the beta distribution from mean and stddev of the underlying distribution.
 *
 * @signature param cvtBetaDistParam(mean, stddev);
 *
 * @param[in] mean   The mean of the underlying distribution.
 * @param[in] stddev The standard deviation of the underlying distribution.
 *
 * @return param The distribution specific paramter of type <tt> typename beta_distribution::param_type </tt>.
 */

template<typename TRealType>
auto cvtBetaDistParam(TRealType const & mean, TRealType const & stddev)
    -> typename BetaDistribution<TRealType>::param_type
{
    using TParamType = typename BetaDistribution<TRealType>::param_type;
    return TParamType((((1 - mean) / stddev / stddev - 1 / mean) * mean * mean), ((((1 - mean) / stddev / stddev - 1 / mean) * mean * mean) * (1 / mean - 1)));
}

/*!
 * @fn calcLogNormalDistParam
 * @headerfile <seqan/random.h>
 * @brief Computes <tt>m</tt> and <tt>s</tt> paramters for the lognormal distribution from mean and stddev of the underlying distribution.
 *
 * @signature param cvtLogNormalDistParam(mean, stddev);
 *
 * @param[in] mean   The mean of the underlying distribution.
 * @param[in] stddev The standard deviation of the underlying distribution.
 *
 * @return param The distribution specific paramter of type <tt> typename lognormal_distribution::param_type </tt>.
 *
 */
// compute paramters m and s for lognorm from mean and stddev.
template<typename TRealType>
auto cvtLogNormalDistParam(TRealType const & mean, TRealType const & stddev)
    -> typename std::lognormal_distribution<TRealType>::param_type
{
    using TParamType = typename std::lognormal_distribution<TRealType>::param_type;
    return TParamType(static_cast<TRealType>(std::log(mean) - 0.5 * std::log(1.0 + stddev * stddev / mean / mean)),
                      static_cast<TRealType>(std::sqrt(std::log(1.0 + stddev * stddev / mean / mean))));
}

}  // namespace seqan2

#endif  // INCLUDE_SEQAN_RANDOM_RANDOM_UTIL_H_