CGAL 5.1 - STL Extensions for CGAL
CGAL::Join_input_iterator_2< I1, I2, Op > Class Template Reference

#include <CGAL/iterator.h>

Definition

template<typename I1, typename I2, typename Op>
class CGAL::Join_input_iterator_2< I1, I2, Op >

The class Join_input_iterator_2 joins two iterators. The result is again an iterator (of the same iterator category type as the original iterator) that reads an object from the stream and applies a function object to that object.

Is Model Of:
InputIterator

Public Types

typedef Op::result_type value_type
 
typedef std::iterator_traits< I1 >::difference_type difference_type
 
typedef value_typepointer
 
typedef value_typereference
 

Public Member Functions

I1 current_iterator1 () const
 returns current position of the first iterator. More...
 
I2 current_iterator2 () const
 returns current position of the second iterator. More...
 
const value_typeoperator* () const
 returns op(current_iterator1(), current_iterator2()). More...
 

Creation

 Join_input_iterator_2 ()
 Default constructor. More...
 
 Join_input_iterator_2 (I1 i1, I2 i2, const Op &op=Op())
 creates a join iterator from the given iterators i1, i2, and the functor op. More...
 

Member Typedef Documentation

◆ difference_type

template<typename I1 , typename I2 , typename Op >
typedef std::iterator_traits<I1>::difference_type CGAL::Join_input_iterator_2< I1, I2, Op >::difference_type

◆ pointer

template<typename I1 , typename I2 , typename Op >
typedef value_type* CGAL::Join_input_iterator_2< I1, I2, Op >::pointer

◆ reference

template<typename I1 , typename I2 , typename Op >
typedef value_type& CGAL::Join_input_iterator_2< I1, I2, Op >::reference

◆ value_type

template<typename I1 , typename I2 , typename Op >
typedef Op::result_type CGAL::Join_input_iterator_2< I1, I2, Op >::value_type

Constructor & Destructor Documentation

◆ Join_input_iterator_2() [1/2]

template<typename I1 , typename I2 , typename Op >
CGAL::Join_input_iterator_2< I1, I2, Op >::Join_input_iterator_2 ( )

Default constructor.

◆ Join_input_iterator_2() [2/2]

template<typename I1 , typename I2 , typename Op >
CGAL::Join_input_iterator_2< I1, I2, Op >::Join_input_iterator_2 ( I1  i1,
I2  i2,
const Op &  op = Op() 
)

creates a join iterator from the given iterators i1, i2, and the functor op.

Member Function Documentation

◆ current_iterator1()

template<typename I1 , typename I2 , typename Op >
I1 CGAL::Join_input_iterator_2< I1, I2, Op >::current_iterator1 ( ) const

returns current position of the first iterator.

◆ current_iterator2()

template<typename I1 , typename I2 , typename Op >
I2 CGAL::Join_input_iterator_2< I1, I2, Op >::current_iterator2 ( ) const

returns current position of the second iterator.

◆ operator*()

template<typename I1 , typename I2 , typename Op >
const value_type& CGAL::Join_input_iterator_2< I1, I2, Op >::operator* ( ) const