forked from boostorg/fusion
[transform_view_ext] Updated docs
This commit is contained in:
@ -133,7 +133,6 @@ For any Forward Sequence s the following invariants always hold:
|
||||
* __transform_view__
|
||||
* __reverse_view__
|
||||
* __zip_view__
|
||||
* __identity_view__
|
||||
|
||||
[endsect]
|
||||
|
||||
@ -202,7 +201,6 @@ are not defined in __forward_sequence__.
|
||||
* __iterator_range__ (where adapted sequence is a Bidirectional Sequence)
|
||||
* __transform_view__ (where adapted sequence is a Bidirectional Sequence)
|
||||
* __zip_view__ (where adapted sequences are models of Bidirectional Sequence)
|
||||
* __identity_view__ (where adapted sequence is a Bidirectional Sequence)
|
||||
|
||||
[endsect]
|
||||
|
||||
@ -291,7 +289,6 @@ are not defined in __bidirectional_sequence__.
|
||||
* __iterator_range__ (where adapted sequence is a Random Access Sequence)
|
||||
* __transform_view__ (where adapted sequence is a Random Access Sequence)
|
||||
* __zip_view__ (where adapted sequences are models of Random Access Sequence)
|
||||
* __identity_view__ (where adapted sequence is a Random Access Sequence)
|
||||
|
||||
[endsect]
|
||||
|
||||
@ -364,7 +361,6 @@ you can use `__result_of_value_at_key__<S, K>`.]
|
||||
* __joint_view__ (where adapted sequences are __associative_sequence__\ s and __forward_sequence__\ s)
|
||||
* __reverse_view__ (where adapted sequence is an __associative_sequence__ and a __bidirectional_sequence__)
|
||||
* __transform_view__ (where adapted sequence is an __associative_sequence__ and a __forward_sequence__)
|
||||
* __identity_view__ (where adapted sequence is an __associative_sequence__ and a __forward_sequence__)
|
||||
|
||||
[endsect]
|
||||
|
||||
|
65
doc/view.qbk
65
doc/view.qbk
@ -1,7 +1,6 @@
|
||||
[/==============================================================================
|
||||
Copyright (C) 2001-2011 Joel de Guzman
|
||||
Copyright (C) 2006 Dan Marsden
|
||||
Copyright (c) 2022 Denis Mikhailov
|
||||
|
||||
Use, modification and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
@ -361,10 +360,10 @@ given a binary function object or function pointer.
|
||||
|
||||
[heading Model of]
|
||||
|
||||
* __forward_sequence__, __bidirectional_sequence__ or
|
||||
__random_access_sequence__ depending on the traversal characteristics (see
|
||||
__traversal_concept__) of its underlying sequence or sequences.
|
||||
* __associative_sequence__ if underlying sequence implements the __associative_sequence__ model(available only with unary version of `transform_view`).
|
||||
* A model of __forward_sequence__ if `Sequence` is a __forward_sequence__
|
||||
else, __bidirectional_sequence__ if `Sequence` is a __bidirectional_sequence__
|
||||
else, __random_access_sequence__ if `Sequence` is a __random_access_sequence__.
|
||||
* __associative_sequence__ if `Sequence` implements the __associative_sequence__ model.
|
||||
|
||||
[variablelist Notation
|
||||
[[`TV`] [A `transform_view` type]]
|
||||
@ -665,60 +664,4 @@ defined in __forward_sequence__.
|
||||
|
||||
[endsect]
|
||||
|
||||
[section identity_view]
|
||||
|
||||
[heading Description]
|
||||
|
||||
`identity_view` presents underlying sequence unchanged.
|
||||
|
||||
[heading Header]
|
||||
|
||||
#include <boost/fusion/view/identity_view.hpp>
|
||||
#include <boost/fusion/include/identity_view.hpp>
|
||||
|
||||
[heading Synopsis]
|
||||
|
||||
template <typename Sequence>
|
||||
struct identity_view;
|
||||
|
||||
[heading Template parameters]
|
||||
|
||||
[table
|
||||
[[Parameter] [Description] [Default]]
|
||||
[[`Sequence`] [A __forward_sequence__] []]
|
||||
]
|
||||
|
||||
[heading Model of]
|
||||
|
||||
* A model of __forward_sequence__ if `Sequence` is a __forward_sequence__ else, __bidirectional_sequence__ if `Sequence` is a __bidirectional_sequence__
|
||||
else, __random_access_sequence__ if `Sequence` is a __random_access_sequence__.
|
||||
* __associative_sequence__ if `Sequence` implements the __associative_sequence__ model.
|
||||
|
||||
[variablelist Notation
|
||||
[[`IV`] [An `identity_view` type]]
|
||||
[[`s`] [An instance of `Sequence`]]
|
||||
[[`iv`, `iv2`] [Instances of `identity_view`]]
|
||||
]
|
||||
|
||||
[heading Expression Semantics]
|
||||
|
||||
Semantics of an expression is defined only where it differs from, or is not
|
||||
defined in the implemented models.
|
||||
|
||||
[table
|
||||
[[Expression] [Semantics]]
|
||||
[[`IV(s)`] [Creates an `identity_view` given sequence, `s`.]]
|
||||
[[`IV(iv)`] [Copy constructs an `identity_view` from another `identity_view`, `iv`.]]
|
||||
[[`iv = iv2`] [Assigns to an `identity_view`, `iv`, from another `identity_view`, `iv2`.]]
|
||||
]
|
||||
|
||||
[heading Example]
|
||||
typedef __vector__<int, short, double> vector_type;
|
||||
vector_type vec(2, 5, 3.3);
|
||||
|
||||
__identity_view__<vector_type> identity(vec);
|
||||
std::cout << identity << std::endl; // (2 5 3.3)
|
||||
|
||||
[endsect]
|
||||
|
||||
[endsect]
|
||||
|
Reference in New Issue
Block a user