types.h
Go to the documentation of this file.
// -*- C++ -*-
// Copyright (C) 2007-2021 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
// of the GNU General Public License as published by the Free Software
// Foundation; either version 3, or (at your option) any later
// version.
// This library 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 GNU
// General Public License for more details.
// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.
// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file parallel/types.h
* @brief Basic types and typedefs.
* This file is a GNU parallel extension to the Standard C++ Library.
*/
// Written by Johannes Singler and Felix Putze.
#ifndef _GLIBCXX_PARALLEL_TYPES_H
#define _GLIBCXX_PARALLEL_TYPES_H 1
#include <cstdlib>
#include <limits>
#include <tr1/cstdint>
namespace __gnu_parallel
{
// Enumerated types.
/// Run-time equivalents for the compile-time tags.
enum _Parallelism
{
/// Not parallel.
sequential,
/// Parallel unbalanced (equal-sized chunks).
parallel_unbalanced,
/// Parallel balanced (work-stealing).
parallel_balanced,
/// Parallel with OpenMP dynamic load-balancing.
parallel_omp_loop,
/// Parallel with OpenMP static load-balancing.
parallel_omp_loop_static,
/// Parallel with OpenMP taskqueue construct.
parallel_taskqueue
};
/// Strategies for run-time algorithm selection:
// force_sequential, force_parallel, heuristic.
enum _AlgorithmStrategy
{
heuristic,
force_sequential,
force_parallel
};
/// Sorting algorithms:
// multi-way mergesort, quicksort, load-balanced quicksort.
enum _SortAlgorithm
{
MWMS,
QS,
QS_BALANCED
};
/// Merging algorithms:
// bubblesort-alike, loser-tree variants, enum __sentinel.
enum _MultiwayMergeAlgorithm
{
LOSER_TREE
};
/// Partial sum algorithms: recursive, linear.
enum _PartialSumAlgorithm
{
RECURSIVE,
LINEAR
};
/// Sorting/merging algorithms: sampling, __exact.
enum _SplittingAlgorithm
{
SAMPLING,
EXACT
};
/// Find algorithms:
// growing blocks, equal-sized blocks, equal splitting.
enum _FindAlgorithm
{
GROWING_BLOCKS,
CONSTANT_SIZE_BLOCKS,
EQUAL_SPLIT
};
/**
* @brief Unsigned integer to index __elements.
* The total number of elements for each algorithm must fit into this type.
*/
typedef uint64_t _SequenceIndex;
/**
* @brief Unsigned integer to index a thread number.
* The maximum thread number (for each processor) must fit into this type.
*/
typedef uint16_t _ThreadIndex;
// XXX atomics interface?
/// Longest compare-and-swappable integer type on this platform.
typedef int64_t _CASable;
/// Number of bits of _CASable.
static const int _CASable_bits = std::numeric_limits<_CASable>::digits;
/// ::_CASable with the right half of bits set to 1.
static const _CASable _CASable_mask =
((_CASable(1) << (_CASable_bits / 2)) - 1);
}
#endif /* _GLIBCXX_PARALLEL_TYPES_H */
limits
__gnu_parallel
GNU parallel code for public use.
Definition: balanced_quicksort.h:62
__gnu_parallel::_ThreadIndex
uint16_t _ThreadIndex
Unsigned integer to index a thread number. The maximum thread number (for each processor) must fit in...
Definition: types.h:123
__gnu_parallel::_FindAlgorithm
_FindAlgorithm
Find algorithms:
Definition: types.h:107
__gnu_parallel::_SequenceIndex
uint64_t _SequenceIndex
Unsigned integer to index __elements. The total number of elements for each algorithm must fit into t...
Definition: types.h:117
__gnu_parallel::_SortAlgorithm
_SortAlgorithm
Sorting algorithms:
Definition: types.h:77
__gnu_parallel::_PartialSumAlgorithm
_PartialSumAlgorithm
Partial sum algorithms: recursive, linear.
Definition: types.h:92
__gnu_parallel::_Parallelism
_Parallelism
Run-time equivalents for the compile-time tags.
Definition: types.h:45
__gnu_parallel::parallel_balanced
@ parallel_balanced
Parallel balanced (work-stealing).
Definition: types.h:53
__gnu_parallel::sequential
@ sequential
Not parallel.
Definition: types.h:47
__gnu_parallel::parallel_omp_loop_static
@ parallel_omp_loop_static
Parallel with OpenMP static load-balancing.
Definition: types.h:59
__gnu_parallel::parallel_unbalanced
@ parallel_unbalanced
Parallel unbalanced (equal-sized chunks).
Definition: types.h:50
__gnu_parallel::parallel_omp_loop
@ parallel_omp_loop
Parallel with OpenMP dynamic load-balancing.
Definition: types.h:56
__gnu_parallel::parallel_taskqueue
@ parallel_taskqueue
Parallel with OpenMP taskqueue construct.
Definition: types.h:62
__gnu_parallel::_CASable
int64_t _CASable
Longest compare-and-swappable integer type on this platform.
Definition: types.h:127
__gnu_parallel::_MultiwayMergeAlgorithm
_MultiwayMergeAlgorithm
Merging algorithms:
Definition: types.h:86
__gnu_parallel::_AlgorithmStrategy
_AlgorithmStrategy
Strategies for run-time algorithm selection:
Definition: types.h:68
__gnu_parallel::_SplittingAlgorithm
_SplittingAlgorithm
Sorting/merging algorithms: sampling, __exact.
Definition: types.h:99
__gnu_parallel::_CASable_mask
static const _CASable _CASable_mask
_CASable with the right half of bits set to 1.
Definition: types.h:133
__gnu_parallel::_CASable_bits
static const int _CASable_bits
Number of bits of _CASable.
Definition: types.h:130
std::numeric_limits
Properties of fundamental types.
Definition: limits:313
cstdint
cstdlib