Update of /cvsroot/boost/boost/libs/multi_array/doc
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv13250
Modified Files:
Tag: RC_1_34_0
reference.html
Log Message:
Backpatching fixes to the documentation from HEAD.
Index: reference.html
===================================================================
RCS file: /cvsroot/boost/boost/libs/multi_array/doc/reference.html,v
retrieving revision 1.9
retrieving revision 1.9.2.1
diff -u -d -r1.9 -r1.9.2.1
--- reference.html 7 Mar 2006 22:27:33 -0000 1.9
+++ reference.html 26 Jun 2006 16:58:28 -0000 1.9.2.1
@@ -1,29 +1,29 @@
-<html><head><meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1"><title>Boost.MultiArray Reference Manual</title><meta
name="generator" content="DocBook XSL Stylesheets V1.62.4"></head><body
bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF"><div class="article" lang="en"><div
class="titlepage"><div><div><h1 class="title"><a
name="id727825"></a>Boost.MultiArray Reference Manual</h1></div><div><div
class="author"><h3 class="author"><span class="firstname">Ronald</span> <span
class="surname">Garcia</span></h3><div class="affiliation"><span
class="orgname">Indiana University<br></span><span class="orgdiv">Open Systems
Lab<br></span></div></div></div><div><p class="copyright">Copyright © 2002 The
Trustees of Indiana University</p></div></div><div></div><hr></div><div
class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a
href="#synopsis">Library Synopsis</a></span></dt><dt><span class="sect1"><a
href="#MultiArray">Mu
ltiArray Concept</a></span></dt><dd><dl><dt><span class="sect2"><a
href="#id832486">Notation</a></span></dt><dt><span class="sect2"><a
href="#id832654">Associated Types</a></span></dt><dt><span class="sect2"><a
href="#id833164">Valid expressions</a></span></dt><dt><span class="sect2"><a
href="#id833954">Complexity guarantees</a></span></dt><dt><span
class="sect2"><a href="#id833978">Invariants</a></span></dt><dt><span
class="sect2"><a href="#view_types">Associated Types for
Views</a></span></dt><dt><span class="sect2"><a
href="#id835348">Models</a></span></dt></dl></dd><dt><span class="sect1"><a
href="#array_types">Array Components</a></span></dt><dd><dl><dt><span
class="sect2"><a href="#multi_array">multi_array</a></span></dt><dt><span
class="sect2"><a
href="#multi_array_ref">multi_array_ref</a></span></dt><dt><span
class="sect2"><a
href="#const_multi_array_ref">const_multi_array_ref</a></span></dt></dl></dd><dt><span
class="sect1"><a href="#auxiliary">Auxiliary Components<
/a></span></dt><dd><dl><dt><span class="sect2"><a
href="#multi_array_types">multi_array_types</a></span></dt><dt><span
class="sect2"><a href="#extent_range">extent_range</a></span></dt><dt><span
class="sect2"><a href="#extent_gen">extent_gen</a></span></dt><dt><span
class="sect2"><a href="#id860316">Global Objects</a></span></dt><dt><span
class="sect2"><a href="#generators">View and SubArray
Generators</a></span></dt><dt><span class="sect2"><a
href="#memory_layout">Memory Layout Specifiers</a></span></dt><dt><span
class="sect2"><a href="#range_checking">Range
Checking</a></span></dt></dl></dd></dl></div><p>Boost.MultiArray is composed of
several components.
+<html><head><meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1"><title>Boost.MultiArray Reference Manual</title><meta
name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body
bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF"><div class="article" lang="en"><div
class="titlepage"><div><div><h1 class="title"><a
name="id729900"></a>Boost.MultiArray Reference Manual</h1></div><div><div
class="author"><h3 class="author"><span class="firstname">Ronald</span> <span
class="surname">Garcia</span></h3><div class="affiliation"><span
class="orgname">Indiana University<br></span><span class="orgdiv">Open Systems
Lab<br></span></div></div></div><div><p class="copyright">Copyright © 2002 The
Trustees of Indiana University</p></div></div><hr></div><div
class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a
href="#synopsis">Library Synopsis</a></span></dt><dt><span class="sect1"><a
href="#MultiArray">MultiArray Co
ncept</a></span></dt><dd><dl><dt><span class="sect2"><a
href="#id834641">Notation</a></span></dt><dt><span class="sect2"><a
href="#id834809">Associated Types</a></span></dt><dt><span class="sect2"><a
href="#id835319">Valid expressions</a></span></dt><dt><span class="sect2"><a
href="#id836109">Complexity guarantees</a></span></dt><dt><span
class="sect2"><a href="#id836133">Invariants</a></span></dt><dt><span
class="sect2"><a href="#view_types">Associated Types for
Views</a></span></dt><dt><span class="sect2"><a
href="#id837503">Models</a></span></dt></dl></dd><dt><span class="sect1"><a
href="#array_types">Array Components</a></span></dt><dd><dl><dt><span
class="sect2"><a href="#multi_array"><code
class="literal">multi_array</code></a></span></dt><dt><span class="sect2"><a
href="#multi_array_ref"><code
class="literal">multi_array_ref</code></a></span></dt><dt><span
class="sect2"><a href="#const_multi_array_ref"><code
class="literal">const_multi_array_ref</code></a></span></dt>
</dl></dd><dt><span class="sect1"><a href="#auxiliary">Auxiliary
Components</a></span></dt><dd><dl><dt><span class="sect2"><a
href="#multi_array_types"><code
class="literal">multi_array_types</code></a></span></dt><dt><span
class="sect2"><a href="#extent_range"><code
class="classname">extent_range</code></a></span></dt><dt><span class="sect2"><a
href="#extent_gen"><code
class="classname">extent_gen</code></a></span></dt><dt><span class="sect2"><a
href="#id862083">Global Objects</a></span></dt><dt><span class="sect2"><a
href="#generators">View and SubArray Generators</a></span></dt><dt><span
class="sect2"><a href="#memory_layout">Memory Layout
Specifiers</a></span></dt><dt><span class="sect2"><a
href="#range_checking">Range
Checking</a></span></dt></dl></dd></dl></div><p>Boost.MultiArray is composed of
several components.
The MultiArray concept defines a generic interface to multidimensional
containers.
-<tt class="literal">multi_array</tt> is a general purpose container class
-that models MultiArray. <tt class="literal">multi_array_ref</tt>
-and <tt class="literal">const_multi_array_ref</tt> are adapter
+<code class="literal">multi_array</code> is a general purpose container class
+that models MultiArray. <code class="literal">multi_array_ref</code>
+and <code class="literal">const_multi_array_ref</code> are adapter
classes. Using them,
[...1373 lines suppressed...]
+iterators must refer to a range of <code class="literal">NumDims</code>
+elements. <code class="literal">AscendingIter</code> points to objects
+convertible to <code class="literal">bool</code>. A value of
+<code class="literal">true</code> means that a dimension is stored in ascending
+order while <code class="literal">false</code> means that a dimension is stored
+in descending order. <code class="literal">OrderingIter</code> specifies the
order in which dimensions are stored.
-</p></div></div><div class="sect2" lang="en"><div
class="titlepage"><div><div><h3 class="title"><a
name="range_checking"></a>Range Checking</h3></div></div><div></div></div><p>
-By default, the array access methods <tt class="literal">operator()</tt> and
-<tt class="literal">operator[]</tt> perform range
+</p></div></div><div class="sect2" lang="en"><div
class="titlepage"><div><div><h3 class="title"><a
name="range_checking"></a>Range Checking</h3></div></div></div><p>
+By default, the array access methods <code class="literal">operator()</code>
and
+<code class="literal">operator[]</code> perform range
checking. If a supplied index is out of the range defined for an
array, an assertion will abort the program. To disable range
checking (for performance reasons in production releases), define
-the <tt class="literal">BOOST_DISABLE_ASSERTS</tt> preprocessor macro prior to
+the <code class="literal">BOOST_DISABLE_ASSERTS</code> preprocessor macro
prior to
including multi_array.hpp in an application.
</p></div></div></div></body></html>
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
