Boost.Array

From 36bba5af2d8fa43ea777b080129e0719e8eca655 Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Mon, 11 Mar 2024 08:27:02 -0500 Subject: [PATCH 001/108] Make the library modular usable. --- build.jam | 24 ++++++++++++++++++++++++ test/Jamfile.v2 | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 build.jam diff --git a/build.jam b/build.jam new file mode 100644 index 00000000..853d7c7b --- /dev/null +++ b/build.jam @@ -0,0 +1,24 @@ +# Copyright René Ferdinand Rivera Morell 2023 +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http://www.boost.org/LICENSE_1_0.txt) + +import project ; + +project /boost/array + : common-requirements + /boost/assert//boost_assert + /boost/config//boost_config + /boost/core//boost_core + /boost/static_assert//boost_static_assert + /boost/throw_exception//boost_throw_exception + include + ; + +explicit + [ alias boost_array ] + [ alias all : boost_array test ] + ; + +call-if : boost-library array + ; diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index bab406ab..32cd9ae5 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -15,6 +15,6 @@ run array7.cpp ; # run array_constexpr.cpp ; compile-fail array_getfail1.cpp ; compile-fail array_getfail2.cpp ; -run array_hash.cpp ; +run array_hash.cpp /boost/container_hash//boost_container_hash ; run quick.cpp ; From d535c37a57024e87d74c446688f9e7153a03d148 Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Fri, 29 Mar 2024 21:12:36 -0500 Subject: [PATCH 002/108] Switch to library requirements instead of source. As source puts extra source in install targets. --- build.jam | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/build.jam b/build.jam index 853d7c7b..1d0d357a 100644 --- a/build.jam +++ b/build.jam @@ -7,11 +7,11 @@ import project ; project /boost/array : common-requirements - /boost/assert//boost_assert - /boost/config//boost_config - /boost/core//boost_core - /boost/static_assert//boost_static_assert - /boost/throw_exception//boost_throw_exception + /boost/assert//boost_assert + /boost/config//boost_config + /boost/core//boost_core + /boost/static_assert//boost_static_assert + /boost/throw_exception//boost_throw_exception include ; From fe1e99eb31185d158f591c9f413e801bb3dcd564 Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Sun, 5 May 2024 09:00:00 -0500 Subject: [PATCH 003/108] Add requires-b2 check to top-level build file. --- build.jam | 2 ++ 1 file changed, 2 insertions(+) diff --git a/build.jam b/build.jam index 1d0d357a..d0ef6a74 100644 --- a/build.jam +++ b/build.jam @@ -3,6 +3,8 @@ # (See accompanying file LICENSE_1_0.txt or copy at # http://www.boost.org/LICENSE_1_0.txt) +require-b2 5.1 ; + import project ; project /boost/array From 28d8d30b57b4f5af75ab9fe675a83e961f3fd570 Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Fri, 14 Jun 2024 11:33:55 -0500 Subject: [PATCH 004/108] Bump B2 require to 5.2 --- build.jam | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/build.jam b/build.jam index d0ef6a74..0ec3655d 100644 --- a/build.jam +++ b/build.jam @@ -3,9 +3,7 @@ # (See accompanying file LICENSE_1_0.txt or copy at # http://www.boost.org/LICENSE_1_0.txt) -require-b2 5.1 ; - -import project ; +require-b2 5.2 ; project /boost/array : common-requirements From fc104539948dad9495db128d5d540737a7a198ea Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Sat, 20 Jul 2024 22:52:04 -0500 Subject: [PATCH 005/108] Update copyright dates. --- build.jam | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.jam b/build.jam index 0ec3655d..abd53410 100644 --- a/build.jam +++ b/build.jam @@ -1,4 +1,4 @@ -# Copyright René Ferdinand Rivera Morell 2023 +# Copyright René Ferdinand Rivera Morell 2023-2024 # Distributed under the Boost Software License, Version 1.0. # (See accompanying file LICENSE_1_0.txt or copy at # http://www.boost.org/LICENSE_1_0.txt) From 40e2a2d4d804b6886332bc8c1487c99a9aa7ee97 Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Tue, 23 Jul 2024 22:34:23 -0500 Subject: [PATCH 006/108] Move inter-lib dependencies to a project variable and into the build targets. --- build.jam | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/build.jam b/build.jam index abd53410..b927d267 100644 --- a/build.jam +++ b/build.jam @@ -5,20 +5,23 @@ require-b2 5.2 ; +constant boost_dependencies : + /boost/assert//boost_assert + /boost/config//boost_config + /boost/core//boost_core + /boost/static_assert//boost_static_assert + /boost/throw_exception//boost_throw_exception ; + project /boost/array : common-requirements - /boost/assert//boost_assert - /boost/config//boost_config - /boost/core//boost_core - /boost/static_assert//boost_static_assert - /boost/throw_exception//boost_throw_exception include ; explicit - [ alias boost_array ] + [ alias boost_array : : : : $(boost_dependencies) ] [ alias all : boost_array test ] ; call-if : boost-library array ; + From 78fb6a71ddd4b694cd9dd24188495f486f5962db Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Sat, 27 Jul 2024 11:03:42 -0500 Subject: [PATCH 007/108] Adjust self dependencies as inter-lib deps no longer apply globally. --- test/Jamfile.v2 | 2 ++ 1 file changed, 2 insertions(+) diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 32cd9ae5..cae4c9ea 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -4,6 +4,8 @@ import testing ; +project : requirements /boost/array//boost_array ; + run array0.cpp ; run array1.cpp ; run array2.cpp ; From 22b8eebc3caf0aced1bf9cc6b087bfe4525d2664 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Mon, 16 Dec 2024 02:53:18 +0200 Subject: [PATCH 008/108] Apply Node20 workaround --- .github/workflows/ci.yml | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d132519a..c5dea8ab 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -172,24 +172,32 @@ jobs: os: macos-15 runs-on: ${{matrix.os}} - container: ${{matrix.container}} + + container: + image: ${{matrix.container}} + volumes: + - /node20217:/node20217:rw,rshared + - ${{ startsWith(matrix.container, 'ubuntu:1') && '/node20217:/__e/node20:ro,rshared' || ' ' }} defaults: run: shell: bash steps: - - name: Enable Node 16 - run: | - echo "ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true" >> $GITHUB_ENV - - - uses: actions/checkout@v3 - - name: Setup container environment if: matrix.container run: | apt-get update - apt-get -y install sudo python3 git g++ + apt-get -y install sudo python3 git g++ curl xz-utils + + - name: Install nodejs20glibc2.17 + if: ${{ startsWith( matrix.container, 'ubuntu:1' ) }} + run: | + curl -LO https://archives.boost.io/misc/node/node-v20.9.0-linux-x64-glibc-217.tar.xz + tar -xf node-v20.9.0-linux-x64-glibc-217.tar.xz --strip-components 1 -C /node20217 + ldd /__e/node20/bin/node + + - uses: actions/checkout@v4 - name: Install packages if: matrix.install From 99c3a4b9664a5e70cef034e3bc57d620675e5ff3 Mon Sep 17 00:00:00 2001 From: Christian Mazakas Date: Wed, 18 Dec 2024 15:31:13 -0800 Subject: [PATCH 009/108] refactor documentation to use asciidoc --- doc/.gitignore | 1 + doc/Jamfile.v2 | 23 +- doc/array.adoc | 28 ++ doc/array.xml | 639 -------------------------------- doc/array/copyright.adoc | 15 + doc/array/design_rationale.adoc | 43 +++ doc/array/information.adoc | 22 ++ doc/array/introduction.adoc | 37 ++ doc/array/reference.adoc | 418 +++++++++++++++++++++ 9 files changed, 574 insertions(+), 652 deletions(-) create mode 100644 doc/.gitignore create mode 100644 doc/array.adoc delete mode 100644 doc/array.xml create mode 100644 doc/array/copyright.adoc create mode 100644 doc/array/design_rationale.adoc create mode 100644 doc/array/information.adoc create mode 100644 doc/array/introduction.adoc create mode 100644 doc/array/reference.adoc diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000..35b5e99a --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +/html diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index b7f51b71..7087c6c7 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -1,19 +1,16 @@ #~ Copyright Marshall Clow 2013 +#~ Copyright Christian Mazakas 2024 #~ Distributed under the Boost Software License, Version 1.0. #~ (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -using boostbook ; +import asciidoctor ; -boostbook standalone - : array.xml - : boost.root=../../../.. ; +html array.html : array.adoc ; -############################################################################### -alias boostdoc - : array.xml - : - : - : ; -explicit boostdoc ; -alias boostrelease ; -explicit boostrelease ; +install html_ : array.html : html ; + +pdf array.pdf : array.adoc ; +explicit array.pdf ; + +install pdf_ : array.pdf : pdf ; +explicit pdf_ ; diff --git a/doc/array.adoc b/doc/array.adoc new file mode 100644 index 00000000..d6292b50 --- /dev/null +++ b/doc/array.adoc @@ -0,0 +1,28 @@ +//// +Copyright 2001-2004 Nicolai M. Josuttis +Copyright 2012 Marshall Clow +Copyright 2024 Christian Mazakas +Distributed under the Boost Software License, Version 1.0. +https://www.boost.org/LICENSE_1_0.txt +//// + +# Array +Nicolai M. Josuttis +:toc: left +:toclevels: 4 +:idprefix: +:docinfo: private-footer +:source-highlighter: rouge +:source-language: c++ +:sectanchors: + +:leveloffset: +1 + + +include::array/introduction.adoc[] +include::array/reference.adoc[] +include::array/design_rationale.adoc[] +include::array/information.adoc[] +include::array/copyright.adoc[] + +:leveloffset: -1 diff --git a/doc/array.xml b/doc/array.xml deleted file mode 100644 index 68ee5a31..00000000 --- a/doc/array.xml +++ /dev/null @@ -1,639 +0,0 @@ - - - - - - Nicolai - Josuttis - - - Marshall - Clow - - - - 2001 - 2002 - 2003 - 2004 - Nicolai M. Josuttis - - - - 2012 - Marshall Clow - - - - Distributed under the Boost Software License, Version 1.0. - (See accompanying file LICENSE_1_0.txt or copy at - http://www.boost.org/LICENSE_1_0.txt) - - - - STL compliant container wrapper for arrays of constant size - - - - Boost.Array - -

- Introduction - - - - - The C++ Standard Template Library STL as part of the C++ - Standard Library provides a framework for processing algorithms on - different kind of containers. However, ordinary arrays don't - provide the interface of STL containers (although, they provide - the iterator interface of STL containers). - - As replacement for ordinary arrays, the STL provides class - std::vector. However, - std::vector<> provides - the semantics of dynamic arrays. Thus, it manages data to be able - to change the number of elements. This results in some overhead in - case only arrays with static size are needed. - - In his book, Generic Programming and the - STL, Matthew H. Austern introduces a useful wrapper - class for ordinary arrays with static size, called - block. It is safer and has no worse performance than - ordinary arrays. In The C++ Programming - Language, 3rd edition, Bjarne Stroustrup introduces a - similar class, called c_array, which I (Nicolai Josuttis) present - slightly modified in my book The C++ Standard Library - - A Tutorial and Reference, called - carray. This is the essence of these approaches - spiced with many feedback from boost. - - After considering different names, we decided to name this - class simply array. - - Note that this class is suggested to be part of the next - Technical Report, which will extend the C++ Standard (see - http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2003/n1548.htm). - - Update: std::array is (as of C++11) part of the C++ standard. - The differences between boost::array and std::array are minimal. - If you are using C++11, you should consider using std::array instead of boost::array. - - - Class array fulfills most - but not all of the requirements of "reversible containers" (see - Section 23.1, [lib.container.requirements] of the C++ - Standard). The reasons array is not an reversible STL container is - because: - - No constructors are provided. - Elements may have an undetermined initial value (see ). - swap() has no constant complexity. - size() is always constant, based on the second template argument of the type. - The container provides no allocator support. - - - - It doesn't fulfill the requirements of a "sequence" (see Section 23.1.1, [lib.sequence.reqmts] of the C++ Standard), except that: - - front() and back() are provided. - operator[] and at() are provided. - - -

- - -

- - - - - STL compliant container wrapper for arrays of constant size - - T - - - T* - - - const T* - - - std::reverse_iterator<iterator> - - - std::reverse_iterator<const_iterator> - - - T& - - - const T& - - - std::size_t - - - std::ptrdiff_t - - - - size_type - N - - - - - - const array<U, N>& - - std::copy(rhs.begin(),rhs.end(), begin()) - - - - - - iterator - - - const_iterator - - - iterator for the first element - will not throw - - - - - iterator - - - const_iterator - - - iterator for position after the last element - will not throw - - - - - const_iterator - - - constant iterator for the first element - will not throw - - - - - const_iterator - - - constant iterator for position after the last element - will not throw - - - - - - - reverse_iterator - - - const_reverse_iterator - - - reverse iterator for the first element of reverse iteration - - - - - reverse_iterator - - - const_reverse_iterator - - - reverse iterator for position after the last element in reverse iteration - - - - - const_reverse_iterator - - - constant reverse iterator for the first element of reverse iteration - will not throw - - - - - const_reverse_iterator - - - constant reverse iterator for position after the last element in reverse iteration - will not throw - - - - - - size_type - N - - - bool - N==0 - will not throw - - - size_type - N - will not throw - - - - - - - reference - - size_type - - - - - const_reference - - size_type - - - - i < N - element with index i - will not throw. - - - - - reference - - size_type - - - - - const_reference - - size_type - - - - element with index i - std::range_error if i >= N - - - - - reference - - - const_reference - - N > 0 - the first element - will not throw - - - - - reference - - - const_reference - - N > 0 - the last element - will not throw - - - - const T* - elems - will not throw - - - - T* - elems - will not throw - - - - - - void - - array<T, N>& - - std::swap_ranges(begin(), end(), other.begin()) - linear in N - - - void - - const T& - - std::fill_n(begin(), N, value) - - - - - T - - - - - - - void - - - array<T, N>& - - - array<T, N>& - - - x.swap(y) - will not throw. - - - - - - - - bool - - - const array<T, N>& - - - const array<T, N>& - - - std::equal(x.begin(), x.end(), y.begin()) - - - - - - - bool - - - const array<T, N>& - - - const array<T, N>& - - - !(x == y) - - - - - - - bool - - - const array<T, N>& - - - const array<T, N>& - - - std::lexicographical_compare(x.begin(), x.end(), y.begin(), y.end()) - - - - - - - bool - - - const array<T, N>& - - - const array<T, N>& - - - y < x - - - - - - bool - - - const array<T, N>& - - - const array<T, N>& - - - !(y < x) - - - - - - bool - - - const array<T, N>& - - - const array<T, N>& - - - !(x < y) - - - - - - - - T - - - array<T, N>& - - element of array with index Idx - Will static_assert if Idx >= N - - - - - - T - - - const array<T, N>& - - const element of array with index Idx - Will static_assert if Idx >= N - - - - - -

- - -

- Design Rationale - - There was an important design tradeoff regarding the - constructors: We could implement array as an "aggregate" (see - Section 8.5.1, [dcl.init.aggr], of the C++ Standard). This would - mean: - - An array can be initialized with a - brace-enclosing, comma-separated list of initializers for the - elements of the container, written in increasing subscript - order: - - boost::array<int,4> a = { { 1, 2, 3 } }; - - Note that if there are fewer elements in the - initializer list, then each remaining element gets - default-initialized (thus, it has a defined value). - - - However, this approach has its drawbacks: passing no initializer list means that the elements - have an indetermined initial value, because the rule says - that aggregates may have: - - No user-declared constructors. - No private or protected non-static data members. - No base classes. - No virtual functions. - - - - Nevertheless, The current implementation uses this approach. - - Note that for standard conforming compilers it is possible to - use fewer braces (according to 8.5.1 (11) of the Standard). That is, - you can initialize an array as follows: - - -boost::array<int,4> a = { 1, 2, 3 }; - - - I'd appreciate any constructive feedback. Please note: I don't have time to read all boost - mails. Thus, to make sure that feedback arrives to me, please send - me a copy of each mail regarding this class. - - The code is provided "as is" without expressed or implied - warranty. - -

- -

- For more information... - To find more details about using ordinary arrays in C++ and - the framework of the STL, see e.g. - - The C++ Standard Library - A Tutorial and Reference -by Nicolai M. Josuttis -Addison Wesley Longman, 1999 -ISBN 0-201-37926-0 - - - Home Page of Nicolai - Josuttis -

- -

- Acknowledgements - - Doug Gregor ported the documentation to the BoostBook format. -

- - - - diff --git a/doc/array/copyright.adoc b/doc/array/copyright.adoc new file mode 100644 index 00000000..f04e3a8f --- /dev/null +++ b/doc/array/copyright.adoc @@ -0,0 +1,15 @@ +//// +Copyright 2024 Christian Mazakas +Distributed under the Boost Software License, Version 1.0. +https://www.boost.org/LICENSE_1_0.txt +//// + +[#copyright] +# Copyright and License +:idprefix: copyright + +Copyright (C) 2001-2004 Nicolai M. Josuttis + +Copyright (C) 2012 Marshall Clow + +Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) diff --git a/doc/array/design_rationale.adoc b/doc/array/design_rationale.adoc new file mode 100644 index 00000000..bedc0a07 --- /dev/null +++ b/doc/array/design_rationale.adoc @@ -0,0 +1,43 @@ +//// +Copyright 2001-2004 Nicolai M. Josuttis +Copyright 2012 Marshall Clow +Copyright 2024 Christian Mazakas +Distributed under the Boost Software License, Version 1.0. +https://www.boost.org/LICENSE_1_0.txt +//// + +[#design] +# Design Rationale +:idprefix: design_ +:cpp: C++ + +There was an important design tradeoff regarding the constructors: We could implement array as an "aggregate" (see Section 8.5.1, [dcl.init.aggr], of the C++ Standard). This would mean: + +* An array can be initialized with a brace-enclosing, comma-separated list of initializers for the elements of the container, written in increasing subscript order: ++ +-- +```cpp +boost::array a = { { 1, 2, 3 } }; +``` + +Note that if there are fewer elements in the initializer list, then each remaining element gets default-initialized (thus, it has a defined value). +-- + +However, this approach has its drawbacks: **passing no initializer list means that the elements have an indetermined initial value**, because the rule says that aggregates may have: + +* No user-declared constructors. +* No private or protected non-static data members. +* No base classes. +* No virtual functions. + +Nevertheless, the current implementation uses this approach. + +Note that for standard conforming compilers it is possible to use fewer braces (according to 8.5.1 (11) of the Standard). That is, you can initialize an array as follows: + +```cpp +boost::array a = { 1, 2, 3 }; +``` + +I'd appreciate any constructive feedback. **Please note: I don't have time to read all boost mails. Thus, to make sure that feedback arrives to me, please send me a copy of each mail regarding this class.** + +The code is provided "as is" without expressed or implied warranty. diff --git a/doc/array/information.adoc b/doc/array/information.adoc new file mode 100644 index 00000000..ca8b1a86 --- /dev/null +++ b/doc/array/information.adoc @@ -0,0 +1,22 @@ +//// +Copyright 2001-2004 Nicolai M. Josuttis +Copyright 2012 Marshall Clow +Copyright 2024 Christian Mazakas +Distributed under the Boost Software License, Version 1.0. +https://www.boost.org/LICENSE_1_0.txt +//// + +[#information] +# For more information... +:idprefix: information_ +:cpp: C++ + +To find more details about using ordinary arrays in C++ and the framework of the STL, see e.g. + +The C++ Standard Library - A Tutorial and Reference + +by Nicolai M. Josuttis + +Addison Wesley Longman, 1999 + +ISBN 0-201-37926-0 + + +http://www.josuttis.com/[Home Page of Nicolai Josuttis] diff --git a/doc/array/introduction.adoc b/doc/array/introduction.adoc new file mode 100644 index 00000000..9330a8f9 --- /dev/null +++ b/doc/array/introduction.adoc @@ -0,0 +1,37 @@ +//// +Copyright 2001-2004 Nicolai M. Josuttis +Copyright 2012 Marshall Clow +Copyright 2024 Christian Mazakas +Distributed under the Boost Software License, Version 1.0. +https://www.boost.org/LICENSE_1_0.txt +//// + +[#introduction] +# Introduction +:idprefix: introduction_ +:cpp: C++ + +The {cpp} Standard Template Library STL as part of the {cpp} Standard Library provides a framework for processing algorithms on different kind of containers. However, ordinary arrays don't provide the interface of STL containers (although, they provide the iterator interface of STL containers). + +As replacement for ordinary arrays, the STL provides class `std::vector`. However, `std::vector<>` provides the semantics of dynamic arrays. Thus, it manages data to be able to change the number of elements. This results in some overhead in case only arrays with static size are needed. + +In his book, _Generic Programming and the STL_, Matthew H. Austern introduces a useful wrapper class for ordinary arrays with static size, called `block`. It is safer and has no worse performance than ordinary arrays. In _The {cpp} Programming Language_, 3rd edition, Bjarne Stroustrup introduces a similar class, called c_array, which I (http://www.josuttis.com/[Nicolai Josuttis]) present slightly modified in my book _The {cpp} Standard Library - A Tutorial and Reference_, called `carray`. This is the essence of these approaches spiced with many feedback from https://www.boost.org/[boost]. + +After considering different names, we decided to name this class simply `array`. + +Note that this class is suggested to be part of the next Technical Report, which will extend the {cpp} Standard (see http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2003/n1548.htm). + +Update: `std::array` is (as of {cpp}11) part of the {cpp} standard. The differences between `boost::array` and `std::array` are minimal. If you are using {cpp}11, you should consider using `std::array` instead of `boost::array`. + +Class `array` fulfills most but not all of the requirements of "reversible containers" (see Section 23.1, [lib.container.requirements] of the {cpp} Standard). The reasons array is not an reversible STL container is because: + +* No constructors are provided. +* Elements may have an undetermined initial value (see the <>). +* `swap()` has no constant complexity. +* `size()` is always constant, based on the second template argument of the type. +* The container provides no allocator support. + +It doesn't fulfill the requirements of a "sequence" (see Section 23.1.1, [lib.sequence.reqmts] of the {cpp} Standard), except that: + +* `front()` and `back()` are provided. +* `operator[]` and `at()` are provided. diff --git a/doc/array/reference.adoc b/doc/array/reference.adoc new file mode 100644 index 00000000..bde92669 --- /dev/null +++ b/doc/array/reference.adoc @@ -0,0 +1,418 @@ +//// +Copyright 2001-2004 Nicolai M. Josuttis +Copyright 2012 Marshall Clow +Copyright 2024 Christian Mazakas +Distributed under the Boost Software License, Version 1.0. +https://www.boost.org/LICENSE_1_0.txt +//// + +[#reference] +# Reference +:idprefix: reference_ +:cpp: C++ + +## Header + +```cpp +namespace boost { + template class array; + template void swap(array&, array&); + template + bool operator==(const array&, const array&); + template + bool operator!=(const array&, const array&); + template + bool operator<(const array&, const array&); + template + bool operator>(const array&, const array&); + template + bool operator<=(const array&, const array&); + template + bool operator>=(const array&, const array&); + template + T boost::get(array&); + template + T boost::get(const array&); +} +``` + +## Class template array + +### Synopsis + +```cpp +// In header: + +template +class array { +public: + // types + typedef T value_type; + typedef T* iterator; + typedef const T* const_iterator; + typedef std::reverse_iterator reverse_iterator; + typedef std::reverse_iterator const_reverse_iterator; + typedef T& reference; + typedef const T& const_reference; + typedef std::size_t size_type; + typedef std::ptrdiff_t difference_type; + + // static constants + static const size_type static_size = N; + + // construct/copy/destruct + template array& operator=(const array&); + + // iterator support + iterator begin(); + const_iterator begin() const; + iterator end(); + const_iterator end() const; + const_iterator cbegin(); + const_iterator cend(); + + // reverse iterator support + reverse_iterator rbegin(); + const_reverse_iterator rbegin() const; + reverse_iterator rend(); + const_reverse_iterator rend() const; + const_reverse_iterator crbegin(); + const_reverse_iterator crend(); + + // capacity + size_type size(); + bool empty(); + size_type max_size(); + + // element access + reference operator[](size_type); + const_reference operator[](size_type) const; + reference at(size_type); + const_reference at(size_type) const; + reference front(); + const_reference front() const; + reference back(); + const_reference back() const; + const T* data() const; + T* c_array(); + + // modifiers + void swap(array&); + void assign(const T&); + + // public data members + T elems[N]; +}; + +// specialized algorithms +template void swap(array&, array&); + +// comparisons +template + bool operator==(const array&, const array&); +template + bool operator!=(const array&, const array&); +template + bool operator<(const array&, const array&); +template + bool operator>(const array&, const array&); +template + bool operator<=(const array&, const array&); +template + bool operator>=(const array&, const array&); + +// specializations +template + T boost::get(array&); +template + T boost::get(const array&); +``` + +### Description + +#### array public construct/copy/destruct + +``` +template array& operator=(const array& other); +``` +[horizontal] +Effects: :: `std::copy(rhs.begin(), rhs.end(), begin())` + +--- + +#### array iterator support + +``` +iterator begin(); +const_iterator begin() const; +``` +[horizontal] +Returns: :: iterator for the first element +Throws: :: will not throw + +--- + +``` +iterator end(); +const_iterator end() const; +``` +[horizontal] +Returns: :: iterator for position after the last element +Throws: :: will not throw + +--- + +``` +const_iterator cbegin(); +``` +[horizontal] +Returns: :: constant iterator for the first element +Throws: :: will not throw + +--- + +``` +const_iterator cend(); +``` +[horizontal] +Returns: :: constant iterator for position after the last element +Throws: :: will not throw + +--- + +#### array reverse iterator support + +``` +reverse_iterator rbegin(); +const_reverse_iterator rbegin() const; +``` +[horizontal] +Returns: :: reverse iterator for the first element of reverse iteration + +--- + +``` +reverse_iterator rend(); +const_reverse_iterator rend() const; +``` +[horizontal] +Returns: :: reverse iterator for position after the last element in reverse iteration + +--- + +``` +const_reverse_iterator crbegin(); +``` +[horizontal] +Returns: :: constant reverse iterator for the first element of reverse iteration +Throws: :: will not throw + +--- + +``` +const_reverse_iterator crend(); +``` +[horizontal] +Returns: :: constant reverse iterator for position after the last element in reverse iteration +Throws: :: will not throw + +--- + +#### array capacity + +``` +size_type size(); +``` +[horizontal] +Returns: :: `N` + +--- + +``` +bool empty(); +``` +[horizontal] +Returns: :: `N==0` +Throws: :: will not throw + +--- + +``` +size_type max_size(); +``` +[horizontal] +Returns: :: `N` +Throws: :: will not throw + +--- + +#### array element access + +``` +reference operator[](size_type i); +const_reference operator[](size_type i) const; +``` +[horizontal] +Requires: :: `i < N` +Returns: :: element with index `i` +Throws: :: will not throw. + +--- + +``` +reference at(size_type i); +const_reference at(size_type i) const; +``` +[horizontal] +Returns: :: element with index `i` +Throws: :: `std::range_error` if `i >= N` + +--- + +``` +reference front(); +const_reference front() const; +``` +[horizontal] +Requires: :: `N > 0` +Returns: :: the first element +Throws: :: will not throw + +--- + +``` +reference back(); +const_reference back() const; +``` +[horizontal] +Requires: :: `N > 0` +Returns: :: the last element +Throws: :: will not throw + +--- + +``` +const T* data() const; +``` +[horizontal] +Returns: :: `elems` +Throws: :: will not throw + +--- + +``` +T* c_array(); +``` +[horizontal] +Returns: :: `elems` +Throws: :: will not throw + +--- + +#### array modifiers + +``` +void swap(array& other); +``` +[horizontal] +Effects: :: `std::swap_ranges(begin(), end(), other.begin())` +Complexity: :: linear in `N` + +--- + +``` +void assign(const T& value); +``` +[horizontal] +Effects: :: `std::fill_n(begin(), N, value)` + +--- + +#### array specialized algorithms + +``` +template void swap(array& x, array& y); +``` +[horizontal] +Effects: :: `x.swap(y)` +Throws: :: will not throw. + +--- + +#### array comparisons + +``` +template + bool operator==(const array& x, const array& y); +``` +[horizontal] +Returns: :: `std::equal(x.begin(), x.end(), y.begin())` + +--- + +``` +template + bool operator!=(const array& x, const array& y); +``` +[horizontal] +Returns: :: `!(x == y)` + +--- + +``` +template + bool operator<(const array& x, const array& y); +``` +[horizontal] +Returns: :: `std::lexicographical_compare(x.begin(), x.end(), y.begin(), y.end())` + +--- + +``` +template + bool operator>(const array& x, const array& y); +``` +[horizontal] +Returns: :: `y < x` + +--- + +``` +template + bool operator<=(const array& x, const array& y); +``` +[horizontal] +Returns: :: `!(y < x)` + +--- + +``` +template + bool operator>=(const array& x, const array& y); +``` +[horizontal] +Returns: :: `!(x < y)` + +--- + +#### array specializations + +``` +template + T boost::get(array& arr); +``` +[horizontal] +Returns: :: element of array with index `Idx` +Effects: :: Will `static_assert` if `Idx >= N` + +--- + +``` +template + T boost::get(const array& arr); +``` +[horizontal] +Returns: :: const element of array with index `Idx` +Effects: :: Will `static_assert` if `Idx >= N` + +--- From ea54ab16104beaf491a35b007abfe5a0212ddf16 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Mon, 6 Jan 2025 18:45:57 +0200 Subject: [PATCH 010/108] Update index.html --- index.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/index.html b/index.html index a9e3c343..cdbc419a 100644 --- a/index.html +++ b/index.html @@ -1,13 +1,13 @@ - + Automatic redirection failed, please go to -../../doc/html/array.html

+doc/html/array.html

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

- \ No newline at end of file + From fd24e0592c0389083013d1dab99508e40a1cd0b0 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Thu, 9 Jan 2025 20:49:37 +0200 Subject: [PATCH 011/108] Add boostdoc, boostrelease targets to doc/Jamfile.v2 --- doc/Jamfile.v2 | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index 7087c6c7..83ce1dd2 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -14,3 +14,9 @@ explicit array.pdf ; install pdf_ : array.pdf : pdf ; explicit pdf_ ; + +############################################################################### +alias boostdoc ; +explicit boostdoc ; +alias boostrelease : html_ ; +explicit boostrelease ; From f9bb980a0bdc9a25c5bf630b20e7b5cfe03a023f Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Thu, 9 Jan 2025 21:01:41 +0200 Subject: [PATCH 012/108] Add array_typedef_test.cpp --- test/Jamfile.v2 | 8 +++++++ test/array_typedef_test.cpp | 43 +++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 test/array_typedef_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index dde5c33b..11609ab3 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -7,6 +7,8 @@ import testing ; import-search /boost/config/checks ; import config : requires ; +# + run array0.cpp ; run array1.cpp ; run array2.cpp ; @@ -24,4 +26,10 @@ compile-fail array_getfail2.cpp ; run array_hash.cpp : : : [ requires cxx11_noexcept ] ; +# + +run array_typedef_test.cpp ; + +# + run quick.cpp ; diff --git a/test/array_typedef_test.cpp b/test/array_typedef_test.cpp new file mode 100644 index 00000000..d122d1dd --- /dev/null +++ b/test/array_typedef_test.cpp @@ -0,0 +1,43 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include +#include +#include + +template void test() +{ + typedef boost::array A; + + BOOST_TEST_TRAIT_SAME(typename A::value_type, T); + + BOOST_TEST_TRAIT_SAME(typename A::iterator, T*); + BOOST_TEST_TRAIT_SAME(typename A::const_iterator, T const*); + + BOOST_TEST_TRAIT_SAME(typename A::reverse_iterator, std::reverse_iterator); + BOOST_TEST_TRAIT_SAME(typename A::const_reverse_iterator, std::reverse_iterator); + + BOOST_TEST_TRAIT_SAME(typename A::reference, T&); + BOOST_TEST_TRAIT_SAME(typename A::const_reference, T const&); + + BOOST_TEST_TRAIT_SAME(typename A::size_type, std::size_t); + BOOST_TEST_TRAIT_SAME(typename A::difference_type, std::ptrdiff_t); + + BOOST_TEST_EQ(A::static_size, N); +} + +int main() +{ + test(); + test(); + test(); + + test(); + test(); + test(); + + return boost::report_errors(); +} From e0bd7e85609c6bc422fc3e7883c406758c953860 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 02:57:33 +0200 Subject: [PATCH 013/108] Add array_elems_test.cpp --- test/Jamfile.v2 | 1 + test/array_elems_test.cpp | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 test/array_elems_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 11609ab3..91cb6af7 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -29,6 +29,7 @@ run array_hash.cpp # run array_typedef_test.cpp ; +run array_elems_test.cpp ; # diff --git a/test/array_elems_test.cpp b/test/array_elems_test.cpp new file mode 100644 index 00000000..0204c664 --- /dev/null +++ b/test/array_elems_test.cpp @@ -0,0 +1,26 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include + +template void test() +{ + boost::array a = {}; + + T (&e)[ N ] = a.elems; + + BOOST_TEST_EQ( static_cast( e ), static_cast( &a ) ); +} + +int main() +{ + test(); + test(); + + test(); + test(); + + return boost::report_errors(); +} From 049e98dd57d74127870466702a50b43094af6e36 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 03:30:57 +0200 Subject: [PATCH 014/108] Add array_init_test.cpp --- test/Jamfile.v2 | 1 + test/array_init_test.cpp | 70 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 test/array_init_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 91cb6af7..79d76ce2 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -30,6 +30,7 @@ run array_hash.cpp run array_typedef_test.cpp ; run array_elems_test.cpp ; +run array_init_test.cpp ; # diff --git a/test/array_init_test.cpp b/test/array_init_test.cpp new file mode 100644 index 00000000..faaa7f40 --- /dev/null +++ b/test/array_init_test.cpp @@ -0,0 +1,70 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +template void test1() +{ + boost::array a = {{}}; + + for( std::size_t i = 0; i < N; ++i ) + { + BOOST_TEST_EQ( a[i], T() ); + } +} + +template void test2() +{ + boost::array a = {}; + + for( std::size_t i = 0; i < N; ++i ) + { + BOOST_TEST_EQ( a[i], T() ); + } +} + +template void test3() +{ + boost::array a = {{ 1, 2, 3, 4 }}; + T b[ 4 ] = { 1, 2, 3, 4 }; + + BOOST_TEST_ALL_EQ( a.begin(), a.end(), b + 0, b + 4 ); +} + +template void test4() +{ + boost::array a = { 1, 2, 3, 4 }; + T b[ 4 ] = { 1, 2, 3, 4 }; + + BOOST_TEST_ALL_EQ( a.begin(), a.end(), b + 0, b + 4 ); +} + +int main() +{ + // test1(); + test1(); + test1(); + + // test1(); + test1(); + test1(); + + test2(); + test2(); + test2(); + + // test2(); + test2(); + test2(); + + test3(); + test3(); + + test4(); + test4(); + + return boost::report_errors(); +} From 7fac30e1ab6ab1015cfe4bf0d9ad3bac0375b530 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 03:37:10 +0200 Subject: [PATCH 015/108] Fix msvc-14.0, gcc-4.x failures --- test/array_elems_test.cpp | 3 ++- test/array_init_test.cpp | 11 +++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/test/array_elems_test.cpp b/test/array_elems_test.cpp index 0204c664..9506cbfc 100644 --- a/test/array_elems_test.cpp +++ b/test/array_elems_test.cpp @@ -4,10 +4,11 @@ #include #include +#include template void test() { - boost::array a = {}; + boost::array a = {{}}; T (&e)[ N ] = a.elems; diff --git a/test/array_init_test.cpp b/test/array_init_test.cpp index faaa7f40..ae40fd36 100644 --- a/test/array_init_test.cpp +++ b/test/array_init_test.cpp @@ -4,6 +4,8 @@ #include #include +#include +#include #include template void test1() @@ -57,9 +59,18 @@ int main() test2(); // test2(); + +#if BOOST_WORKAROUND(BOOST_MSVC, < 1910) || BOOST_WORKAROUND(BOOST_GCC, < 50000) + + // = {} doesn't work for const T + +#else + test2(); test2(); +#endif + test3(); test3(); From 51fbc208d9d69b56cbe6f5dc77c09f4c579add7e Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 03:49:09 +0200 Subject: [PATCH 016/108] Add array_copy_test.cpp --- test/Jamfile.v2 | 1 + test/array_copy_test.cpp | 65 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 test/array_copy_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 79d76ce2..a2add772 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -31,6 +31,7 @@ run array_hash.cpp run array_typedef_test.cpp ; run array_elems_test.cpp ; run array_init_test.cpp ; +run array_copy_test.cpp ; # diff --git a/test/array_copy_test.cpp b/test/array_copy_test.cpp new file mode 100644 index 00000000..bcb29a4b --- /dev/null +++ b/test/array_copy_test.cpp @@ -0,0 +1,65 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +template void test1() +{ + boost::array a1 = {{}}; + boost::array a2 = a1; + + BOOST_TEST_ALL_EQ( a1.begin(), a1.end(), a2.begin(), a2.end() ); +} + +template void test2() +{ + boost::array a1 = {{}}; + + boost::array a2; + a2 = a1; + + BOOST_TEST_ALL_EQ( a1.begin(), a1.end(), a2.begin(), a2.end() ); +} + +template void test3() +{ + boost::array a1 = {{ 1, 2, 3, 4 }}; + boost::array a2 = a1; + + BOOST_TEST_ALL_EQ( a1.begin(), a1.end(), a2.begin(), a2.end() ); +} + +template void test4() +{ + boost::array a1 = { 1, 2, 3, 4 }; + + boost::array a2; + a2 = a1; + + BOOST_TEST_ALL_EQ( a1.begin(), a1.end(), a2.begin(), a2.end() ); +} + +int main() +{ + // test1(); + test1(); + test1(); + + // test1(); + test1(); + test1(); + + // test2(); + test2(); + test2(); + + test3(); + test3(); + + test4(); + + return boost::report_errors(); +} From 72997add9655f77bd5850fa27f44397adbb00442 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 04:07:38 +0200 Subject: [PATCH 017/108] Add array_convert_test.cpp --- test/Jamfile.v2 | 1 + test/array_convert_test.cpp | 38 +++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 test/array_convert_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index a2add772..64f49d55 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -32,6 +32,7 @@ run array_typedef_test.cpp ; run array_elems_test.cpp ; run array_init_test.cpp ; run array_copy_test.cpp ; +run array_convert_test.cpp ; # diff --git a/test/array_convert_test.cpp b/test/array_convert_test.cpp new file mode 100644 index 00000000..aa1e9c78 --- /dev/null +++ b/test/array_convert_test.cpp @@ -0,0 +1,38 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +template void test2() +{ + boost::array a1 = {}; + + boost::array a2; + a2 = a1; + + BOOST_TEST_ALL_EQ( a1.begin(), a1.end(), a2.begin(), a2.end() ); +} + +template void test4() +{ + boost::array a1 = { 1, 2, 3, 4 }; + + boost::array a2; + a2 = a1; + + BOOST_TEST_ALL_EQ( a1.begin(), a1.end(), a2.begin(), a2.end() ); +} + +int main() +{ + test2(); + test2(); + test2(); + + test4(); + + return boost::report_errors(); +} From 1ae515a17d91603f23114da6142eab0993a63500 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 04:09:16 +0200 Subject: [PATCH 018/108] Update array_copy_test --- test/array_copy_test.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/array_copy_test.cpp b/test/array_copy_test.cpp index bcb29a4b..e94039a4 100644 --- a/test/array_copy_test.cpp +++ b/test/array_copy_test.cpp @@ -16,7 +16,7 @@ template void test1() template void test2() { - boost::array a1 = {{}}; + boost::array a1 = {}; boost::array a2; a2 = a1; @@ -52,7 +52,7 @@ int main() test1(); test1(); - // test2(); + test2(); test2(); test2(); From c5741a92e72c2f97516baad211da7ec40c1ad6b2 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 04:40:35 +0200 Subject: [PATCH 019/108] Add array_data_test.cpp --- test/Jamfile.v2 | 1 + test/array_data_test.cpp | 41 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 test/array_data_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 64f49d55..fd065c38 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -33,6 +33,7 @@ run array_elems_test.cpp ; run array_init_test.cpp ; run array_copy_test.cpp ; run array_convert_test.cpp ; +run array_data_test.cpp ; # diff --git a/test/array_data_test.cpp b/test/array_data_test.cpp new file mode 100644 index 00000000..d27fec1b --- /dev/null +++ b/test/array_data_test.cpp @@ -0,0 +1,41 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +template void test() +{ + { + boost::array a = {{}}; + + T* p1 = a.data(); + T* p2 = a.elems; + + BOOST_TEST_EQ( p1, p2 ); + } + + { + boost::array const a = {{}}; + + T const* p1 = a.data(); + T const* p2 = a.elems; + + BOOST_TEST_EQ( p1, p2 ); + } +} + +int main() +{ + // test(); + test(); + test(); + + // test(); + test(); + test(); + + return boost::report_errors(); +} From 8999204cae6df8a0791f4896f5035fb23c38a90c Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 04:53:08 +0200 Subject: [PATCH 020/108] Add array_iterator_test.cpp --- test/Jamfile.v2 | 1 + test/array_iterator_test.cpp | 108 +++++++++++++++++++++++++++++++++++ 2 files changed, 109 insertions(+) create mode 100644 test/array_iterator_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index fd065c38..80d89723 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -34,6 +34,7 @@ run array_init_test.cpp ; run array_copy_test.cpp ; run array_convert_test.cpp ; run array_data_test.cpp ; +run array_iterator_test.cpp ; # diff --git a/test/array_iterator_test.cpp b/test/array_iterator_test.cpp new file mode 100644 index 00000000..8b75a07a --- /dev/null +++ b/test/array_iterator_test.cpp @@ -0,0 +1,108 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +template void test() +{ + { + boost::array a = {{}}; + + T* p1 = a.data(); + + { + T* p2 = a.begin(); + T* p3 = a.end(); + + BOOST_TEST_EQ( p2, p1 ); + BOOST_TEST_EQ( p3, p1 + N ); + } + + { + T const* p2 = a.cbegin(); + T const* p3 = a.cend(); + + BOOST_TEST_EQ( p2, p1 ); + BOOST_TEST_EQ( p3, p1 + N ); + } + } + + { + boost::array const a = {{}}; + + T const* p1 = a.data(); + + { + T const* p2 = a.begin(); + T const* p3 = a.end(); + + BOOST_TEST_EQ( p2, p1 ); + BOOST_TEST_EQ( p3, p1 + N ); + } + + { + T const* p2 = a.cbegin(); + T const* p3 = a.cend(); + + BOOST_TEST_EQ( p2, p1 ); + BOOST_TEST_EQ( p3, p1 + N ); + } + } +} + +template void test2() +{ + { + boost::array a = {}; + + { + T* p2 = a.begin(); + T* p3 = a.end(); + + BOOST_TEST_EQ( p2, p3 ); + } + + { + T const* p2 = a.cbegin(); + T const* p3 = a.cend(); + + BOOST_TEST_EQ( p2, p3 ); + } + } + + { + boost::array const a = {}; + + { + T const* p2 = a.begin(); + T const* p3 = a.end(); + + BOOST_TEST_EQ( p2, p3 ); + } + + { + T const* p2 = a.cbegin(); + T const* p3 = a.cend(); + + BOOST_TEST_EQ( p2, p3 ); + } + } +} + +int main() +{ + // test(); + test(); + test(); + + // test(); + test(); + test(); + + test2(); + + return boost::report_errors(); +} From 48b07e63fb963d00191d696ed9a1f4e1f7a931a2 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 10 Jan 2025 05:00:39 +0200 Subject: [PATCH 021/108] Add array_reverse_test.cpp --- test/Jamfile.v2 | 1 + test/array_reverse_test.cpp | 88 +++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+) create mode 100644 test/array_reverse_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 80d89723..2f18d46b 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -35,6 +35,7 @@ run array_copy_test.cpp ; run array_convert_test.cpp ; run array_data_test.cpp ; run array_iterator_test.cpp ; +run array_reverse_test.cpp ; # diff --git a/test/array_reverse_test.cpp b/test/array_reverse_test.cpp new file mode 100644 index 00000000..1d556bda --- /dev/null +++ b/test/array_reverse_test.cpp @@ -0,0 +1,88 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include +#include + +template void test() +{ + { + boost::array a = {{}}; + + { + std::reverse_iterator r1( a.rbegin() ); + std::reverse_iterator r2( a.end() ); + + BOOST_TEST( r1 == r2 ); + } + + { + std::reverse_iterator r1( a.rend() ); + std::reverse_iterator r2( a.begin() ); + + BOOST_TEST( r1 == r2 ); + } + + { + std::reverse_iterator r1( a.crbegin() ); + std::reverse_iterator r2( a.cend() ); + + BOOST_TEST( r1 == r2 ); + } + + { + std::reverse_iterator r1( a.crend() ); + std::reverse_iterator r2( a.cbegin() ); + + BOOST_TEST( r1 == r2 ); + } + } + + { + boost::array const a = {{}}; + + { + std::reverse_iterator r1( a.rbegin() ); + std::reverse_iterator r2( a.end() ); + + BOOST_TEST( r1 == r2 ); + } + + { + std::reverse_iterator r1( a.rend() ); + std::reverse_iterator r2( a.begin() ); + + BOOST_TEST( r1 == r2 ); + } + + { + std::reverse_iterator r1( a.crbegin() ); + std::reverse_iterator r2( a.cend() ); + + BOOST_TEST( r1 == r2 ); + } + + { + std::reverse_iterator r1( a.crend() ); + std::reverse_iterator r2( a.cbegin() ); + + BOOST_TEST( r1 == r2 ); + } + } +} + +int main() +{ + // test(); + test(); + test(); + + // test(); + test(); + test(); + + return boost::report_errors(); +} From c0488c00a37a2c05b6a4fa98acfb60c5db62508c Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Sat, 11 Jan 2025 04:13:41 +0200 Subject: [PATCH 022/108] Add array_size_test.cpp --- test/Jamfile.v2 | 1 + test/array_size_test.cpp | 73 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 test/array_size_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 2f18d46b..a3dd7e33 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -36,6 +36,7 @@ run array_convert_test.cpp ; run array_data_test.cpp ; run array_iterator_test.cpp ; run array_reverse_test.cpp ; +run array_size_test.cpp ; # diff --git a/test/array_size_test.cpp b/test/array_size_test.cpp new file mode 100644 index 00000000..8780a08c --- /dev/null +++ b/test/array_size_test.cpp @@ -0,0 +1,73 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include +#include + +template void test1() +{ + { + boost::array a = {{}}; + + BOOST_TEST_EQ( a.size(), N ); + BOOST_TEST_EQ( a.empty(), N == 0 ); + BOOST_TEST_EQ( a.max_size(), N ); + } + + { + boost::array const a = {{}}; + + BOOST_TEST_EQ( a.size(), N ); + BOOST_TEST_EQ( a.empty(), N == 0 ); + BOOST_TEST_EQ( a.max_size(), N ); + } +} + +template void test2() +{ + typedef boost::array A; + + BOOST_TEST_EQ( A().size(), N ); + BOOST_TEST_EQ( A().empty(), N == 0 ); + BOOST_TEST_EQ( A().max_size(), N ); +} + +// the functions are static, which deviates from the standard +template void test3() +{ + typedef boost::array A; + + BOOST_TEST_EQ( A::size(), N ); + BOOST_TEST_EQ( A::empty(), N == 0 ); + BOOST_TEST_EQ( A::max_size(), N ); + + BOOST_TEST_EQ( A::static_size, N ); +} + +int main() +{ + // test1(); + test1(); + test1(); + + // test1(); + test1(); + test1(); + + test2(); + test2(); + test2(); + + test3(); + test3(); + test3(); + + test3(); + test3(); + test3(); + + return boost::report_errors(); +} From 8d1871b4c299f5075bc37a89be40df6203e9d15b Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Sat, 11 Jan 2025 04:30:54 +0200 Subject: [PATCH 023/108] Add array_access_test.cpp --- test/Jamfile.v2 | 1 + test/array_access_test.cpp | 117 +++++++++++++++++++++++++++++++++++++ 2 files changed, 118 insertions(+) create mode 100644 test/array_access_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index a3dd7e33..0d629fb9 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -37,6 +37,7 @@ run array_data_test.cpp ; run array_iterator_test.cpp ; run array_reverse_test.cpp ; run array_size_test.cpp ; +run array_access_test.cpp ; # diff --git a/test/array_access_test.cpp b/test/array_access_test.cpp new file mode 100644 index 00000000..44be92e0 --- /dev/null +++ b/test/array_access_test.cpp @@ -0,0 +1,117 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#define BOOST_ENABLE_ASSERT_HANDLER + +#include +#include +#include + +struct assertion_failure +{ +}; + +namespace boost +{ + +void assertion_failed( char const* /*expr*/, char const* /*function*/, char const* /*file*/, long /*line*/ ) +{ + throw assertion_failure(); +} + +void assertion_failed_msg( char const* /*expr*/, char const* /*msg*/, char const* /*function*/, char const* /*file*/, long /*line*/ ) +{ + throw assertion_failure(); +} + +} // namespace boost + +template void test() +{ + { + boost::array a = {{}}; + + T* p1 = a.data(); + + for( std::size_t i = 0; i < N; ++i ) + { + T* p2 = &a[ i ]; + T* p3 = &a.at( i ); + + BOOST_TEST_EQ( p2, p1 + i ); + BOOST_TEST_EQ( p3, p1 + i ); + } + + { + T* p2 = &a.front(); + T* p3 = &a.back(); + + BOOST_TEST_EQ( p2, p1 + 0 ); + BOOST_TEST_EQ( p3, p1 + N - 1 ); + } + + BOOST_TEST_THROWS( a.at( N ), std::out_of_range ); + BOOST_TEST_THROWS( a[ N ], assertion_failure ); + } + + { + boost::array const a = {{}}; + + T const* p1 = a.data(); + + for( std::size_t i = 0; i < N; ++i ) + { + T const* p2 = &a[ i ]; + T const* p3 = &a.at( i ); + + BOOST_TEST_EQ( p2, p1 + i ); + BOOST_TEST_EQ( p3, p1 + i ); + } + + { + T const* p2 = &a.front(); + T const* p3 = &a.back(); + + BOOST_TEST_EQ( p2, p1 + 0 ); + BOOST_TEST_EQ( p3, p1 + N - 1 ); + } + + BOOST_TEST_THROWS( a.at( N ), std::out_of_range ); + BOOST_TEST_THROWS( a[ N ], assertion_failure ); + } +} + +template void test2() +{ + { + boost::array a = {}; + + BOOST_TEST_THROWS( a.at( 0 ), std::out_of_range ); + BOOST_TEST_THROWS( a[ 0 ], std::out_of_range ); + BOOST_TEST_THROWS( a.front(), std::out_of_range ); + BOOST_TEST_THROWS( a.back(), std::out_of_range ); + } + + { + boost::array const a = {}; + + BOOST_TEST_THROWS( a.at( 0 ), std::out_of_range ); + BOOST_TEST_THROWS( a[ 0 ], std::out_of_range ); + BOOST_TEST_THROWS( a.front(), std::out_of_range ); + BOOST_TEST_THROWS( a.back(), std::out_of_range ); + } +} + +int main() +{ + test(); + test(); + + test(); + test(); + + test2(); + + return boost::report_errors(); +} From 63f8f022e229370cefcc3e08d97c3b086502a6ff Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Sat, 11 Jan 2025 21:29:33 +0200 Subject: [PATCH 024/108] Add array_c_array_test.cpp --- test/Jamfile.v2 | 1 + test/array_c_array_test.cpp | 70 +++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 test/array_c_array_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 0d629fb9..f4988524 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -38,6 +38,7 @@ run array_iterator_test.cpp ; run array_reverse_test.cpp ; run array_size_test.cpp ; run array_access_test.cpp ; +run array_c_array_test.cpp ; # diff --git a/test/array_c_array_test.cpp b/test/array_c_array_test.cpp new file mode 100644 index 00000000..b65d4449 --- /dev/null +++ b/test/array_c_array_test.cpp @@ -0,0 +1,70 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include +#include +#include + +// c_array and get_c_array are nonstandard extensions +// probably need to be deprecated and removed + +template void test() +{ + boost::array a = {}; + + T* p1 = a.c_array(); + T* p2 = a.data(); + + BOOST_TEST_EQ( p1, p2 ); +} + +template void test2() +{ + { + boost::array a = {{}}; + + T (&e1)[ N ] = boost::get_c_array( a ); + T (&e2)[ N ] = a.elems; + + BOOST_TEST_EQ( static_cast( e1 ), static_cast( e2 ) ); + } + { + boost::array const a = {{}}; + + T const (&e1)[ N ] = boost::get_c_array( a ); + T const (&e2)[ N ] = a.elems; + + BOOST_TEST_EQ( static_cast( e1 ), static_cast( e2 ) ); + } +} + +int main() +{ + test(); + test(); + test(); + + test(); + +#if BOOST_WORKAROUND(BOOST_MSVC, < 1910) || BOOST_WORKAROUND(BOOST_GCC, < 50000) + + // = {} doesn't work for const T + +#else + + test(); + test(); + +#endif + + test2(); + test2(); + + test2(); + test2(); + + return boost::report_errors(); +} From 4e3d4ef99f4f4a2af3d8718d6d9d9c4affb3b981 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Sat, 11 Jan 2025 21:51:06 +0200 Subject: [PATCH 025/108] Add array_fill_test.cpp --- test/Jamfile.v2 | 1 + test/array_fill_test.cpp | 57 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 test/array_fill_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index f4988524..21d6cf48 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -39,6 +39,7 @@ run array_reverse_test.cpp ; run array_size_test.cpp ; run array_access_test.cpp ; run array_c_array_test.cpp ; +run array_fill_test.cpp ; # diff --git a/test/array_fill_test.cpp b/test/array_fill_test.cpp new file mode 100644 index 00000000..17ca90fd --- /dev/null +++ b/test/array_fill_test.cpp @@ -0,0 +1,57 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +template void test() +{ + boost::array a = {}; + + a.fill( 1 ); + + for( std::size_t i = 0; i < N; ++i ) + { + BOOST_TEST_EQ( a[i], 1 ); + } +} + +template void test2() +{ + boost::array a = {{ 1, 2, 3, 4 }}; + + a.fill( 5 ); + + for( std::size_t i = 0; i < 4; ++i ) + { + BOOST_TEST_EQ( a[i], 5 ); + } +} + +template void test3() +{ + boost::array a = {{ 1, 2, 3, 4 }}; + + // aliasing + a.fill( a[ 1 ] ); + + for( std::size_t i = 0; i < 4; ++i ) + { + BOOST_TEST_EQ( a[i], 2 ); + } +} + +int main() +{ + test(); + test(); + test(); + + test2(); + + test3(); + + return boost::report_errors(); +} From cbd8e1a8dcf43aeb0294086e2116a9e8d8cacdb3 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Sat, 11 Jan 2025 21:56:12 +0200 Subject: [PATCH 026/108] Add array_assign_test.cpp --- test/Jamfile.v2 | 1 + test/array_assign_test.cpp | 60 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 test/array_assign_test.cpp diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 index 21d6cf48..c7c14bf3 100644 --- a/test/Jamfile.v2 +++ b/test/Jamfile.v2 @@ -40,6 +40,7 @@ run array_size_test.cpp ; run array_access_test.cpp ; run array_c_array_test.cpp ; run array_fill_test.cpp ; +run array_assign_test.cpp ; # diff --git a/test/array_assign_test.cpp b/test/array_assign_test.cpp new file mode 100644 index 00000000..91c9b161 --- /dev/null +++ b/test/array_assign_test.cpp @@ -0,0 +1,60 @@ +// Copyright 2025 Peter Dimov +// Distributed under the Boost Software License, Version 1.0. +// https://www.boost.org/LICENSE_1_0.txt) + +#include +#include +#include + +// assign is a nonstandard equivalent of fill +// it probably needs to be deprecated and removed + +template void test() +{ + boost::array a = {}; + + a.assign( 1 ); + + for( std::size_t i = 0; i < N; ++i ) + { + BOOST_TEST_EQ( a[i], 1 ); + } +} + +template void test2() +{ + boost::array a = {{ 1, 2, 3, 4 }}; + + a.assign( 5 ); + + for( std::size_t i = 0; i < 4; ++i ) + { + BOOST_TEST_EQ( a[i], 5 ); + } +} + +template void test3() +{ + boost::array a = {{ 1, 2, 3, 4 }}; + + // aliasing + a.assign( a[ 1 ] ); + + for( std::size_t i = 0; i < 4; ++i ) + { + BOOST_TEST_EQ( a[i], 2 ); + } +} + +int main() +{ + test