From b2bd498a4fe4582210405f555d3347404ebe63bd Mon Sep 17 00:00:00 2001 From: Paul Mensonides Date: Sun, 6 Oct 2002 02:37:37 +0000 Subject: [PATCH] extended array support [SVN r15747] --- doc/headers.html | 8 ++++ doc/headers/array.hpp.html | 8 ++++ doc/headers/array/insert.hpp.html | 20 +++++++++ doc/headers/array/pop_back.hpp.html | 20 +++++++++ doc/headers/array/pop_front.hpp.html | 20 +++++++++ doc/headers/array/push_back.hpp.html | 19 +++++++++ doc/headers/array/push_front.hpp.html | 19 +++++++++ doc/headers/array/remove.hpp.html | 20 +++++++++ doc/headers/array/replace.hpp.html | 20 +++++++++ doc/headers/array/reverse.hpp.html | 19 +++++++++ doc/ref.html | 13 ++++++ doc/ref/array_insert.html | 60 +++++++++++++++++++++++++++ doc/ref/array_insert_d.html | 52 +++++++++++++++++++++++ doc/ref/array_pop_back.html | 48 +++++++++++++++++++++ doc/ref/array_pop_back_z.html | 40 ++++++++++++++++++ doc/ref/array_pop_front.html | 48 +++++++++++++++++++++ doc/ref/array_pop_front_z.html | 40 ++++++++++++++++++ doc/ref/array_push_back.html | 38 +++++++++++++++++ doc/ref/array_push_front.html | 38 +++++++++++++++++ doc/ref/array_remove.html | 49 ++++++++++++++++++++++ doc/ref/array_remove_d.html | 40 ++++++++++++++++++ doc/ref/array_replace.html | 53 +++++++++++++++++++++++ doc/ref/array_replace_d.html | 44 ++++++++++++++++++++ doc/ref/array_reverse.html | 34 +++++++++++++++ 24 files changed, 770 insertions(+) create mode 100644 doc/headers/array/insert.hpp.html create mode 100644 doc/headers/array/pop_back.hpp.html create mode 100644 doc/headers/array/pop_front.hpp.html create mode 100644 doc/headers/array/push_back.hpp.html create mode 100644 doc/headers/array/push_front.hpp.html create mode 100644 doc/headers/array/remove.hpp.html create mode 100644 doc/headers/array/replace.hpp.html create mode 100644 doc/headers/array/reverse.hpp.html create mode 100644 doc/ref/array_insert.html create mode 100644 doc/ref/array_insert_d.html create mode 100644 doc/ref/array_pop_back.html create mode 100644 doc/ref/array_pop_back_z.html create mode 100644 doc/ref/array_pop_front.html create mode 100644 doc/ref/array_pop_front_z.html create mode 100644 doc/ref/array_push_back.html create mode 100644 doc/ref/array_push_front.html create mode 100644 doc/ref/array_remove.html create mode 100644 doc/ref/array_remove_d.html create mode 100644 doc/ref/array_replace.html create mode 100644 doc/ref/array_replace_d.html create mode 100644 doc/ref/array_reverse.html diff --git a/doc/headers.html b/doc/headers.html index 2d00a7e..5ab7183 100644 --- a/doc/headers.html +++ b/doc/headers.html @@ -25,6 +25,14 @@
  • array/
  • data.hpp
  • elem.hpp
    • +
  • insert.hpp
    • +
  • pop_back.hpp
    • +
  • pop_front.hpp
    • +
  • push_back.hpp
    • +
  • push_front.hpp
    • +
  • remove.hpp
    • +
  • replace.hpp
    • +
  • reverse.hpp
  • size.hpp
  • assert_msg.hpp*
  • cat.hpp
    • diff --git a/doc/headers/array.hpp.html b/doc/headers/array.hpp.html index 11f5c6b..174cd09 100644 --- a/doc/headers/array.hpp.html +++ b/doc/headers/array.hpp.html @@ -15,6 +15,14 @@ diff --git a/doc/headers/array/insert.hpp.html b/doc/headers/array/insert.hpp.html new file mode 100644 index 0000000..bfe9324 --- /dev/null +++ b/doc/headers/array/insert.hpp.html @@ -0,0 +1,20 @@ + + + array/insert.hpp + + + +
    + The array/insert.hpp header defines macros to insert an element into an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/insert.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/pop_back.hpp.html b/doc/headers/array/pop_back.hpp.html new file mode 100644 index 0000000..2b660a5 --- /dev/null +++ b/doc/headers/array/pop_back.hpp.html @@ -0,0 +1,20 @@ + + + array/pop_back.hpp + + + +
    + The array/pop_back.hpp header defines macros to pop an element from the end of an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/pop_back.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/pop_front.hpp.html b/doc/headers/array/pop_front.hpp.html new file mode 100644 index 0000000..7afb850 --- /dev/null +++ b/doc/headers/array/pop_front.hpp.html @@ -0,0 +1,20 @@ + + + array/pop_front.hpp + + + +
    + The array/pop_front.hpp header defines macros to pop an element from the beginning of an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/pop_front.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/push_back.hpp.html b/doc/headers/array/push_back.hpp.html new file mode 100644 index 0000000..91ada11 --- /dev/null +++ b/doc/headers/array/push_back.hpp.html @@ -0,0 +1,19 @@ + + + array/push_back.hpp + + + +
    + The array/push_back.hpp header defines a macro to append an element to the end of an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/push_back.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/push_front.hpp.html b/doc/headers/array/push_front.hpp.html new file mode 100644 index 0000000..a0f6601 --- /dev/null +++ b/doc/headers/array/push_front.hpp.html @@ -0,0 +1,19 @@ + + + array/push_front.hpp + + + +
    + The array/push_front.hpp header defines a macro to append an element to the beginning of an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/push_front.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/remove.hpp.html b/doc/headers/array/remove.hpp.html new file mode 100644 index 0000000..aa84008 --- /dev/null +++ b/doc/headers/array/remove.hpp.html @@ -0,0 +1,20 @@ + + + array/remove.hpp + + + +
    + The array/remove.hpp header defines macros to remove an element from an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/remove.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/replace.hpp.html b/doc/headers/array/replace.hpp.html new file mode 100644 index 0000000..ab336ab --- /dev/null +++ b/doc/headers/array/replace.hpp.html @@ -0,0 +1,20 @@ + + + array/replace.hpp + + + +
    + The array/replace.hpp header defines macros to replace an element in an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/replace.hpp> +
    +

    Contents

    + + + diff --git a/doc/headers/array/reverse.hpp.html b/doc/headers/array/reverse.hpp.html new file mode 100644 index 0000000..dedfc93 --- /dev/null +++ b/doc/headers/array/reverse.hpp.html @@ -0,0 +1,19 @@ + + + array/reverse.hpp + + + +
    + The array/reverse.hpp header defines macros to reverse the elements in an array. +
    +

    Usage

    +
    + #include <boost/preprocessor/array/reverse.hpp> +
    +

    Contents

    + + + diff --git a/doc/ref.html b/doc/ref.html index a66a943..b7c73ae 100644 --- a/doc/ref.html +++ b/doc/ref.html @@ -14,6 +14,19 @@
  • APPLY
  • ARRAY_DATA
  • ARRAY_ELEM
    • +
  • ARRAY_INSERT
    • +
  • ARRAY_INSERT_D
    • +
  • ARRAY_POP_BACK
    • +
  • ARRAY_POP_BACK_Z
    • +
  • ARRAY_POP_FRONT
    • +
  • ARRAY_POP_FRONT_Z
    • +
  • ARRAY_PUSH_BACK
    • +
  • ARRAY_PUSH_FRONT
    • +
  • ARRAY_REMOVE
    • +
  • ARRAY_REMOVE_D
    • +
  • ARRAY_REPLACE
    • +
  • ARRAY_REPLACE_D
    • +
  • ARRAY_REVERSE
  • ARRAY_SIZE
  • ASSERT
  • ASSERT_MSG
    • diff --git a/doc/ref/array_insert.html b/doc/ref/array_insert.html new file mode 100644 index 0000000..bc7aa4f --- /dev/null +++ b/doc/ref/array_insert.html @@ -0,0 +1,60 @@ + + + BOOST_PP_ARRAY_INSERT + + + +
    + The BOOST_PP_ARRAY_INSERT macro inserts an element into an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_INSERT(array, i, elem) +
    +

    Arguments

    +
    +
    array
    +
    + The array into which an element is to be inserted. +
    +
    i
    +
    + The zero-based position in array where an element is to be inserted.  + Valid values range from 0 to BOOST_PP_ARRAY_SIZE(array). +
    +
    elem
    +
    + The element to insert. +
    +
    +

    Remarks

    +
    + This macro inserts elem before the element at index i. +
    +
    + If the operation attempts to create an array that is larger than BOOST_PP_LIMIT_TUPLE, + the result is undefined. +
    +
    + This macro uses BOOST_PP_WHILE interally.  + Therefore, to use the d parameter passed from other macros that use BOOST_PP_WHILE, + see BOOST_PP_ARRAY_INSERT_D. +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/insert.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/insert.hpp>
+
+#define ARRAY (3, (a, b, d))
+
+BOOST_PP_ARRAY_INSERT(ARRAY, 2, c) // expands to (4, (a, b, c, d))
+
    + + diff --git a/doc/ref/array_insert_d.html b/doc/ref/array_insert_d.html new file mode 100644 index 0000000..ff96bf8 --- /dev/null +++ b/doc/ref/array_insert_d.html @@ -0,0 +1,52 @@ + + + BOOST_PP_ARRAY_INSERT_D + + + +
    + The BOOST_PP_ARRAY_INSERT_D macro inserts an element into an array.  + It reenters BOOST_PP_WHILE with maximum efficiency. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_INSERT_D(d, array, i, elem) +
    +

    Arguments

    +
    +
    d
    +
    + The next available BOOST_PP_WHILE iteration. +
    +
    array
    +
    + The array into which an element is to be inserted. +
    +
    i
    +
    + The zero-based position in array where an element is to be inserted.  + Valid values range from 0 to BOOST_PP_ARRAY_SIZE(array). +
    +
    elem
    +
    + The element to insert. +
    +
    +

    Remarks

    +
    + This macro inserts elem before the element at index i. +
    +
    + If the operation attempts to create an array that is larger than BOOST_PP_LIMIT_TUPLE, + the result is undefined. +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/insert.hpp> +
    + + diff --git a/doc/ref/array_pop_back.html b/doc/ref/array_pop_back.html new file mode 100644 index 0000000..784c5be --- /dev/null +++ b/doc/ref/array_pop_back.html @@ -0,0 +1,48 @@ + + + BOOST_PP_ARRAY_POP_BACK + + + +
    + The BOOST_PP_ARRAY_POP_BACK macro pops an element from the end of an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_POP_BACK(array) +
    +

    Arguments

    +
    +
    array
    +
    + The array to pop an element from. +
    +
    +

    Remarks

    +
    + This macro returns array after removing the last element.  + If array has no elements, the result of applying this macro is undefined. +
    +
    + This macro uses BOOST_PP_REPEAT internally.  + Therefore, to use the z parameter passed from other macros that use + BOOST_PP_REPEAT, see BOOST_PP_ARRAY_POP_BACK_Z +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/pop_back.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/pop_back.hpp>
+
+#define ARRAY (3, (a, b, c))
+
+BOOST_PP_ARRAY_POP_BACK(ARRAY) // expands to (2, (a, b))
+
    + + diff --git a/doc/ref/array_pop_back_z.html b/doc/ref/array_pop_back_z.html new file mode 100644 index 0000000..bacd8e9 --- /dev/null +++ b/doc/ref/array_pop_back_z.html @@ -0,0 +1,40 @@ + + + BOOST_PP_ARRAY_POP_BACK_Z + + + +
    + The BOOST_PP_ARRAY_POP_BACK_Z macro pops an element from the end of an array.  + It reenters BOOST_PP_REPEAT with maximum efficiency. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_POP_BACK_Z(z, array) +
    +

    Arguments

    +
    +
    z
    +
    + The next available BOOST_PP_REPEAT dimension. +
    +
    array
    +
    + The array to pop an element from. +
    +
    +

    Remarks

    +
    + This macro returns array after removing the last element.  + If array has no elements, the result of applying this macro is undefined. +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/pop_back.hpp> +
    + + diff --git a/doc/ref/array_pop_front.html b/doc/ref/array_pop_front.html new file mode 100644 index 0000000..52ff00a --- /dev/null +++ b/doc/ref/array_pop_front.html @@ -0,0 +1,48 @@ + + + BOOST_PP_ARRAY_POP_FRONT + + + +
    + The BOOST_PP_ARRAY_POP_FRONT macro pops an element from the end of an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_POP_FRONT(array) +
    +

    Arguments

    +
    +
    array
    +
    + The array to pop an element from. +
    +
    +

    Remarks

    +
    + This macro returns array after removing the first element.  + If array has no elements, the result of applying this macro is undefined. +
    +
    + This macro uses BOOST_PP_REPEAT internally.  + Therefore, to use the z parameter passed from other macros that use + BOOST_PP_REPEAT, see BOOST_PP_ARRAY_POP_FRONT_Z +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/pop_front.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/pop_front.hpp>
+
+#define ARRAY (3, (a, b, c))
+
+BOOST_PP_ARRAY_POP_FRONT(ARRAY) // expands to (2, (b, c))
+
    + + diff --git a/doc/ref/array_pop_front_z.html b/doc/ref/array_pop_front_z.html new file mode 100644 index 0000000..cb2df08 --- /dev/null +++ b/doc/ref/array_pop_front_z.html @@ -0,0 +1,40 @@ + + + BOOST_PP_ARRAY_POP_FRONT_Z + + + +
    + The BOOST_PP_ARRAY_POP_FRONT_Z macro pops an element from the beginning of an array.  + It reenters BOOST_PP_REPEAT with maximum efficiency. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_POP_FRONT_Z(z, array) +
    +

    Arguments

    +
    +
    z
    +
    + The next available BOOST_PP_REPEAT dimension. +
    +
    array
    +
    + The array to pop an element from. +
    +
    +

    Remarks

    +
    + This macro returns array after removing the first element.  + If array has no elements, the result of applying this macro is undefined. +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/pop_front.hpp> +
    + + diff --git a/doc/ref/array_push_back.html b/doc/ref/array_push_back.html new file mode 100644 index 0000000..512a177 --- /dev/null +++ b/doc/ref/array_push_back.html @@ -0,0 +1,38 @@ + + + BOOST_PP_ARRAY_PUSH_BACK + + + +
    + The BOOST_PP_ARRAY_PUSH_BACK macro appends an element to the end of an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_PUSH_BACK(array, elem) +
    +

    Arguments

    +
    +
    array
    +
    + The array to append an element to. +
    +
    elem
    +
    + The element to append. +
    +
    +

    Requirements

    +
    + Header:  <boost/preprocessor/array/push_back.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/push_back.hpp>
+
+#define ARRAY (3, (a, b, c))
+
+BOOST_PP_ARRAY_PUSH_BACK(ARRAY, d) // expands to (4, (a, b, c, d))
+
    + + diff --git a/doc/ref/array_push_front.html b/doc/ref/array_push_front.html new file mode 100644 index 0000000..fef09cf --- /dev/null +++ b/doc/ref/array_push_front.html @@ -0,0 +1,38 @@ + + + BOOST_PP_ARRAY_PUSH_FRONT + + + +
    + The BOOST_PP_ARRAY_PUSH_FRONT macro appends an element to the beginning of an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_PUSH_FRONT(array, elem) +
    +

    Arguments

    +
    +
    array
    +
    + The array to append an element to. +
    +
    elem
    +
    + The element to append. +
    +
    +

    Requirements

    +
    + Header:  <boost/preprocessor/array/push_front.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/push_front.hpp>
+
+#define ARRAY (3, (b, c, d))
+
+BOOST_PP_ARRAY_PUSH_FRONT(ARRAY, a) // expands to (4, (a, b, c, d))
+
    + + diff --git a/doc/ref/array_remove.html b/doc/ref/array_remove.html new file mode 100644 index 0000000..5da9db8 --- /dev/null +++ b/doc/ref/array_remove.html @@ -0,0 +1,49 @@ + + + BOOST_PP_ARRAY_REMOVE + + + +
    + The BOOST_PP_ARRAY_REMOVE macro removes an element from an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_REMOVE(array, i) +
    +

    Arguments

    +
    +
    array
    +
    + The array from which an element is to be removed. +
    +
    i
    +
    + The zero-based position in array of the element to be removed.  + Valid values range from 0 to BOOST_PP_ARRAY_SIZE(array) - 1. +
    +
    +

    Remarks

    +
    + This macro uses BOOST_PP_WHILE interally.  + Therefore, to use the d parameter passed from other macros that use BOOST_PP_WHILE, + see BOOST_PP_ARRAY_REMOVE_D. +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/remove.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/remove.hpp>
+
+#define ARRAY (3, (a, b, d))
+
+BOOST_PP_ARRAY_REMOVE(ARRAY, 2) // expands to (2, (a, b))
+
    + + diff --git a/doc/ref/array_remove_d.html b/doc/ref/array_remove_d.html new file mode 100644 index 0000000..07339ff --- /dev/null +++ b/doc/ref/array_remove_d.html @@ -0,0 +1,40 @@ + + + BOOST_PP_ARRAY_REMOVE_D + + + +
    + The BOOST_PP_ARRAY_REMOVE_D macro removes an element from an array.  + It reenters BOOST_PP_WHILE with maximum efficiency. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_REMOVE_D(d, array, i) +
    +

    Arguments

    +
    +
    d
    +
    + The next available BOOST_PP_WHILE iteration. +
    +
    array
    +
    + The array from which an element is to be removed. +
    +
    i
    +
    + The zero-based position in array of the element to be removed.  + Valid values range from 0 to BOOST_PP_ARRAY_SIZE(array) - 1. +
    +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/remove.hpp> +
    + + diff --git a/doc/ref/array_replace.html b/doc/ref/array_replace.html new file mode 100644 index 0000000..aa7bcda --- /dev/null +++ b/doc/ref/array_replace.html @@ -0,0 +1,53 @@ + + + BOOST_PP_ARRAY_REPLACE + + + +
    + The BOOST_PP_ARRAY_REPLACE macro replaces an element in an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_REPLACE(array, i, elem) +
    +

    Arguments

    +
    +
    array
    +
    + An array to replace an element in. +
    +
    i
    +
    + The zero-based position in array of the element to be replaced.  + Valid values range from 0 to BOOST_PP_ARRAY_SIZE(array) - 1. +
    +
    elem
    +
    + The replacement element. +
    +
    +

    Remarks

    +
    + This macro uses BOOST_PP_WHILE interally.  + Therefore, to use the d parameter passed from other macros that use BOOST_PP_WHILE, + see BOOST_PP_ARRAY_REPLACE_D. +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/replace.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/replace.hpp>
+
+#define ARRAY (3, (a, x, c))
+
+BOOST_PP_ARRAY_REPLACE(ARRAY, 1, b) // expands to (3, (a, b, c))
+
    + + diff --git a/doc/ref/array_replace_d.html b/doc/ref/array_replace_d.html new file mode 100644 index 0000000..ce44b6d --- /dev/null +++ b/doc/ref/array_replace_d.html @@ -0,0 +1,44 @@ + + + BOOST_PP_ARRAY_REPLACE_D + + + +
    + The BOOST_PP_ARRAY_REPLACE_D macro replaces an element in an array.  + It reenters BOOST_PP_WHILE with maximum efficiency. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_REPLACE_D(d, array, i, elem) +
    +

    Arguments

    +
    +
    d
    +
    + The next available BOOST_PP_WHILE iteration. +
    +
    array
    +
    + An array to replace an element in. +
    +
    i
    +
    + The zero-based position in array of the element to be replaced.  + Valid values range from 0 to BOOST_PP_ARRAY_SIZE(array) - 1. +
    +
    elem
    +
    + The replacement element. +
    +
    +

    See Also

    + +

    Requirements

    +
    + Header:  <boost/preprocessor/array/replace.hpp> +
    + + diff --git a/doc/ref/array_reverse.html b/doc/ref/array_reverse.html new file mode 100644 index 0000000..44ab27a --- /dev/null +++ b/doc/ref/array_reverse.html @@ -0,0 +1,34 @@ + + + BOOST_PP_ARRAY_REVERSE + + + +
    + The BOOST_PP_ARRAY_REVERSE macro reverses the elements in an array. +
    +

    Usage

    +
    + BOOST_PP_ARRAY_REVERSE(array) +
    +

    Arguments

    +
    +
    array
    +
    + The array whose elements are to be reversed. +
    +
    +

    Requirements

    +
    + Header:  <boost/preprocessor/array/reverse.hpp> +
    +

    Sample Code

    +
    +#include <boost/preprocessor/array/reverse.hpp>
+
+#define ARRAY (3, (a, b, c))
+
+BOOST_PP_ARRAY_REVERSE(ARRAY) // expands to (3, (c, b, a))
+
    + +