Concept Pipe

Boost C++ Libraries

Concept Pipe

Pipe

Description

A Pipe is a type grouping two functions that read a certain number of elements off a range and write another number of elements on another one, hence making it a many-to-many conversion facility.

Associated types

input_type
```
Pipe::input_type
```
The type of elements the pipe converts from.
output_type
```
Pipe::output_type
```
The type of elements the pipe converts into.
max_output
```
Pipe::max_output
```
Optional MPL integral constant that states how many elements may be added to out at maximum in an ltr or rtl call.

Notation

Pipe: A type playing the role of model of Pipe in the Pipe concept.
In: A type playing the role of model of Bidirectional Iterator with elements convertible to input_type in the Pipe concept.
Out: A type playing the role of model of OutputIterator<output_type> in the Pipe concept.
p: Object of type Pipe
begin, end: Objects of type In
out: Object of type Out

Valid expressions

Name	Expression	Type	Precondition	Semantics
Construction	Pipe()	Pipe		Construct an instance of the type with default parameters.
Left to right	p.ltr(begin, end, out)	std::pair<In, Out>	`begin != end`	Reads part of the [`begin`, `end`[ range left to right, writes some elements of type `output_type` to `out`, and returns a pair indicating the new begin iterator and the past-the-end output iterator.
Right to left	p.rtl(begin, end, out)	std::pair<In, Out>	`begin != end`	Reads part of the [`begin`, `end`[ range right to left, writes some elements of type `output_type` to `out`, and returns a pair indicating the new past-the-end iterator and the past-the-end output iterator.

Models

boost::unicode::u8_decoder, boost::unicode::u16_decoder, boost::unicode::hangul_composer