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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
/*
* Copyright 2008-2020 NVIDIA Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*! \file shuffle.h
* \brief Reorders range by a uniform random permutation
*/
#pragma once
#include <thrust/detail/config.h>
#if defined(_CCCL_IMPLICIT_SYSTEM_HEADER_GCC)
# pragma GCC system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_CLANG)
# pragma clang system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_MSVC)
# pragma system_header
#endif // no system header
#include <thrust/detail/cpp11_required.h>
#if THRUST_CPP_DIALECT >= 2011
#include <thrust/detail/execution_policy.h>
THRUST_NAMESPACE_BEGIN
/*! \addtogroup reordering
* \ingroup algorithms
*
* \addtogroup shuffling
* \ingroup reordering
* \{
*/
/*! \p shuffle reorders the elements <tt>[first, last)</tt> by a uniform pseudorandom permutation, defined by
* random engine \p g.
*
* The algorithm's execution is parallelized as determined by \p exec.
*
* \param exec The execution policy to use for parallelization.
* \param first The beginning of the sequence to shuffle.
* \param last The end of the sequence to shuffle.
* \param g A UniformRandomBitGenerator
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam RandomIterator is a random access iterator
* \tparam URBG is a uniform random bit generator
*
* The following code snippet demonstrates how to use \p shuffle to create a random permutation
* using the \p thrust::host execution policy for parallelization:
*
* \code
* #include <thrust/shuffle.h>
* #include <thrust/random.h>
* #include <thrust/execution_policy.h>
* int A[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
* const int N = sizeof(A)/sizeof(int);
* thrust::default_random_engine g;
* thrust::shuffle(thrust::host, A, A + N, g);
* // A is now {6, 5, 8, 7, 2, 1, 4, 3, 10, 9}
* \endcode
*
* \see \p shuffle_copy
*/
template <typename DerivedPolicy, typename RandomIterator, typename URBG>
__host__ __device__ void shuffle(
const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
RandomIterator first, RandomIterator last, URBG&& g);
/*! \p shuffle reorders the elements <tt>[first, last)</tt> by a uniform pseudorandom permutation, defined by
* random engine \p g.
*
* \param first The beginning of the sequence to shuffle.
* \param last The end of the sequence to shuffle.
* \param g A UniformRandomBitGenerator
*
* \tparam RandomIterator is a random access iterator
* \tparam URBG is a uniform random bit generator
*
* The following code snippet demonstrates how to use \p shuffle to create a random permutation.
*
* \code
* #include <thrust/shuffle.h>
* #include <thrust/random.h>
* int A[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
* const int N = sizeof(A)/sizeof(int);
* thrust::default_random_engine g;
* thrust::shuffle(A, A + N, g);
* // A is now {6, 5, 8, 7, 2, 1, 4, 3, 10, 9}
* \endcode
*
* \see \p shuffle_copy
*/
template <typename RandomIterator, typename URBG>
__host__ __device__ void shuffle(RandomIterator first, RandomIterator last,
URBG&& g);
/*! shuffle_copy differs from shuffle only in that the reordered sequence is written to different output sequences, rather than in place.
* \p shuffle_copy reorders the elements <tt>[first, last)</tt> by a uniform pseudorandom permutation, defined by
* random engine \p g.
*
* The algorithm's execution is parallelized as determined by \p exec.
* \param exec The execution policy to use for parallelization.
* \param first The beginning of the sequence to shuffle.
* \param last The end of the sequence to shuffle.
* \param result Destination of shuffled sequence
* \param g A UniformRandomBitGenerator
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam RandomIterator is a random access iterator
* \tparam OutputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>.
* \tparam URBG is a uniform random bit generator
*
* The following code snippet demonstrates how to use \p shuffle_copy to create a random permutation.
*
* \code
* #include <thrust/shuffle.h>
* #include <thrust/random.h>
* #include <thrust/execution_policy.h>
* int A[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
* int result[10];
* const int N = sizeof(A)/sizeof(int);
* thrust::default_random_engine g;
* thrust::shuffle_copy(thrust::host, A, A + N, result, g);
* // result is now {6, 5, 8, 7, 2, 1, 4, 3, 10, 9}
* \endcode
*
* \see \p shuffle
*/
template <typename DerivedPolicy, typename RandomIterator,
typename OutputIterator, typename URBG>
__host__ __device__ void shuffle_copy(
const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
RandomIterator first, RandomIterator last, OutputIterator result, URBG&& g);
/*! shuffle_copy differs from shuffle only in that the reordered sequence is written to different output sequences, rather than in place.
*\p shuffle_copy reorders the elements <tt>[first, last)</tt> by a uniform pseudorandom permutation, defined by
* random engine \p g.
*
* \param first The beginning of the sequence to shuffle.
* \param last The end of the sequence to shuffle.
* \param result Destination of shuffled sequence
* \param g A UniformRandomBitGenerator
*
* \tparam RandomIterator is a random access iterator
* \tparam OutputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>.
* \tparam URBG is a uniform random bit generator
*
* The following code snippet demonstrates how to use \p shuffle_copy to create a random permutation.
*
* \code
* #include <thrust/shuffle.h>
* #include <thrust/random.h>
* int A[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
* int result[10];
* const int N = sizeof(A)/sizeof(int);
* thrust::default_random_engine g;
* thrust::shuffle_copy(A, A + N, result, g);
* // result is now {6, 5, 8, 7, 2, 1, 4, 3, 10, 9}
* \endcode
*
* \see \p shuffle
*/
template <typename RandomIterator, typename OutputIterator, typename URBG>
__host__ __device__ void shuffle_copy(RandomIterator first, RandomIterator last,
OutputIterator result, URBG&& g);
THRUST_NAMESPACE_END
#include <thrust/detail/shuffle.inl>
#endif
|