From 696f056592193e0413ba787fa5f1aeaa436d660f Mon Sep 17 00:00:00 2001 From: Aleksey Gurtovoy Date: Wed, 12 Mar 2003 13:52:13 +0000 Subject: [PATCH] update the docs [SVN r17844] --- doc/ref/Reference/erase_all.html | 62 ------------------------- doc/ref/Reference/erase_if.html | 62 ------------------------- doc/ref/Reference/iter_fold_if.html | 70 ----------------------------- doc/ref/Reference/logical_and.html | 62 ------------------------- doc/ref/Reference/logical_not.html | 51 --------------------- doc/ref/Reference/logical_or.html | 62 ------------------------- doc/ref/Reference/next.html | 61 ------------------------- doc/ref/Reference/prior.html | 61 ------------------------- doc/ref/Reference/sort.html | 62 ------------------------- doc/ref/Reference/unique.html | 62 ------------------------- doc/ref/Table_of_Content.html | 14 ------ 11 files changed, 629 deletions(-) delete mode 100644 doc/ref/Reference/erase_all.html delete mode 100644 doc/ref/Reference/erase_if.html delete mode 100644 doc/ref/Reference/iter_fold_if.html delete mode 100644 doc/ref/Reference/logical_and.html delete mode 100644 doc/ref/Reference/logical_not.html delete mode 100644 doc/ref/Reference/logical_or.html delete mode 100644 doc/ref/Reference/next.html delete mode 100644 doc/ref/Reference/prior.html delete mode 100644 doc/ref/Reference/sort.html delete mode 100644 doc/ref/Reference/unique.html delete mode 100644 doc/ref/Table_of_Content.html diff --git a/doc/ref/Reference/erase_all.html b/doc/ref/Reference/erase_all.html deleted file mode 100644 index ceb8f67..0000000 --- a/doc/ref/Reference/erase_all.html +++ /dev/null @@ -1,62 +0,0 @@ - -boost::mpl::Reference/erase all - - -

[Home]erase_all

Synopsis -

-

-

-template<
-      typename Sequence
-    , typename T
-    >
-struct erase_all
-{
-    typedef implementation-defined type;
-};
-
-

-

Description -

-

-[to do] -

-

Definition -

-

-

-#include "boost/mpl/erase_all.hpp"
-
-

-

Parameters -

- - - -
 Parameter  Requirement  Description  Default argument  
ParamA model of Concept[to do][to do]
-

-

Members -

- - - -
 Member  Description  
type[to do]
-

-

Complexity -

-

-[to do] -

-

Example -

-

-

-[to do]
-
-

-

See also -

-

-Algorithms, erase, erase_if, erase_range -

-Table of Content | Reference
Last edited February 19, 2002 3:53 am \ No newline at end of file diff --git a/doc/ref/Reference/erase_if.html b/doc/ref/Reference/erase_if.html deleted file mode 100644 index 533901e..0000000 --- a/doc/ref/Reference/erase_if.html +++ /dev/null @@ -1,62 +0,0 @@ - -boost::mpl::Reference/erase if - - -

[Home]erase_if

Synopsis -

-

-

-template<
-      typename Sequence
-    , typename Predicate
-    >
-struct erase_if
-{
-    typedef implementation-defined type;
-};
-
-

-

Description -

-

-[to do] -

-

Definition -

-

-

-#include "boost/mpl/erase_if.hpp"
-
-

-

Parameters -

- - - -
 Parameter  Requirement  Description  Default argument  
ParamA model of Concept[to do][to do]
-

-

Members -

- - - -
 Member  Description  
type[to do]
-

-

Complexity -

-

-[to do] -

-

Example -

-

-

-[to do]
-
-

-

See also -

-

-Algorithms, erase_all, erase_if, erase_range -

-Table of Content | Reference
Last edited February 19, 2002 3:54 am \ No newline at end of file diff --git a/doc/ref/Reference/iter_fold_if.html b/doc/ref/Reference/iter_fold_if.html deleted file mode 100644 index 320c43f..0000000 --- a/doc/ref/Reference/iter_fold_if.html +++ /dev/null @@ -1,70 +0,0 @@ - -boost::mpl::Reference/iter fold if - - -

[Home]iter_fold_if

Synopsis

-

-

-template<
-      typename Sequence
-    , typename State
-    , typename BackwardOp
-    , typename ForwardOp = _1
-    >
-struct iter_fold_backward
-{
-    typedef unspecified type;
-};
-
-

-

Description

-

-Returns the result of the successive application of binary BackwardOp to the result of the previous BackwardOp invocation (State if it's the first call) and each iterator in the range [begin<Sequence>::type,end<Sequence>::type) in the reverse order. If ForwardOp is provided, then it's applied on forward traversal to form the result which is passed to the first BackwardOp call. -

-

Definition

-

-

-#include "boost/mpl/iter_fold_backward.hpp"
-
-

-

Parameters

- - - - - - -
 Parameter  Requirement  Description  Default value  
SequenceA model of SequenceA sequence to iterate.
StateA typeThe initial state for the first BackwardOp/ForwardOp application.
BackwardOpA model of [Lambda Function]The operation to be executed on backward traversal.
ForwardOpA model of [Lambda Function]The operation to be executed on forward traversal.arg<1>
-

-

Expression semantics

-

- - - - -
 Expression  Expression type  Precondition  Semantics  Postcondition 
typedef iter_fold_backward< Sequence,T,BackwardOp >::type t;A typeEquivalent to typedef lambda<BackwardOp>::type bk_op; typedef begin<Sequence>::type i1; typedef i1::next i2; ...; typedef in::next last; typedef apply<bk_op,T,in>::type tn; typedef apply<bk_op,tn,in-1>::type tn-1; ...; typedef apply<bk_op,t2,i1>::type t1; typedef t1 t, where n == size<Sequence>::type::value and last is identical to end<Sequence>::type; Equivalent to typedef T t; if the sequence is empty.
typedef iter_fold_backward< Sequence,T,BackwardOp,ForwardOp >::type t;A typeEquivalent to typedef iter_fold_backward<Sequence, iter_fold<Sequence,State,ForwardOp>::type, BackwardOp>::type t;.
-

-

Complexity

-

-Linear. Exactly size<Sequence>::type::value applications of BackwardOp and ForwardOp. -

-

Example

-

-Finds an iterator to the last negative element in the sequence. -

-

-typedef list_c<int,5,-1,0,7,2,0,-5,4> numbers;
-typedef iter_fold_backward<
-      numbers
-    , end<numbers>::type
-    , if_< less< deref<_2>, int_c<0> >,_2,_1 >
-    >::type last_negative_iter;
-

-BOOST_STATIC_ASSERT(last_negative_iter::type::value == -5);
-
-

-

See also

-

-Algorithms, iter_fold, fold_backward, fold, copy, copy_backward -

-Table of Content | Reference
Last edited July 19, 2002 1:25 am \ No newline at end of file diff --git a/doc/ref/Reference/logical_and.html b/doc/ref/Reference/logical_and.html deleted file mode 100644 index ce03f3d..0000000 --- a/doc/ref/Reference/logical_and.html +++ /dev/null @@ -1,62 +0,0 @@ - -boost::mpl::Reference/logical and - - -

[Home]logical_and

Synopsis

-

-

-template< 
-      typename F1
-    , typename F2
-    , typename F3 = true_c
-    ...
-    , typename Fn = true_c
-    >
-struct logical_and
-{
-    typedef unspecified type;
-};
-
-

-

Description

-

-Returns the result of short-circuit logical and (&&) operation on its arguments. -

-

Definition

-

-

-#include "boost/mpl/logical/and.hpp"
-
-

-

Parameters

- - - -
 Parameter  Requirement  Description  
F1, F2, .., FnA model of nullary Metafunction
-

-

Expression semantics

-

- - - -
 Expression  Precondition  Semantics  Postcondition 
typedef logical_and<f1,f2,..,fn>::type c;Returns false_c if either of f1::type::value, f2::type::value, .., fn::type::value expressions evaluates to false, and true_c otherwise; guarantees left-to-right evaluation; moreover, the operands subsequent to the first fi metafunction that evaluates to false are not evaluated.
-

-

Example

-

-

-// will generate compile-time error if invoked with T == any fundamental type
-template< typename T > struct fail
-{
-   typedef typename T::nonexistent type;
-};
-

-BOOST_STATIC_ASSERT((logical_and< true_c,false_c >::type::value == false));
-BOOST_STATIC_ASSERT((logical_and< false_c,fail<int> >::type::value == false)); // ok, fail<int> is never invoked
-BOOST_STATIC_ASSERT((logical_and< true_c,false_c,fail<int> >::type::value == false)); // ok too
-
-

-

See also

-

-Metafunctions, logical_or, logical_not -

-Table of Content | Reference
Last edited July 17, 2002 1:06 am \ No newline at end of file diff --git a/doc/ref/Reference/logical_not.html b/doc/ref/Reference/logical_not.html deleted file mode 100644 index bc47337..0000000 --- a/doc/ref/Reference/logical_not.html +++ /dev/null @@ -1,51 +0,0 @@ - -boost::mpl::Reference/logical not - - -

[Home]logical_not

Synopsis

-

-

-template< 
-      typename F
-    >
-struct logical_not
-{
-    typedef unspecified type;
-};
-
-

-

Description

-

-Returns the result of logical not (!) operation on its argument. -

-

Definition

-

-

-#include "boost/mpl/logical/not.hpp"
-
-

-

Parameters

- - - -
 Parameter  Requirement  Description  
FA model of nullary Metafunction
-

-

Expression semantics

-

- - - -
 Expression  Expression type  Precondition  Semantics  Postcondition 
typedef logical_not<f>::type c;A model of bool Integral ConstantEquivalent to typedef bool_c<(!f::type::value)> c;
-

-

Example

-

-

-BOOST_STATIC_ASSERT(logical_not<true_c>::type::value == false);
-BOOST_STATIC_ASSERT(logical_not<false_c>::type::value == true);
-
-

-

See also

-

-Metafunctions, logical_and, logical_or -

-Table of Content | Reference
Last edited July 17, 2002 4:13 am \ No newline at end of file diff --git a/doc/ref/Reference/logical_or.html b/doc/ref/Reference/logical_or.html deleted file mode 100644 index 801007d..0000000 --- a/doc/ref/Reference/logical_or.html +++ /dev/null @@ -1,62 +0,0 @@ - -boost::mpl::Reference/logical or - - -

[Home]logical_or

Synopsis

-

-

-template< 
-      typename F1
-    , typename F2
-    , typename F3 = false_c
-    ...
-    , typename Fn = false_c
-    >
-struct logical_or
-{
-    typedef unspecified type;
-};
-
-

-

Description

-

-Returns the result of short-circuit logical or (||) operation on its arguments. -

-

Definition

-

-

-#include "boost/mpl/logical/or.hpp"
-
-

-

Parameters

- - - -
 Parameter  Requirement  Description  
F1, F2, .., FnA model of nullary Metafunction
-

-

Expression semantics

-

- - - -
 Expression  Expression type  Precondition  Semantics  Postcondition 
typedef logical_or<f1,f2,..,fn>::type c;A model of bool Integral ConstantReturns true_c if either of f1::type::value, f2::type::value, .., fn::type::value expressions evaluates to true, and false_c otherwise; guarantees left-to-right evaluation; moreover, the operands subsequent to the first fi metafunction that evaluates to true are not evaluated.
-

-

Example

-

-

-// will generate compile-time error if invoked with T == any fundamental type
-template< typename T > struct fail
-{
-   typedef typename T::nonexistent type;
-};
-

-BOOST_STATIC_ASSERT((logical_or< false_c,true_c >::type::value == true));
-BOOST_STATIC_ASSERT((logical_or< true_c,fail<int> >::type::value == true)); // ok, fail<int> is never invoked
-BOOST_STATIC_ASSERT((logical_or< false_c,true_c,fail<int> >::type::value == true)); // ok too
-
-

-

See also

-

-Metafunctions, logical_and, logical_not -

-Table of Content | Reference
Last edited July 17, 2002 4:12 am \ No newline at end of file diff --git a/doc/ref/Reference/next.html b/doc/ref/Reference/next.html deleted file mode 100644 index cc00727..0000000 --- a/doc/ref/Reference/next.html +++ /dev/null @@ -1,61 +0,0 @@ - -boost::mpl::Reference/next - - -

[Home]next

Synopsis -

-

-

-template<
-      typename T
-    >
-struct next
-{
-    typedef implementation-defined type;
-};
-
-

-

Description -

-

-[to do] -

-

Definition -

-

-

-#include "boost/mpl/next.hpp"
-
-

-

Parameters -

- - - -
 Parameter  Requirement  Description  Default argument  
ParamA model of Concept[to do][to do]
-

-

Members -

- - - -
 Member  Description  
type[to do]
-

-

Complexity -

-

-[to do] -

-

Example -

-

-

-[to do]
-
-

-

See also -

-

-Algorithms, prior -

-Table of Content | Reference
Last edited February 19, 2002 4:25 am \ No newline at end of file diff --git a/doc/ref/Reference/prior.html b/doc/ref/Reference/prior.html deleted file mode 100644 index 4a5d037..0000000 --- a/doc/ref/Reference/prior.html +++ /dev/null @@ -1,61 +0,0 @@ - -boost::mpl::Reference/prior - - -

[Home]prior

Synopsis -

-

-

-template<
-      typename T
-    >
-struct prior
-{
-    typedef implementation-defined type;
-};
-
-

-

Description -

-

-[to do] -

-

Definition -

-

-

-#include "boost/mpl/prior.hpp"
-
-

-

Parameters -

- - - -
 Parameter  Requirement  Description  Default argument  
ParamA model of Concept[to do][to do]
-

-

Members -

- - - -
 Member  Description  
type[to do]
-

-

Complexity -

-

-[to do] -

-

Example -

-

-

-[to do]
-
-

-

See also -

-

-Algorithms, next -

-Table of Content | Reference
Last edited February 19, 2002 4:25 am \ No newline at end of file diff --git a/doc/ref/Reference/sort.html b/doc/ref/Reference/sort.html deleted file mode 100644 index 1905d48..0000000 --- a/doc/ref/Reference/sort.html +++ /dev/null @@ -1,62 +0,0 @@ - -boost::mpl::Reference/sort - - -

[Home]sort

Synopsis -

-

-

-template<
-      typename Sequence
-    , typename Compare = less<_1,_2>
-    >
-struct sort
-{
-    typedef implementation-defined type;
-};
-
-

-

Description -

-

-[to do] -

-

Definition -

-

-

-#include "boost/mpl/sort.hpp"
-
-

-

Parameters -

- - - -
 Parameter  Requirement  Description  Default argument  
ParamA model of Concept[to do][to do]
-

-

Members -

- - - -
 Member  Description  
type[to do]
-

-

Complexity -

-

-[to do] -

-

Example -

-

-

-[to do]
-
-

-

See also -

-

-Algorithms, lower_bound, upper_bound -

-Table of Content | Reference
Last edited February 19, 2002 4:22 am \ No newline at end of file diff --git a/doc/ref/Reference/unique.html b/doc/ref/Reference/unique.html deleted file mode 100644 index 4302889..0000000 --- a/doc/ref/Reference/unique.html +++ /dev/null @@ -1,62 +0,0 @@ - -boost::mpl::Reference/unique - - -

[Home]unique

Synopsis -

-

-

-template<
-      typename Sequence
-    , typename Predicate = is_same<_1,_2>
-    >
-struct unique
-{
-    typedef implementation-defined type;
-};
-
-

-

Description -

-

-[to do] -

-

Definition -

-

-

-#include "boost/mpl/unique.hpp"
-
-

-

Parameters -

- - - -
 Parameter  Requirement  Description  Default argument  
ParamA model of Concept[to do][to do]
-

-

Members -

- - - -
 Member  Description  
type[to do]
-

-

Complexity -

-

-[to do] -

-

Example -

-

-

-[to do]
-
-

-

See also -

-

-Algorithms, erase, erase_if -

-Table of Content | Reference
Last edited February 19, 2002 4:15 am \ No newline at end of file diff --git a/doc/ref/Table_of_Content.html b/doc/ref/Table_of_Content.html deleted file mode 100644 index 107548c..0000000 --- a/doc/ref/Table_of_Content.html +++ /dev/null @@ -1,14 +0,0 @@ - -boost::mpl::Table of Content - - -

[Home]Table of Content

    -
  1. Sequences -
  2. Iterators -
  3. Algorithms -
  4. Metafunctions -
  5. Categorized index -
  6. Acknowledgements -
-

-Table of Content
Last edited July 17, 2002 10:15 am \ No newline at end of file