boost_mirror/multi_array
1
0
Fork 0
mirror of https://github.com/boostorg/multi_array.git synced 2025-05-12 05:41:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Backpatching fixes to the documentation from HEAD.

Browse Source 
[SVN r34410]
This commit is contained in:
Ronald Garcia 2006-06-26 16:58:28 +00:00
parent 24bc73dfae
commit 9398e7799a
5 changed files with 524 additions and 470 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

905
doc/reference.html
View File

File diff suppressed because it is too large Load Diff

4
doc/xml/MultiArray.xml
View File

@ -124,8 +124,8 @@ to describe the MultiArray interface.</para>
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>a</literal></entry> <entry><literal>a,b</literal></entry>
<entry>An object of type <literal>A</literal></entry> <entry>Objects of type <literal>A</literal></entry>
</row> </row>
<row> <row>
<entry><literal>NumDims</literal></entry> <entry><literal>NumDims</literal></entry>

18
doc/xml/const_multi_array_ref.xml
View File

@ -38,21 +38,21 @@ class const_multi_array_ref {
public: public:
// types: // types:
typedef ValueType element; typedef ValueType element;
typedef *implementation-defined* value_type; typedef *unspecified* value_type;
typedef *implementation-defined* reference; typedef *unspecified* reference;
typedef *implementation-defined* const_reference; typedef *unspecified* const_reference;
typedef *implementation-defined* difference_type; typedef *unspecified* difference_type;
typedef *implementation-defined* iterator; typedef *unspecified* iterator;
typedef *implementation-defined* const_iterator; typedef *unspecified* const_iterator;
typedef *implementation-defined* reverse_iterator; typedef *unspecified* reverse_iterator;
typedef *implementation-defined* const_reverse_iterator; typedef *unspecified* const_reverse_iterator;
typedef multi_array_types::size_type size_type; typedef multi_array_types::size_type size_type;
typedef multi_array_types::index index; typedef multi_array_types::index index;
typedef multi_array_types::index_gen index_gen; typedef multi_array_types::index_gen index_gen;
typedef multi_array_types::index_range index_range; typedef multi_array_types::index_range index_range;
typedef multi_array_types::extent_gen extent_gen; typedef multi_array_types::extent_gen extent_gen;
typedef multi_array_types::extent_range extent_range; typedef multi_array_types::extent_range extent_range;
typedef *implementation-defined* storage_order_type; typedef *unspecified* storage_order_type;
// template typedefs // template typedefs
template <std::size_t Dims> struct subarray; template <std::size_t Dims> struct subarray;

39
doc/xml/multi_array.xml
View File

@ -36,21 +36,21 @@ class multi_array {
public: public:
// types: // types:
typedef ValueType element; typedef ValueType element;
typedef *implementation-defined* value_type; typedef *unspecified* value_type;
typedef *implementation-defined* reference; typedef *unspecified* reference;
typedef *implementation-defined* const_reference; typedef *unspecified* const_reference;
typedef *implementation-defined* difference_type; typedef *unspecified* difference_type;
typedef *implementation-defined* iterator; typedef *unspecified* iterator;
typedef *implementation-defined* const_iterator; typedef *unspecified* const_iterator;
typedef *implementation-defined* reverse_iterator; typedef *unspecified* reverse_iterator;
typedef *implementation-defined* const_reverse_iterator; typedef *unspecified* const_reverse_iterator;
typedef multi_array_types::size_type size_type; typedef multi_array_types::size_type size_type;
typedef multi_array_types::index index; typedef multi_array_types::index index;
typedef multi_array_types::index_gen index_gen; typedef multi_array_types::index_gen index_gen;
typedef multi_array_types::index_range index_range; typedef multi_array_types::index_range index_range;
typedef multi_array_types::extent_gen extent_gen; typedef multi_array_types::extent_gen extent_gen;
typedef multi_array_types::extent_range extent_range; typedef multi_array_types::extent_range extent_range;
typedef *implementation-defined* storage_order_type; typedef *unspecified* storage_order_type;
// template typedefs // template typedefs
@ -136,7 +136,9 @@ public:
template <typename SizeList> template <typename SizeList>
void reshape(const SizeList& sizes) void reshape(const SizeList& sizes)
template <typename BaseList> void reindex(const BaseList& values); template <typename BaseList> void reindex(const BaseList& values);
void reindex(index value); void reindex(index value);
template <typename ExtentList>
multi_array& resize(const ExtentList& extents);
multi_array& resize(extents_tuple& extents); multi_array& resize(extents_tuple& extents);
}; };
]]> ]]>
@ -327,15 +329,20 @@ O(<literal>this->num_elements()</literal>) calls to
<varlistentry> <varlistentry>
<term> <term>
<programlisting><![CDATA[multi_array& resize(extent_gen::gen_type<NumDims>::type ranges);]]> <programlisting><![CDATA[multi_array& resize(extent_gen::gen_type<NumDims>::type extents);
template <typename ExtentList>
multi_array& resize(const ExtentList& extents);
]]>
</programlisting></term> </programlisting></term>
<listitem> <listitem>
<para> <para>
This function resizes an array to the shape specified by This function resizes an array to the shape specified by
<literal>ranges</literal>. The contents of the array are preserved <literal>extents</literal>, which is either a generated list of
whenever possible; if the new array size is smaller, then some data will extents or a model of the <literal>Collection</literal> concept. The
be lost. Any new elements created by resizing the array are initialized with contents of the array are preserved whenever possible; if the new
the <literal>element</literal> default constructor. array size is smaller, then some data will be lost. Any new elements
created by resizing the array are initialized with the
<literal>element</literal> default constructor.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

28
doc/xml/reference.xml
View File

@ -50,13 +50,13 @@ brings the following declarations into scope:</para>
<![CDATA[namespace boost { <![CDATA[namespace boost {
namespace multi_array_types { namespace multi_array_types {
typedef *implementation-defined* index; typedef *unspecified* index;
typedef *implementation-defined* size_type; typedef *unspecified* size_type;
typedef *implementation-defined* difference_type; typedef *unspecified* difference_type;
typedef *implementation-defined* index_range; typedef *unspecified* index_range;
typedef *implementation-defined* extent_range; typedef *unspecified* extent_range;
typedef *implementation-defined* index_gen; typedef *unspecified* index_gen;
typedef *implementation-defined* extent_gen; typedef *unspecified* extent_gen;
} }
template <typename ValueType, template <typename ValueType,
@ -343,13 +343,13 @@ std::count_if(this->index_bases(),this->index_bases()+this->num_dimensions(),
<programlisting> <programlisting>
<![CDATA[namespace multi_array_types { <![CDATA[namespace multi_array_types {
typedef *implementation-defined* index; typedef *unspecified* index;
typedef *implementation-defined* size_type; typedef *unspecified* size_type;
typedef *implementation-defined* difference_type; typedef *unspecified* difference_type;
typedef *implementation-defined* index_range; typedef *unspecified* index_range;
typedef *implementation-defined* extent_range; typedef *unspecified* extent_range;
typedef *implementation-defined* index_gen; typedef *unspecified* index_gen;
typedef *implementation-defined* extent_gen; typedef *unspecified* extent_gen;
}]]> }]]>
</programlisting> </programlisting>