Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/iterator/front inserter"

From cppreference.com
< cpp‎ | iterator
m (r2.7.3) (Robot: Adding de, es, fr, it, ja, pt, ru, zh)
m (Synopsis: {{mark constexpr since c++20}})
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{cpp/title|front_inserter}}
 
{{cpp/title|front_inserter}}
 
{{cpp/iterator/navbar}}
 
{{cpp/iterator/navbar}}
{{ddcl list begin}}
+
{{ddcl|header=iterator|notes={{mark constexpr since c++20}}|
{{ddcl list header | iterator}}
+
{{ddcl list item |
+
 
template< class Container >
 
template< class Container >
std::front_insert_iterator<Container> front_inserter( Container& c);
+
std::front_insert_iterator<Container> front_inserter( Container& c );
 
}}
 
}}
{{ddcl list end}}
 
  
{{tt|front_inserter}} is a convenience function template that constructs a {{c|std::front_insert_iterator}} for the container {{tt|c}} with the type deduced from the type of the argument.
+
{{tt|front_inserter}} is a convenience function template that constructs a {{lc|std::front_insert_iterator}} for the container {{c|c}} with the type deduced from the type of the argument.
  
 
===Parameters===
 
===Parameters===
{{param list begin}}
+
{{par begin}}
{{param list item | c | container that supports a {{tt|push_front}} operation}}
+
{{par|c|container that supports a {{tt|push_front}} operation}}
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
A {{c|std::front_insert_iterator}} which can be used to add elements to the beginning of the container {{tt|c}}
+
A {{lc|std::front_insert_iterator}} which can be used to add elements to the beginning of the container {{c|c}}.
  
 
===Possible implementation===
 
===Possible implementation===
{{eq fun | 1=
+
{{eq fun|1=
template< class Container >
+
template<class Container>
std::front_insert_iterator<Container> front_inserter( Container& c)
+
std::front_insert_iterator<Container> front_inserter( Container& c )
 
{
 
{
 
     return std::front_insert_iterator<Container>(c);
 
     return std::front_insert_iterator<Container>(c);
Line 30: Line 27:
 
===Example===
 
===Example===
 
{{example
 
{{example
|
+
|code=
| code=
+
#include <iostream>
+
#include <deque>
+
 
#include <algorithm>
 
#include <algorithm>
 +
#include <deque>
 +
#include <iostream>
 
#include <iterator>
 
#include <iterator>
 +
#include <vector>
 +
 
int main()
 
int main()
 
{
 
{
     std::deque<int> v{1,2,3,4,5,6,7,8,9,10};
+
     std::vector<int> v{1, 2, 3, 4, 5};
     std::fill_n(std::front_inserter(v), 3, -1);
+
     std::deque<int> d;
     for(int n : v)
+
    std::copy(v.begin(), v.end(), std::front_inserter(d));
 +
     for (int n : d)
 
         std::cout << n << ' ';
 
         std::cout << n << ' ';
 +
    std::cout << '\n';
 
}
 
}
| output=
+
|output=
-1 -1 -1 1 2 3 4 5 6 7 8 9 10
+
5 4 3 2 1  
 
}}
 
}}
  
 
===See also===
 
===See also===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list template | cpp/iterator/dcl list front_insert_iterator}}
+
{{dsc inc|cpp/iterator/dsc front_insert_iterator}}
{{dcl list template | cpp/iterator/dcl list back_inserter}}
+
{{dsc inc|cpp/iterator/dsc back_inserter}}
{{dcl list template | cpp/iterator/dcl list inserter}}
+
{{dsc inc|cpp/iterator/dsc inserter}}
{{dcl list end}}
+
{{dsc end}}
  
[[de:cpp/iterator/front inserter]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
[[es:cpp/iterator/front inserter]]
+
[[fr:cpp/iterator/front inserter]]
+
[[it:cpp/iterator/front inserter]]
+
[[ja:cpp/iterator/front inserter]]
+
[[pt:cpp/iterator/front inserter]]
+
[[ru:cpp/iterator/front inserter]]
+
[[zh:cpp/iterator/front inserter]]
+

Latest revision as of 14:54, 3 October 2023

 
 
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)
(C++17)
 
Defined in header <iterator>
template< class Container >
std::front_insert_iterator<Container> front_inserter( Container& c );
(constexpr since C++20)

front_inserter is a convenience function template that constructs a std::front_insert_iterator for the container c with the type deduced from the type of the argument.

Contents

[edit] Parameters

c - container that supports a push_front operation

[edit] Return value

A std::front_insert_iterator which can be used to add elements to the beginning of the container c.

[edit] Possible implementation

template<class Container>
std::front_insert_iterator<Container> front_inserter( Container& c )
{
    return std::front_insert_iterator<Container>(c);
}

[edit] Example

#include <algorithm>
#include <deque>
#include <iostream>
#include <iterator>
#include <vector>
 
int main()
{
    std::vector<int> v{1, 2, 3, 4, 5};
    std::deque<int> d;
    std::copy(v.begin(), v.end(), std::front_inserter(d));
    for (int n : d)
        std::cout << n << ' ';
    std::cout << '\n';
}

Output:

5 4 3 2 1

[edit] See also

iterator adaptor for insertion at the front of a container
(class template) [edit]
creates a std::back_insert_iterator of type inferred from the argument
(function template) [edit]
creates a std::insert_iterator of type inferred from the argument
(function template) [edit]