Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/iterator/data"

From cppreference.com
< cpp‎ | iterator
m (s/method/member function)
(Updated the header list.)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{cpp/title| data}}
+
{{cpp/title|data}}
 
{{cpp/iterator/navbar}}
 
{{cpp/iterator/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
−
{{dcl header | array}}
+
{{cpp/iterator/range access headers}}
−
{{dcl header | deque}}
+
{{dcla|num=1|since=c++17|
−
{{dcl header | forward_list}}
+
template< class C >
−
{{dcl header | iterator}}
+
constexpr auto data( C& c ) -> decltype(c.data());
−
{{dcl header | list}}
+
−
{{dcl header | map}}
+
−
{{dcl header | regex}}
+
−
{{dcl header | set}}
+
−
{{dcl header | span | notes={{mark since c++20}}}}
+
−
{{dcl header | string}}
+
−
{{dcl header | string_view}}
+
−
{{dcl header | unordered_map}}
+
−
{{dcl header | unordered_set}}
+
−
{{dcl header | vector}}
+
−
{{dcl | num=1 | since=c++17 |
+
−
template <class C>  
+
−
constexpr auto data(C& c) -> decltype(c.data());
+
 
}}
 
}}
−
{{dcl | num=2 | since=c++17 |
+
{{dcla|num=2|since=c++17|
−
template <class C>  
+
template< class C >
−
constexpr auto data(const C& c) -> decltype(c.data());
+
constexpr auto data( const C& c ) -> decltype(c.data());
 
}}
 
}}
−
{{dcl | num=3 | since=c++17 |
+
{{dcla|num=3|since=c++17|
−
template <class T, std::size_t N>  
+
template< class T, std::size_t N >
−
constexpr T* data(T (&array)[N]) noexcept;
+
constexpr T* data( T (&array)[N] ) noexcept;
 
}}
 
}}
−
{{dcl | num=4 | since=c++17 |
+
{{dcla|num=4|since=c++17|
−
template <class E>
+
template< class E >
−
constexpr const E* data(std::initializer_list<E> il) noexcept;
+
constexpr const E* data( std::initializer_list<E> il ) noexcept;
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
Returns a pointer to the block of memory containing the elements of the container.
+
Returns a pointer to the block of memory containing the elements of the range.
  
−
@1,2@ returns {{c|c.data()}}
+
@1,2@ Returns {{c|c.data()}}.
−
@3@ returns {{c|array}}
+
@3@ Returns {{c|array}}.
−
@4@ returns {{c|il.begin()}}
+
@4@ Returns {{c|il.begin()}}.
  
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
−
{{par | c | a container with a {{c|data()}} member function}}
+
{{par|c|a container or view with a {{c|data()}} member function}}
−
{{par | array | an array of arbitrary type}}
+
{{par|array|an array of arbitrary type}}
−
{{par | il | an initializer list}}
+
{{par|il|an {{lc|std::initializer_list}}}}
 
{{par end}}
 
{{par end}}
  
 
===Return value===
 
===Return value===
−
A pointer to the block of memory containing the elements of the container.
+
@1,2@ {{c|c.data()}}
 +
@3@ {{c|array}}
 +
@4@ {{c|il.begin()}}
 +
 
 +
===Exceptions===
 +
@1@ {{cpp/impldef exception item}}
 +
 
 +
===Notes===
 +
The overload for {{lc|std::initializer_list}} is necessary because it does not have a member function {{tt|data}}.
 +
 
 +
{{feature test macro|__cpp_lib_nonmember_container_access|{{lc|std::size()}}, {{tt|std::data()}}, and {{lc|std::empty()}}|value=201411L|std=C++17}}
  
 
===Possible implementation===
 
===Possible implementation===
−
{{eq fun
+
{{eq impl
−
| 1=
+
|ver1=1|1=
−
template <class C>  
+
template<class C>
 
constexpr auto data(C& c) -> decltype(c.data())
 
constexpr auto data(C& c) -> decltype(c.data())
 
{
 
{
 
     return c.data();
 
     return c.data();
 
}
 
}
−
| 2=
+
|ver2=2|2=
−
template <class C>  
+
template<class C>
 
constexpr auto data(const C& c) -> decltype(c.data())
 
constexpr auto data(const C& c) -> decltype(c.data())
 
{
 
{
 
     return c.data();
 
     return c.data();
 
}
 
}
−
| 3=
+
|ver3=3|3=
−
template <class T, std::size_t N>
+
template<class T, std::size_t N>
 
constexpr T* data(T (&array)[N]) noexcept
 
constexpr T* data(T (&array)[N]) noexcept
 
{
 
{
 
     return array;
 
     return array;
 
}
 
}
−
|4=
+
|ver4=4|4=
−
template <class E>  
+
template<class E>
 
constexpr const E* data(std::initializer_list<E> il) noexcept
 
constexpr const E* data(std::initializer_list<E> il) noexcept
 
{
 
{
Line 79: Line 76:
  
 
===Example===
 
===Example===
−
 
+
{{example
−
{{example|code=
+
|code=
−
#include <string>
+
 
#include <cstring>
 
#include <cstring>
 
#include <iostream>
 
#include <iostream>
 +
#include <string>
  
 
int main()
 
int main()
 
{
 
{
−
     std::string s {"Hello world!\n"};
+
     std::string s{"Hello world!\n"};
  
−
     char a[20]; //storage for a C-style string
+
     char a[20]; // storage for a C-style string
 
     std::strcpy(a, std::data(s));
 
     std::strcpy(a, std::data(s));
−
    //[s.data(), s.data() + s.size()] is guaranteed to be an NTBS since C++11
+
// [s.data(), s.data() + s.size()] is guaranteed to be an NTBS since C++11
  
 
     std::cout << a;
 
     std::cout << a;
Line 99: Line 96:
 
}}
 
}}
  
−
{{langlinks|es|ja|zh}}
+
===See also===
 +
{{dsc begin}}
 +
{{dsc inc|cpp/ranges/dsc data}}
 +
{{dsc inc|cpp/ranges/dsc cdata}}
 +
{{dsc end}}
 +
 
 +
{{langlinks|es|ja|ru|zh}}

Latest revision as of 18:28, 20 February 2024

 
C++
 
Iterator library
Iterator concepts
Iterator primitives
Algorithm concepts and utilities
Indirect callable concepts
Common algorithm requirements
(C++20)
(C++20)
(C++20)
Utilities
(C++20)
Iterator adaptors
Range access
(C++11)(C++14)
(C++14)(C++14)  
(C++11)(C++14)
(C++14)(C++14)  
(C++17)(C++20)
(C++17)
data
(C++17)
 
Defined in header <array>
Defined in header <deque>
Defined in header <flat_map>
Defined in header <flat_set>
Defined in header <forward_list>
Defined in header <inplace_vector>
Defined in header <iterator>
Defined in header <list>
Defined in header <map>
Defined in header <regex>
Defined in header <set>
Defined in header <span>
Defined in header <string>
Defined in header <string_view>
Defined in header <unordered_map>
Defined in header <unordered_set>
Defined in header <vector>
template< class C >
constexpr auto data( C& c ) -> decltype(c.data());
 (1) (since C++17)
template< class C >
constexpr auto data( const C& c ) -> decltype(c.data());
 (2) (since C++17)
template< class T, std::size_t N >
constexpr T* data( T (&array)[N] ) noexcept;
 (3) (since C++17)
template< class E >
constexpr const E* data( std::initializer_list<E> il ) noexcept;
 (4) (since C++17)

Returns a pointer to the block of memory containing the elements of the range.

1,2) Returns c.data().
3) Returns array.
4) Returns il.begin().

Contents

[edit] Parameters

c - a container or view with a data() member function
array - an array of arbitrary type
il - an std::initializer_list

[edit] Return value

1,2) c.data()
3) array
4) il.begin()

[edit] Exceptions

1) May throw implementation-defined exceptions.

[edit] Notes

The overload for std::initializer_list is necessary because it does not have a member function data.

Feature-test macro Value Std Feature
__cpp_lib_nonmember_container_access 201411L (C++17) std::size(), std::data(), and std::empty()

[edit] Possible implementation

First version 
template<class C>
constexpr auto data(C& c) -> decltype(c.data())
{
    return c.data();
}
Second version 
template<class C>
constexpr auto data(const C& c) -> decltype(c.data())
{
    return c.data();
}
Third version 
template<class T, std::size_t N>
constexpr T* data(T (&array)[N]) noexcept
{
    return array;
}
Fourth version 
template<class E>
constexpr const E* data(std::initializer_list<E> il) noexcept
{
    return il.begin();
}

[edit] Example

Run this code
#include <cstring>
#include <iostream>
#include <string>
 
int main()
{
    std::string s{"Hello world!\n"};
 
    char a[20]; // storage for a C-style string
    std::strcpy(a, std::data(s));
//  [s.data(), s.data() + s.size()] is guaranteed to be an NTBS since C++11
 
    std::cout << a;
}

Output: 

Hello world!

[edit] See also

(C++20)
 obtains a pointer to the beginning of a contiguous range
(customization point object)[edit]
(C++20)
 obtains a pointer to the beginning of a read-only contiguous range
(customization point object)[edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/iterator/data&oldid=169889"