ceph/src/boost/libs/compute/doc/reference.qbk

   1 [/===========================================================================
   2  Copyright (c) 2013-2015 Kyle Lutz <kyle.r.lutz@gmail.com>
   3
   4  Distributed under the Boost Software License, Version 1.0
   5  See accompanying file LICENSE_1_0.txt or copy at
   6  http://www.boost.org/LICENSE_1_0.txt
   7 =============================================================================/]
   8
   9 [section:reference Reference]
  10
  11 [section API Overview]
  12
  13 [h3 Core Library]
  14
  15 Header: `<boost/compute/core.hpp>`
  16
  17 * [classref boost::compute::buffer buffer]
  18 * [classref boost::compute::command_queue command_queue]
  19 * [classref boost::compute::context context]
  20 * [classref boost::compute::device device]
  21 * [classref boost::compute::event event]
  22 * [classref boost::compute::kernel kernel]
  23 * [classref boost::compute::memory_object memory_object]
  24 * [classref boost::compute::pipe pipe]
  25 * [classref boost::compute::platform platform]
  26 * [classref boost::compute::program program]
  27 * [classref boost::compute::system system]
  28 * [classref boost::compute::user_event user_event]
  29
  30 [h3 Utilities]
  31
  32 Header: `<boost/compute/utility.hpp>`
  33
  34 * [funcref boost::compute::dim dim()]
  35 * [classref boost::compute::extents extents<N>]
  36 * [classref boost::compute::program_cache program_cache]
  37 * [classref boost::compute::wait_list wait_list]
  38
  39 [h3 Algorithms]
  40
  41 Header: `<boost/compute/algorithm.hpp>`
  42
  43 * [funcref boost::compute::accumulate accumulate()]
  44 * [funcref boost::compute::adjacent_difference adjacent_difference()]
  45 * [funcref boost::compute::adjacent_find adjacent_find()]
  46 * [funcref boost::compute::all_of all_of()]
  47 * [funcref boost::compute::any_of any_of()]
  48 * [funcref boost::compute::binary_search binary_search()]
  49 * [funcref boost::compute::copy copy()]
  50 * [funcref boost::compute::copy_if copy_if()]
  51 * [funcref boost::compute::copy_n copy_n()]
  52 * [funcref boost::compute::count count()]
  53 * [funcref boost::compute::count_if count_if()]
  54 * [funcref boost::compute::equal equal()]
  55 * [funcref boost::compute::equal_range equal_range()]
  56 * [funcref boost::compute::exclusive_scan exclusive_scan()]
  57 * [funcref boost::compute::fill fill()]
  58 * [funcref boost::compute::fill_n fill_n()]
  59 * [funcref boost::compute::find find()]
  60 * [funcref boost::compute::find_end find_end()]
  61 * [funcref boost::compute::find_if find_if()]
  62 * [funcref boost::compute::find_if_not find_if_not()]
  63 * [funcref boost::compute::for_each for_each()]
  64 * [funcref boost::compute::for_each_n for_each_n()]
  65 * [funcref boost::compute::gather gather()]
  66 * [funcref boost::compute::generate generate()]
  67 * [funcref boost::compute::generate_n generate_n()]
  68 * [funcref boost::compute::includes includes()]
  69 * [funcref boost::compute::inclusive_scan inclusive_scan()]
  70 * [funcref boost::compute::inner_product inner_product()]
  71 * [funcref boost::compute::inplace_merge inplace_merge()]
  72 * [funcref boost::compute::iota iota()]
  73 * [funcref boost::compute::is_partitioned is_partitioned()]
  74 * [funcref boost::compute::is_permutation is_permutation()]
  75 * [funcref boost::compute::is_sorted is_sorted()]
  76 * [funcref boost::compute::lower_bound lower_bound()]
  77 * [funcref boost::compute::lexicographical_compare lexicographical_compare()]
  78 * [funcref boost::compute::max_element max_element()]
  79 * [funcref boost::compute::merge merge()]
  80 * [funcref boost::compute::min_element min_element()]
  81 * [funcref boost::compute::minmax_element minmax_element()]
  82 * [funcref boost::compute::mismatch mismatch()]
  83 * [funcref boost::compute::next_permutation next_permutation()]
  84 * [funcref boost::compute::none_of none_of()]
  85 * [funcref boost::compute::nth_element nth_element()]
  86 * [funcref boost::compute::partial_sum partial_sum()]
  87 * [funcref boost::compute::partition partition()]
  88 * [funcref boost::compute::partition_copy partition_copy()]
  89 * [funcref boost::compute::partition_point partition_point()]
  90 * [funcref boost::compute::prev_permutation prev_permutation()]
  91 * [funcref boost::compute::random_shuffle random_shuffle()]
  92 * [funcref boost::compute::reduce reduce()]
  93 * [funcref boost::compute::reduce_by_key reduce_by_key()]
  94 * [funcref boost::compute::remove remove()]
  95 * [funcref boost::compute::remove_if remove_if()]
  96 * [funcref boost::compute::replace replace()]
  97 * [funcref boost::compute::replace_copy replace_copy()]
  98 * [funcref boost::compute::reverse reverse()]
  99 * [funcref boost::compute::reverse_copy reverse_copy()]
 100 * [funcref boost::compute::rotate rotate()]
 101 * [funcref boost::compute::rotate_copy rotate_copy()]
 102 * [funcref boost::compute::scatter scatter()]
 103 * [funcref boost::compute::search search()]
 104 * [funcref boost::compute::search_n search_n()]
 105 * [funcref boost::compute::set_difference set_difference()]
 106 * [funcref boost::compute::set_intersection set_intersection()]
 107 * [funcref boost::compute::set_symmetric_difference set_symmetric_difference()]
 108 * [funcref boost::compute::set_union set_union()]
 109 * [funcref boost::compute::sort sort()]
 110 * [funcref boost::compute::sort_by_key sort_by_key()]
 111 * [funcref boost::compute::stable_partition stable_partition()]
 112 * [funcref boost::compute::stable_sort stable_sort()]
 113 * [funcref boost::compute::stable_sort_by_key stable_sort_by_key()]
 114 * [funcref boost::compute::swap_ranges swap_ranges()]
 115 * [funcref boost::compute::transform transform()]
 116 * [funcref boost::compute::transform_reduce transform_reduce()]
 117 * [funcref boost::compute::unique unique()]
 118 * [funcref boost::compute::unique_copy unique_copy()]
 119 * [funcref boost::compute::upper_bound upper_bound()]
 120
 121 [h3 Async]
 122
 123 Header: `<boost/compute/async.hpp>`
 124
 125 * [classref boost::compute::future future<T>]
 126 * [funcref boost::compute::wait_for_all wait_for_all()]
 127 * [classref boost::compute::wait_guard wait_guard<Waitable>]
 128
 129 [h3 Containers]
 130
 131 Header: `<boost/compute/container.hpp>`
 132
 133 * [classref boost::compute::array array<T, N>]
 134 * [classref boost::compute::basic_string basic_string<CharT>]
 135 * [classref boost::compute::dynamic_bitset dynamic_bitset<>]
 136 * [classref boost::compute::flat_map flat_map<Key, T>]
 137 * [classref boost::compute::flat_set flat_set<T>]
 138 * [classref boost::compute::mapped_view mapped_view<T>]
 139 * [classref boost::compute::stack stack<T>]
 140 * [classref boost::compute::string string]
 141 * [classref boost::compute::valarray valarray<T>]
 142 * [classref boost::compute::vector vector<T>]
 143
 144 [h3 Exceptions]
 145
 146 Header: `<boost/compute/exception.hpp>`
 147
 148 * [classref boost::compute::context_error context_error]
 149 * [classref boost::compute::no_device_found no_device_found]
 150 * [classref boost::compute::opencl_error opencl_error]
 151 * [classref boost::compute::unsupported_extension_error unsupported_extension_error]
 152
 153 [h3 Iterators]
 154
 155 Header: `<boost/compute/iterators.hpp>`
 156
 157 * [classref boost::compute::buffer_iterator buffer_iterator<T>]
 158 * [classref boost::compute::constant_buffer_iterator constant_buffer_iterator<T>]
 159 * [classref boost::compute::constant_iterator constant_iterator<T>]
 160 * [classref boost::compute::counting_iterator counting_iterator<T>]
 161 * [classref boost::compute::discard_iterator discard_iterator]
 162 * [classref boost::compute::function_input_iterator function_input_iterator<Function>]
 163 * [classref boost::compute::permutation_iterator permutation_iterator<ElementIterator, IndexIterator>]
 164 * [classref boost::compute::strided_iterator strided_iterator<Iterator>]
 165 * [classref boost::compute::transform_iterator transform_iterator<InputIterator, UnaryFunction>]
 166 * [classref boost::compute::zip_iterator zip_iterator<IteratorTuple>]
 167
 168 [h3 Images]
 169
 170 Header: `<boost/compute/image.hpp>`
 171
 172 * [classref boost::compute::image1d image1d]
 173 * [classref boost::compute::image2d image2d]
 174 * [classref boost::compute::image3d image3d]
 175 * [classref boost::compute::image_format image_format]
 176 * [classref boost::compute::image_object image_object]
 177 * [classref boost::compute::image_sampler image_sampler]
 178
 179 [h3 Shared Virtual Memory]
 180
 181 * [classref boost::compute::svm_ptr svm_ptr<T>]
 182 * [funcref boost::compute::svm_alloc svm_alloc<T>()]
 183 * [funcref boost::compute::svm_free svm_free<T>()]
 184
 185 [h3 Macros]
 186
 187 * [macroref BOOST_COMPUTE_ADAPT_STRUCT BOOST_COMPUTE_ADAPT_STRUCT()]
 188 * [macroref BOOST_COMPUTE_FUNCTION BOOST_COMPUTE_FUNCTION()]
 189 * [macroref BOOST_COMPUTE_STRINGIZE_SOURCE BOOST_COMPUTE_STRINGIZE_SOURCE()]
 190
 191 [h3 OpenGL Sharing]
 192
 193 Header: `<boost/compute/interop/opengl.hpp>`
 194
 195 * [classref boost::compute::opengl_buffer opengl_buffer]
 196 * [funcref boost::compute::opengl_create_shared_context opengl_create_shared_context()]
 197 * [funcref boost::compute::opengl_enqueue_acquire_buffer opengl_enqueue_acquire_buffer()]
 198 * [funcref boost::compute::opengl_enqueue_acquire_gl_objects opengl_enqueue_acquire_gl_objects()]
 199 * [funcref boost::compute::opengl_enqueue_release_buffer opengl_enqueue_release_buffer()]
 200 * [funcref boost::compute::opengl_enqueue_release_gl_objects opengl_enqueue_acquire_gl_objects()]
 201 * [classref boost::compute::opengl_renderbuffer opengl_renderbuffer]
 202 * [classref boost::compute::opengl_texture opengl_texture]
 203
 204 [h3 Random Number Generators]
 205
 206 Header: `<boost/compute/random.hpp>`
 207
 208 * [classref boost::compute::bernoulli_distribution bernoulli_distribution]
 209 * [classref boost::compute::default_random_engine default_random_engine]
 210 * [classref boost::compute::discrete_distribution discrete_distribution]
 211 * [classref boost::compute::linear_congruential_engine linear_congruential_engine]
 212 * [classref boost::compute::mersenne_twister_engine mersenne_twister_engine]
 213 * [classref boost::compute::normal_distribution normal_distribution]
 214 * [classref boost::compute::uniform_int_distribution uniform_int_distribution]
 215 * [classref boost::compute::uniform_real_distribution uniform_real_distribution]
 216
 217 [h3 Type Traits]
 218
 219 Header: `<boost/compute/type_traits.hpp>`
 220
 221 * [classref boost::compute::is_device_iterator is_device_iterator<Iterator>]
 222 * [classref boost::compute::is_fundamental is_fundamental<T>]
 223 * [classref boost::compute::is_vector_type is_vector_type<T>]
 224 * [classref boost::compute::make_vector_type make_vector_type<T, N>]
 225 * [classref boost::compute::result_of result_of<F(Args...)>]
 226 * [classref boost::compute::scalar_type scalar_type<T>]
 227 * [funcref boost::compute::type_name type_name<T>()]
 228
 229 [endsect] [/ overview]
 230
 231 [xinclude autodoc.xml]
 232
 233 [endsect] [/ reference ]