GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing cplusplus.com — std::get_temporary_buffer

Reference

C library:
- <cassert> (assert.h)
- <cctype> (ctype.h)
- <cerrno> (errno.h)
- C++11
  <cfenv> (fenv.h)
- <cfloat> (float.h)
- C++11
  <cinttypes> (inttypes.h)
- <ciso646> (iso646.h)
- <climits> (limits.h)
- <clocale> (locale.h)
- <cmath> (math.h)
- <csetjmp> (setjmp.h)
- <csignal> (signal.h)
- <cstdarg> (stdarg.h)
- C++11
  <cstdbool> (stdbool.h)
- <cstddef> (stddef.h)
- C++11
  <cstdint> (stdint.h)
- <cstdio> (stdio.h)
- <cstdlib> (stdlib.h)
- <cstring> (string.h)
- C++11
  <ctgmath> (tgmath.h)
- <ctime> (time.h)
- C++11
  <cuchar> (uchar.h)
- <cwchar> (wchar.h)
- <cwctype> (wctype.h)
Containers:
- C++11
  <array>
- <deque>
- C++11
  <forward_list>
- <list>
- <map>
- <queue>
- <set>
- <stack>
- C++11
  <unordered_map>
- C++11
  <unordered_set>
- <vector>
Input/Output:
- <fstream>
- <iomanip>
- <ios>
- <iosfwd>
- <iostream>
- <istream>
- <ostream>
- <sstream>
- <streambuf>
Multi-threading:
- C++11
  <atomic>
- C++11
  <condition_variable>
- C++11
  <future>
- C++11
  <mutex>
- C++11
  <thread>
Other:
- <algorithm>
- <bitset>
- C++11
  <chrono>
- C++11
  <codecvt>
- <complex>
- <exception>
- <functional>
- C++11
  <initializer_list>
- <iterator>
- <limits>
- <locale>
- <memory>
- <new>
- <numeric>
- C++11
  <random>
- C++11
  <ratio>
- C++11
  <regex>
- <stdexcept>
- <string>
- C++11
  <system_error>
- C++11
  <tuple>
- C++11
  <type_traits>
- C++11
  <typeindex>
- <typeinfo>
- <utility>
- <valarray>

<memory>

classes
- allocator
- C++11
  allocator_arg_t
- C++11
  allocator_traits
- auto_ptr
- auto_ptr_ref
- C++11
  bad_weak_ptr
- C++11
  default_delete
- C++11
  enable_shared_from_this
- C++11
  owner_less
- C++11
  pointer_traits
- raw_storage_iterator
- C++11
  shared_ptr
- C++11
  unique_ptr
- C++11
  uses_allocator
- C++11
  weak_ptr
enum classes
- C++11
  pointer_safety
functions
- C++11
  addressof
- C++11
  align
- C++11
  allocate_shared
- C++11
  const_pointer_cast
- C++11
  declare_no_pointers
- C++11
  declare_reachable
- C++11
  dynamic_pointer_cast
- C++11
  get_deleter
- C++11
  get_pointer_safety
- get_temporary_buffer
- C++11
  make_shared
- return_temporary_buffer
- C++11
  static_pointer_cast
- C++11
  undeclare_no_pointers
- C++11
  undeclare_reachable
- uninitialized_copy
- C++11
  uninitialized_copy_n
- uninitialized_fill
- uninitialized_fill_n
objects
- C++11
  allocator_arg

Reference
<memory>
get_temporary_buffer

function template

std::get_temporary_buffer

template <class T>  pair <T*,ptrdiff_t> get_temporary_buffer ( ptrdiff_t n );

template <class T>  pair <T*,ptrdiff_t> get_temporary_buffer ( ptrdiff_t n ) noexcept;

Get block of temporary memory

Requests a temporary block of storage to contain up to n elements of type T temporarily.

The block of storage is aligned apropriately to contain elements of type T if T has a fundamental alignment, although it is left uninitialized (no object is constructed).

This function is specifically designed to obtain memory of temporary nature (such as for the operations of an algorithm). Once the memory block is not needed anymore, it shall be released by calling return_temporary_buffer.

Notice that the actual size of the buffer returned may be smaller than requested (the actual size is indicated as part of the return value).

Parameters

n: Number of elements of type T for which temporary memory is requested.
ptrdiff_t is an integral type.

Return value

On success, the function returns a pair object with its first element containing a pointer to the first element in the block, and the second element its size, in terms of number of elements of type T that it can hold.

If the storage cannot be allocated, the pair contains a null pointer as first and a value of zero as second.

Example

// get/return_temporary_buffer example
#include <iostream>
#include <memory>
#include <algorithm>

int main () {
  int numbers[] = {30,50,10,20,60,40};

  // use temporary buffer to sort and show the numbers:
  std::pair <int*,std::ptrdiff_t> result = std::get_temporary_buffer<int>(6);
  if (result.second>0)
  {
    std::uninitialized_copy (numbers,numbers+result.second,result.first);
    std::sort (result.first,result.first+result.second);
    std::cout << "sorted numbers  : ";
    for (int i=0;i<result.second;i++)
      std::cout << result.first[i] << " ";
    std::cout << '\n';
    std::return_temporary_buffer (result.first);
  }

  // show original numbers:
  std::cout << "unsorted numbers: ";
  for (int i=0;i<6;i++)
    std::cout << numbers[i] << " ";
  std::cout << '\n';
  return 0;
}

Possible output:


sorted numbers  : 10 20 30 40 50 60
unsorted numbers: 30 50 10 20 60 40

classes

enum classes

functions

objects

std::get_temporary_buffer

Parameters

Return value

Example

See also