mirror of
https://github.com/bolero-MURAKAMI/Sprout.git
synced 2025-05-12 09:33:30 +00:00
add array overview
This commit is contained in:
Bolero-MURAKAMI
parent
2eded72912
commit
b6835b636f
13 changed files with 842 additions and 25 deletions
|
|
@ -6,8 +6,17 @@ Libraries
|
|||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
sprout/array/index
|
||||
sprout/algorithm/index
|
||||
|
||||
.. _sprout-listed_by_alphabetically:
|
||||
*******************************************************************************
|
||||
Libraries Listed Alphabetically
|
||||
*******************************************************************************
|
||||
|
||||
* :doc:`algorithm <./sprout/algorithm/index>` - STL like generic algorithms.
|
||||
* :doc:`array <./sprout/array/index>` - STL compliant class template for storing fixed-size sequences of objects.
|
||||
|
||||
.. _sprout-listed_by_category:
|
||||
*******************************************************************************
|
||||
Libraries Listed by Category
|
||||
|
|
@ -17,11 +26,13 @@ Libraries Listed by Category
|
|||
Containers and Data structures
|
||||
=======================================
|
||||
|
||||
* :doc:`array <./sprout/array/index>` - STL compliant class template for storing fixed-size sequences of objects.
|
||||
|
||||
.. _sprout-listed_by_category-algorithms:
|
||||
Algorithms
|
||||
=======================================
|
||||
|
||||
* :doc:`algorithm <./sprout/algorithm/index>` - STL-like generic algorithms.
|
||||
* :doc:`algorithm <./sprout/algorithm/index>` - STL like generic algorithms.
|
||||
|
||||
.. _sprout-listed_by_category-algorithms:
|
||||
Algorithms
|
||||
|
|
|
|||
|
|
@ -16,11 +16,13 @@ Sprout.Algorithm
|
|||
Non-modifying sequence operations
|
||||
*******************************************************************************
|
||||
|
||||
* :doc:`./all_of`
|
||||
* :doc:`all_of <./all_of>`
|
||||
* :doc:`any_of <./any_of>`
|
||||
* :doc:`none_of <./none_of>`
|
||||
* :doc:`one_of <./one_of>`
|
||||
|
||||
* :doc:`./any_of`
|
||||
Header
|
||||
========================================
|
||||
|
||||
* :doc:`./none_of`
|
||||
|
||||
* :doc:`./one_of`
|
||||
``sprout/algorithm.hpp``
|
||||
|
||||
|
|
|
|||
138
docs/_sources/libs/sprout/array/array/index.txt
Normal file
138
docs/_sources/libs/sprout/array/array/index.txt
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
.. _sprout-array-array:
|
||||
###############################################################################
|
||||
Class template array
|
||||
###############################################################################
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
Interface
|
||||
========================================
|
||||
.. sourcecode:: c++
|
||||
|
||||
template <typename T, std::size_t N>
|
||||
class array {
|
||||
// types:
|
||||
typedef T& reference;
|
||||
typedef T const& const_reference;
|
||||
typedef /*implementation-defined*/ iterator;
|
||||
typedef /*implementation-defined*/ const_iterator;
|
||||
typedef std::size_t size_type;
|
||||
typedef std::ptrdiff_t difference_type;
|
||||
typedef T value_type;
|
||||
typedef T* pointer;
|
||||
typedef T const* const_pointer;
|
||||
typedef sprout::reverse_iterator<iterator> reverse_iterator;
|
||||
typedef sprout::reverse_iterator<const_iterator> const_reverse_iterator;
|
||||
|
||||
// constants:
|
||||
SPROUT_STATIC_CONSTEXPR size_type static_size = N;
|
||||
|
||||
T elems[N ? N : 1]; // exposition only
|
||||
|
||||
// construct/copy/destroy:
|
||||
template<typename T2>
|
||||
array& operator=(array<T2, N> const& rhs);
|
||||
template<typename T2>
|
||||
array& operator=(array<T2, N>&& rhs);
|
||||
|
||||
// modifiers:
|
||||
void fill(const_reference u);
|
||||
SPROUT_CONSTEXPR array fill(const_reference value) const;
|
||||
void assign(const_reference value);
|
||||
SPROUT_CONSTEXPR array assign(const_reference value) const;
|
||||
void swap(array&) SPROUT_NOEXCEPT_EXPR(SPROUT_NOEXCEPT_EXPR(std::swap(std::declval<T&>(), std::declval<T&>())));
|
||||
|
||||
// iterators:
|
||||
iterator begin() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator begin() const SPROUT_NOEXCEPT;
|
||||
iterator end() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator end() const SPROUT_NOEXCEPT;
|
||||
reverse_iterator rbegin() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator rbegin() const SPROUT_NOEXCEPT;
|
||||
reverse_iterator rend() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator rend() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator cbegin() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator cend() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator crbegin() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator crend() const SPROUT_NOEXCEPT;
|
||||
|
||||
// capacity:
|
||||
SPROUT_CONSTEXPR size_type size() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR size_type max_size() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR bool empty() const SPROUT_NOEXCEPT;
|
||||
|
||||
// element access:
|
||||
reference operator[](size_type n);
|
||||
SPROUT_CONSTEXPR const_reference operator[](size_type n) const;
|
||||
reference at(size_type n);
|
||||
SPROUT_CONSTEXPR const_reference at(size_type n) const;
|
||||
reference front();
|
||||
SPROUT_CONSTEXPR const_reference front() const;
|
||||
reference back();
|
||||
SPROUT_CONSTEXPR const_reference back() const;
|
||||
pointer data() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_pointer data() const SPROUT_NOEXCEPT;
|
||||
pointer c_array() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_pointer c_array() const SPROUT_NOEXCEPT;
|
||||
};
|
||||
|
||||
|
||||
Description
|
||||
========================================
|
||||
|
||||
Member functions
|
||||
----------------------------------------
|
||||
|
||||
(initializer)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`(initializer) <./array/initializer->`
|
||||
|
||||
construct/copy/destroy
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`operator= <./array/operator-assign>`
|
||||
|
||||
modifiers
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`fill <./array/fill>`
|
||||
* :doc:`assign <./array/assign>`
|
||||
|
||||
iterators
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`begin <./array/begin>`
|
||||
* :doc:`end <./array/end>`
|
||||
* :doc:`rbegin <./array/rbegin>`
|
||||
* :doc:`rend <./array/rend>`
|
||||
* :doc:`cbegin <./array/cbegin>`
|
||||
* :doc:`cend <./array/cend>`
|
||||
* :doc:`crbegin <./array/crbegin>`
|
||||
* :doc:`crend <./array/crend>`
|
||||
|
||||
capacity
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`size <./array/size>`
|
||||
* :doc:`max_size <./array/max_size>`
|
||||
* :doc:`empty <./array/empty>`
|
||||
|
||||
element access
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`operator[] <./array/operator-subscript>`
|
||||
* :doc:`at <./array/at>`
|
||||
* :doc:`front <./array/front>`
|
||||
* :doc:`back <./array/back>`
|
||||
* :doc:`data <./array/data>`
|
||||
* :doc:`c_array <./array/c_array>`
|
||||
|
||||
Header
|
||||
========================================
|
||||
|
||||
``sprout/array/array.hpp``
|
||||
|
||||
Convenience header: ``sprout/array.hpp``
|
||||
|
||||
39
docs/_sources/libs/sprout/array/index.txt
Normal file
39
docs/_sources/libs/sprout/array/index.txt
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
.. _sprout-array:
|
||||
###############################################################################
|
||||
Sprout.Array
|
||||
###############################################################################
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
array/index
|
||||
|
||||
Interface
|
||||
========================================
|
||||
.. sourcecode:: c++
|
||||
|
||||
template <typename T, std::size_t N>
|
||||
class array;
|
||||
|
||||
template<typename T, std::size_t N>
|
||||
inline void swap(sprout::array<T, N>& lhs, sprout::array<T, N>& rhs) SPROUT_NOEXCEPT_EXPR(SPROUT_NOEXCEPT_EXPR(lhs.swap(rhs)));
|
||||
|
||||
template<typename T, std::size_t N>
|
||||
inline SPROUT_CONSTEXPR sprout::array<T, N> to_array(T const (& arr)[N]);
|
||||
|
||||
Classes
|
||||
========================================
|
||||
|
||||
* :doc:`array <./array/index>`
|
||||
|
||||
Non-member functions
|
||||
========================================
|
||||
|
||||
* :doc:`swap <./swap>`
|
||||
* :doc:`to_array <./to_array>`
|
||||
|
||||
Header
|
||||
========================================
|
||||
|
||||
``sprout/array.hpp``
|
||||
|
||||
|
|
@ -21,7 +21,7 @@
|
|||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Sprout v1.0 documentation" href="../index.html" />
|
||||
<link rel="up" title="Sprout C++ Libraries" href="index.html" />
|
||||
<link rel="next" title="Sprout.Algorithm" href="sprout/algorithm/index.html" />
|
||||
<link rel="next" title="Sprout.Array" href="sprout/array/index.html" />
|
||||
<link rel="prev" title="Sprout C++ Libraries" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="sprout/algorithm/index.html" title="Sprout.Algorithm"
|
||||
<a href="sprout/array/index.html" title="Sprout.Array"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Sprout C++ Libraries"
|
||||
|
|
@ -49,15 +49,25 @@
|
|||
|
||||
<div class="section" id="libraries">
|
||||
<h1>Libraries<a class="headerlink" href="#libraries" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="libraries-listed-alphabetically">
|
||||
<h2>Libraries Listed Alphabetically<a class="headerlink" href="#libraries-listed-alphabetically" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="sprout/algorithm/index.html"><em>algorithm</em></a> - STL like generic algorithms.</li>
|
||||
<li><a class="reference external" href="sprout/array/index.html"><em>array</em></a> - STL compliant class template for storing fixed-size sequences of objects.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="libraries-listed-by-category">
|
||||
<h2>Libraries Listed by Category<a class="headerlink" href="#libraries-listed-by-category" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="containers-and-data-structures">
|
||||
<h3>Containers and Data structures<a class="headerlink" href="#containers-and-data-structures" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="sprout/array/index.html"><em>array</em></a> - STL compliant class template for storing fixed-size sequences of objects.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="algorithms">
|
||||
<h3>Algorithms<a class="headerlink" href="#algorithms" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="sprout/algorithm/index.html"><em>algorithm</em></a> - STL-like generic algorithms.</li>
|
||||
<li><a class="reference external" href="sprout/algorithm/index.html"><em>algorithm</em></a> - STL like generic algorithms.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
|
|
@ -114,6 +124,7 @@
|
|||
<h3><a href="../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="#">Libraries</a><ul>
|
||||
<li><a class="reference external" href="#libraries-listed-alphabetically">Libraries Listed Alphabetically</a></li>
|
||||
<li><a class="reference external" href="#libraries-listed-by-category">Libraries Listed by Category</a><ul>
|
||||
<li><a class="reference external" href="#containers-and-data-structures">Containers and Data structures</a></li>
|
||||
<li><a class="reference external" href="#algorithms">Algorithms</a></li>
|
||||
|
|
@ -141,8 +152,8 @@
|
|||
<p class="topless"><a href="index.html"
|
||||
title="previous chapter">Sprout C++ Libraries</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="sprout/algorithm/index.html"
|
||||
title="next chapter">Sprout.Algorithm</a></p>
|
||||
<p class="topless"><a href="sprout/array/index.html"
|
||||
title="next chapter">Sprout.Array</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/libs/libraries.txt"
|
||||
|
|
@ -172,7 +183,7 @@
|
|||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="sprout/algorithm/index.html" title="Sprout.Algorithm"
|
||||
<a href="sprout/array/index.html" title="Sprout.Array"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Sprout C++ Libraries"
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
<link rel="top" title="Sprout v1.0 documentation" href="../../../index.html" />
|
||||
<link rel="up" title="Libraries" href="../../libraries.html" />
|
||||
<link rel="next" title="all_of" href="all_of.html" />
|
||||
<link rel="prev" title="Libraries" href="../../libraries.html" />
|
||||
<link rel="prev" title="Class template array" href="../array/array/index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
<a href="all_of.html" title="all_of"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../../libraries.html" title="Libraries"
|
||||
<a href="../array/array/index.html" title="Class template array"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../../../index.html">Sprout v1.0 documentation</a> »</li>
|
||||
<li><a href="../../index.html" >Sprout C++ Libraries</a> »</li>
|
||||
|
|
@ -58,6 +58,10 @@
|
|||
<li><a class="reference external" href="none_of.html"><em>none_of</em></a></li>
|
||||
<li><a class="reference external" href="one_of.html"><em>one_of</em></a></li>
|
||||
</ul>
|
||||
<div class="section" id="header">
|
||||
<h3>Header<a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h3>
|
||||
<p><tt class="docutils literal"><span class="pre">sprout/algorithm.hpp</span></tt></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -70,14 +74,17 @@
|
|||
<h3><a href="../../../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="#">Sprout.Algorithm</a><ul>
|
||||
<li><a class="reference external" href="#non-modifying-sequence-operations">Non-modifying sequence operations</a></li>
|
||||
<li><a class="reference external" href="#non-modifying-sequence-operations">Non-modifying sequence operations</a><ul>
|
||||
<li><a class="reference external" href="#header">Header</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../../libraries.html"
|
||||
title="previous chapter">Libraries</a></p>
|
||||
<p class="topless"><a href="../array/array/index.html"
|
||||
title="previous chapter">Class template array</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="all_of.html"
|
||||
title="next chapter">all_of</a></p>
|
||||
|
|
@ -113,7 +120,7 @@
|
|||
<a href="all_of.html" title="all_of"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../../libraries.html" title="Libraries"
|
||||
<a href="../array/array/index.html" title="Class template array"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../../../index.html">Sprout v1.0 documentation</a> »</li>
|
||||
<li><a href="../../index.html" >Sprout C++ Libraries</a> »</li>
|
||||
|
|
|
|||
267
docs/libs/sprout/array/array/index.html
Normal file
267
docs/libs/sprout/array/array/index.html
Normal file
|
|
@ -0,0 +1,267 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Class template array — Sprout v1.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../../../../',
|
||||
VERSION: '1.0',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
|
||||
<link rel="top" title="Sprout v1.0 documentation" href="../../../../index.html" />
|
||||
<link rel="up" title="Sprout.Array" href="../index.html" />
|
||||
<link rel="next" title="Sprout.Algorithm" href="../../algorithm/index.html" />
|
||||
<link rel="prev" title="Sprout.Array" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../../../../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../../algorithm/index.html" title="Sprout.Algorithm"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../index.html" title="Sprout.Array"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../../../../index.html">Sprout v1.0 documentation</a> »</li>
|
||||
<li><a href="../../../index.html" >Sprout C++ Libraries</a> »</li>
|
||||
<li><a href="../../../libraries.html" >Libraries</a> »</li>
|
||||
<li><a href="../index.html" accesskey="U">Sprout.Array</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="class-template-array">
|
||||
<h1>Class template array<a class="headerlink" href="#class-template-array" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="interface">
|
||||
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span> <span class="o"><</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">></span>
|
||||
<span class="k">class</span> <span class="nc">array</span> <span class="p">{</span>
|
||||
<span class="c1">// types:</span>
|
||||
<span class="k">typedef</span> <span class="n">T</span><span class="o">&</span> <span class="n">reference</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">T</span> <span class="k">const</span><span class="o">&</span> <span class="n">const_reference</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="cm">/*implementation-defined*/</span> <span class="n">iterator</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="cm">/*implementation-defined*/</span> <span class="n">const_iterator</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">size_type</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">std</span><span class="o">::</span><span class="n">ptrdiff_t</span> <span class="n">difference_type</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">T</span> <span class="n">value_type</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">T</span><span class="o">*</span> <span class="n">pointer</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">T</span> <span class="k">const</span><span class="o">*</span> <span class="n">const_pointer</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">sprout</span><span class="o">::</span><span class="n">reverse_iterator</span><span class="o"><</span><span class="n">iterator</span><span class="o">></span> <span class="n">reverse_iterator</span><span class="p">;</span>
|
||||
<span class="k">typedef</span> <span class="n">sprout</span><span class="o">::</span><span class="n">reverse_iterator</span><span class="o"><</span><span class="n">const_iterator</span><span class="o">></span> <span class="n">const_reverse_iterator</span><span class="p">;</span>
|
||||
|
||||
<span class="c1">// constants:</span>
|
||||
<span class="n">SPROUT_STATIC_CONSTEXPR</span> <span class="n">size_type</span> <span class="n">static_size</span> <span class="o">=</span> <span class="n">N</span><span class="p">;</span>
|
||||
|
||||
<span class="n">T</span> <span class="n">elems</span><span class="p">[</span><span class="n">N</span> <span class="o">?</span> <span class="n">N</span> <span class="o">:</span> <span class="mi">1</span><span class="p">];</span> <span class="c1">// exposition only</span>
|
||||
|
||||
<span class="c1">// construct/copy/destroy:</span>
|
||||
<span class="k">template</span><span class="o"><</span><span class="k">typename</span> <span class="n">T2</span><span class="o">></span>
|
||||
<span class="n">array</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">array</span><span class="o"><</span><span class="n">T2</span><span class="p">,</span> <span class="n">N</span><span class="o">></span> <span class="k">const</span><span class="o">&</span> <span class="n">rhs</span><span class="p">);</span>
|
||||
<span class="k">template</span><span class="o"><</span><span class="k">typename</span> <span class="n">T2</span><span class="o">></span>
|
||||
<span class="n">array</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">array</span><span class="o"><</span><span class="n">T2</span><span class="p">,</span> <span class="n">N</span><span class="o">>&&</span> <span class="n">rhs</span><span class="p">);</span>
|
||||
|
||||
<span class="c1">// modifiers:</span>
|
||||
<span class="kt">void</span> <span class="n">fill</span><span class="p">(</span><span class="n">const_reference</span> <span class="n">u</span><span class="p">);</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">array</span> <span class="n">fill</span><span class="p">(</span><span class="n">const_reference</span> <span class="n">value</span><span class="p">)</span> <span class="k">const</span><span class="p">;</span>
|
||||
<span class="kt">void</span> <span class="n">assign</span><span class="p">(</span><span class="n">const_reference</span> <span class="n">value</span><span class="p">);</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">array</span> <span class="n">assign</span><span class="p">(</span><span class="n">const_reference</span> <span class="n">value</span><span class="p">)</span> <span class="k">const</span><span class="p">;</span>
|
||||
<span class="kt">void</span> <span class="n">swap</span><span class="p">(</span><span class="n">array</span><span class="o">&</span><span class="p">)</span> <span class="n">SPROUT_NOEXCEPT_EXPR</span><span class="p">(</span><span class="n">SPROUT_NOEXCEPT_EXPR</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">swap</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">declval</span><span class="o"><</span><span class="n">T</span><span class="o">&></span><span class="p">(),</span> <span class="n">std</span><span class="o">::</span><span class="n">declval</span><span class="o"><</span><span class="n">T</span><span class="o">&></span><span class="p">())));</span>
|
||||
|
||||
<span class="c1">// iterators:</span>
|
||||
<span class="n">iterator</span> <span class="n">begin</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_iterator</span> <span class="n">begin</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">iterator</span> <span class="n">end</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_iterator</span> <span class="n">end</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">reverse_iterator</span> <span class="n">rbegin</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reverse_iterator</span> <span class="n">rbegin</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">reverse_iterator</span> <span class="n">rend</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reverse_iterator</span> <span class="n">rend</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_iterator</span> <span class="n">cbegin</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_iterator</span> <span class="n">cend</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reverse_iterator</span> <span class="n">crbegin</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reverse_iterator</span> <span class="n">crend</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
|
||||
<span class="c1">// capacity:</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">size_type</span> <span class="n">size</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">size_type</span> <span class="n">max_size</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="kt">bool</span> <span class="n">empty</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
|
||||
<span class="c1">// element access:</span>
|
||||
<span class="n">reference</span> <span class="k">operator</span><span class="p">[](</span><span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reference</span> <span class="k">operator</span><span class="p">[](</span><span class="n">size_type</span> <span class="n">n</span><span class="p">)</span> <span class="k">const</span><span class="p">;</span>
|
||||
<span class="n">reference</span> <span class="n">at</span><span class="p">(</span><span class="n">size_type</span> <span class="n">n</span><span class="p">);</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reference</span> <span class="n">at</span><span class="p">(</span><span class="n">size_type</span> <span class="n">n</span><span class="p">)</span> <span class="k">const</span><span class="p">;</span>
|
||||
<span class="n">reference</span> <span class="n">front</span><span class="p">();</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reference</span> <span class="n">front</span><span class="p">()</span> <span class="k">const</span><span class="p">;</span>
|
||||
<span class="n">reference</span> <span class="n">back</span><span class="p">();</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_reference</span> <span class="n">back</span><span class="p">()</span> <span class="k">const</span><span class="p">;</span>
|
||||
<span class="n">pointer</span> <span class="n">data</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_pointer</span> <span class="n">data</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">pointer</span> <span class="n">c_array</span><span class="p">()</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="n">SPROUT_CONSTEXPR</span> <span class="n">const_pointer</span> <span class="n">c_array</span><span class="p">()</span> <span class="k">const</span> <span class="n">SPROUT_NOEXCEPT</span><span class="p">;</span>
|
||||
<span class="p">};</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="member-functions">
|
||||
<h3>Member functions<a class="headerlink" href="#member-functions" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="initializer">
|
||||
<h4>(initializer)<a class="headerlink" href="#initializer" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">(initializer)</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="construct-copy-destroy">
|
||||
<h4>construct/copy/destroy<a class="headerlink" href="#construct-copy-destroy" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">operator=</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="modifiers">
|
||||
<h4>modifiers<a class="headerlink" href="#modifiers" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">fill</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">assign</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="iterators">
|
||||
<h4>iterators<a class="headerlink" href="#iterators" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">begin</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">end</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">rbegin</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">rend</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">cbegin</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">cend</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">crbegin</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">crend</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="capacity">
|
||||
<h4>capacity<a class="headerlink" href="#capacity" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">size</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">max_size</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">empty</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="element-access">
|
||||
<h4>element access<a class="headerlink" href="#element-access" title="Permalink to this headline">¶</a></h4>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">operator[]</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">at</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">front</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">back</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">data</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">c_array</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="header">
|
||||
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h2>
|
||||
<p><tt class="docutils literal"><span class="pre">sprout/array/array.hpp</span></tt></p>
|
||||
<p>Convenience header: <tt class="docutils literal"><span class="pre">sprout/array.hpp</span></tt></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="../../../../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="#">Class template array</a><ul>
|
||||
<li><a class="reference external" href="#interface">Interface</a></li>
|
||||
<li><a class="reference external" href="#description">Description</a><ul>
|
||||
<li><a class="reference external" href="#member-functions">Member functions</a><ul>
|
||||
<li><a class="reference external" href="#initializer">(initializer)</a></li>
|
||||
<li><a class="reference external" href="#construct-copy-destroy">construct/copy/destroy</a></li>
|
||||
<li><a class="reference external" href="#modifiers">modifiers</a></li>
|
||||
<li><a class="reference external" href="#iterators">iterators</a></li>
|
||||
<li><a class="reference external" href="#capacity">capacity</a></li>
|
||||
<li><a class="reference external" href="#element-access">element access</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference external" href="#header">Header</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../index.html"
|
||||
title="previous chapter">Sprout.Array</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../../algorithm/index.html"
|
||||
title="next chapter">Sprout.Algorithm</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../../../../_sources/libs/sprout/array/array/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../../../../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../../algorithm/index.html" title="Sprout.Algorithm"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../index.html" title="Sprout.Array"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../../../../index.html">Sprout v1.0 documentation</a> »</li>
|
||||
<li><a href="../../../index.html" >Sprout C++ Libraries</a> »</li>
|
||||
<li><a href="../../../libraries.html" >Libraries</a> »</li>
|
||||
<li><a href="../index.html" >Sprout.Array</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2013, Bolero MURAKAMI.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
152
docs/libs/sprout/array/index.html
Normal file
152
docs/libs/sprout/array/index.html
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Sprout.Array — Sprout v1.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../../../',
|
||||
VERSION: '1.0',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../../../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../../../_static/doctools.js"></script>
|
||||
<link rel="top" title="Sprout v1.0 documentation" href="../../../index.html" />
|
||||
<link rel="up" title="Libraries" href="../../libraries.html" />
|
||||
<link rel="next" title="Class template array" href="array/index.html" />
|
||||
<link rel="prev" title="Libraries" href="../../libraries.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../../../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="array/index.html" title="Class template array"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../../libraries.html" title="Libraries"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../../../index.html">Sprout v1.0 documentation</a> »</li>
|
||||
<li><a href="../../index.html" >Sprout C++ Libraries</a> »</li>
|
||||
<li><a href="../../libraries.html" accesskey="U">Libraries</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="id1">
|
||||
<h1>Sprout.Array<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="interface">
|
||||
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span> <span class="o"><</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">></span>
|
||||
<span class="k">class</span> <span class="nc">array</span><span class="p">;</span>
|
||||
|
||||
<span class="k">template</span><span class="o"><</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">></span>
|
||||
<span class="kr">inline</span> <span class="kt">void</span> <span class="n">swap</span><span class="p">(</span><span class="n">sprout</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">T</span><span class="p">,</span> <span class="n">N</span><span class="o">>&</span> <span class="n">lhs</span><span class="p">,</span> <span class="n">sprout</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">T</span><span class="p">,</span> <span class="n">N</span><span class="o">>&</span> <span class="n">rhs</span><span class="p">)</span> <span class="n">SPROUT_NOEXCEPT_EXPR</span><span class="p">(</span><span class="n">SPROUT_NOEXCEPT_EXPR</span><span class="p">(</span><span class="n">lhs</span><span class="p">.</span><span class="n">swap</span><span class="p">(</span><span class="n">rhs</span><span class="p">)));</span>
|
||||
|
||||
<span class="k">template</span><span class="o"><</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">></span>
|
||||
<span class="kr">inline</span> <span class="n">SPROUT_CONSTEXPR</span> <span class="n">sprout</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">T</span><span class="p">,</span> <span class="n">N</span><span class="o">></span> <span class="n">to_array</span><span class="p">(</span><span class="n">T</span> <span class="k">const</span> <span class="p">(</span><span class="o">&</span> <span class="n">arr</span><span class="p">)[</span><span class="n">N</span><span class="p">]);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="classes">
|
||||
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="array/index.html"><em>array</em></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="non-member-functions">
|
||||
<h2>Non-member functions<a class="headerlink" href="#non-member-functions" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><tt class="xref docutils literal"><span class="pre">swap</span></tt></li>
|
||||
<li><tt class="xref docutils literal"><span class="pre">to_array</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="header">
|
||||
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h2>
|
||||
<p><tt class="docutils literal"><span class="pre">sprout/array.hpp</span></tt></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="../../../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="#">Sprout.Array</a><ul>
|
||||
<li><a class="reference external" href="#interface">Interface</a></li>
|
||||
<li><a class="reference external" href="#classes">Classes</a></li>
|
||||
<li><a class="reference external" href="#non-member-functions">Non-member functions</a></li>
|
||||
<li><a class="reference external" href="#header">Header</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../../libraries.html"
|
||||
title="previous chapter">Libraries</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="array/index.html"
|
||||
title="next chapter">Class template array</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../../../_sources/libs/sprout/array/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../../../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="array/index.html" title="Class template array"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../../libraries.html" title="Libraries"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../../../index.html">Sprout v1.0 documentation</a> »</li>
|
||||
<li><a href="../../index.html" >Sprout C++ Libraries</a> »</li>
|
||||
<li><a href="../../libraries.html" >Libraries</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2013, Bolero MURAKAMI.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1 +1 @@
|
|||
Search.setIndex({desctypes:{},terms:{any_of:[0,2],all:7,less:7,sprout:[0,1,2,3,4,5,7],license_1_0:4,all_of:[0,7],through:4,content:1,onli:[5,4],miscellan:6,copyright:[1,4],bind2nd:[3,2,5,7],mathemat:6,under:4,mail:4,modul:1,applic:[3,2,5,7],non:0,random:4,"return":[3,2,5,7],greater:[3,2,5],murakami:4,fals:[3,2,5,7],auto:[3,2,5,7],clang:4,number:4,facebook:4,none_of:[0,3],recurs:[3,2,5,7],like:6,specif:6,list:6,synthes:[6,4],iter:[3,7,2,5,6],mode:4,contain:[3,2,4,5,6,7],path:4,page:[1,4],compil:[1,4],domain:6,twitter:4,see:4,result:[3,2,5,7],logn:[3,2,5,7],librari:[1,6,4],compat:6,index:1,slideshar:4,categori:6,version:4,net:4,boost:4,gener:6,static_assert:[3,2,5,7],constexpr:4,base:4,preprocessor:6,org:4,modifi:0,genyamurakami:4,search:1,last:[3,2,5,7],one_of:[0,5],com:4,licens:4,first:[3,2,5,7],oper:0,softwar:4,rang:[3,2,5,7],arrai:[3,2,5,7],genya:4,header:[3,2,5,7,4],linux:4,instal:[1,4],txt:4,inputiter:[3,2,5,7],blog:4,pred:[3,2,5,7],support:[1,6,4],empti:[3,2,5,7],websit:4,bolero_murakami:4,includ:[3,2,5,7],interfac:[3,2,5,7],conveni:[3,2,5,7],"function":[3,7,2,5,6],namespac:[3,2,5,7],copi:4,metaprogram:6,accompani:4,indic:1,input:[3,2,5,7],inlin:[3,2,5,7],"true":[3,2,5,7],than:[3,2,5,7],logarithm:[3,2,5,7],none:3,stl:6,structur:6,project:[1,4],sprout_constexpr:[3,2,5,7],can:4,www:4,otherwis:[3,2,5,7],invoc:[3,2,5,7],bolero:4,"int":[3,2,5,7],ani:2,templat:[3,7,2,5,6],rai:[6,4],hatena:4,file:4,tabl:1,everi:[3,7],gcc:4,end:[3,2,5,7],welcom:[1,4],lib:4,author:[1,4],hpp:[3,2,5,7],contact:4,other:4,complex:[3,2,5,7],bool:[3,2,5,7],document:1,begin:[3,2,5,7],http:4,distribut:4,trace:[6,4],sequenc:0,object:6,most:[3,2,5,7],typenam:[3,2,5,7],data:6,github:4,algorithm:[0,3,2,4,5,6,7],directori:4,predic:[3,2,5,7],depth:[3,2,5,7],exampl:[3,2,5,7],thi:4,pars:[6,4],sprout_static_constexpr:[3,2,5,7]},titles:["Sprout.Algorithm","Welcome to Sprout’s documentation!","any_of","none_of","Sprout C++ Libraries","one_of","Libraries","all_of"],modules:{},descrefs:{},filenames:["libs/sprout/algorithm/index","index","libs/sprout/algorithm/any_of","libs/sprout/algorithm/none_of","libs/index","libs/sprout/algorithm/one_of","libs/libraries","libs/sprout/algorithm/all_of"]})
|
||||
Search.setIndex({desctypes:{},terms:{typenam:[3,6,2,5,7,9],any_of:[0,2],all:9,sprout_noexcept_expr:[5,6],less:9,sprout:[0,1,2,3,4,5,6,7,9],random:4,rbegin:5,all_of:[0,9],through:4,size_t:[5,6],pointer:5,value_typ:5,content:1,onli:[5,7,4],"const":[5,6],miscellan:8,copyright:[1,4],fix:8,blog:4,mathemat:8,swap:[5,6],under:4,mail:4,arrai:[3,6,2,5,7,8,9],applic:[3,2,7,9],non:[0,6],license_1_0:4,"return":[3,2,7,9],greater:[3,2,7],murakami:4,fals:[3,2,7,9],auto:[3,2,7,9],"void":[5,6],clang:4,number:4,facebook:4,front:5,none_of:[0,3],recurs:[3,2,7,9],like:8,specif:8,list:8,synthes:[8,4],iter:[3,2,5,7,8,9],mode:4,contain:[3,2,4,7,8,9],path:4,page:[1,4],compil:[1,4],domain:8,twitter:4,back:5,predic:[3,2,7,9],logarithm:[3,2,7,9],see:4,result:[3,2,7,9],logn:[3,2,7,9],librari:[1,8,4],compat:8,index:1,slideshar:4,categori:8,version:4,const_point:5,net:4,size:[5,8],boost:4,refer:5,gener:8,static_assert:[3,2,7,9],cbegin:5,constexpr:4,base:4,preprocessor:8,org:4,modifi:[0,5],genyamurakami:4,valu:5,search:1,last:[3,2,7,9],arr:6,most:[3,2,7,9],ptrdiff_t:5,implement:5,com:4,support:[1,8,4],first:[3,2,7,9],oper:[0,5],softwar:4,rang:[3,2,7,9],declval:5,can:4,modul:1,genya:4,header:[0,3,2,4,6,7,5,9],empti:[3,5,2,7,9],linux:4,instal:[1,4],txt:4,inputiter:[3,2,7,9],bind2nd:[3,2,7,9],pred:[3,2,7,9],licens:4,contact:4,capac:5,construct:5,"class":[5,6,8],websit:4,compliant:8,bolero_murakami:4,includ:[3,2,7,9],interfac:[3,6,2,5,7,9],conveni:[3,5,2,7,9],type:5,const_reverse_iter:5,cend:5,"function":[3,6,2,5,7,8,9],namespac:[3,2,7,9],copi:[5,4],metaprogram:8,accompani:4,indic:1,c_arrai:5,input:[3,2,7,9],inlin:[3,6,2,7,9],"true":[3,2,7,9],than:[3,2,7,9],std:[5,6],none:3,stl:8,access:5,structur:8,project:[1,4],defin:5,sprout_constexpr:[3,6,2,5,7,9],store:8,www:4,crend:5,otherwis:[3,2,7,9],invoc:[3,2,7,9],bolero:4,constant:5,rend:5,"int":[3,2,7,9],to_arrai:6,ani:2,templat:[3,6,2,5,7,8,9],rai:[8,4],typedef:5,hatena:4,file:4,tabl:1,everi:[3,9],element:5,exposit:5,fill:5,gcc:4,end:[3,5,2,7,9],welcom:[1,4],lib:4,author:[1,4],alphabet:8,hpp:[0,3,2,6,7,5,9],static_s:5,data:[5,8],member:[5,6],other:4,complex:[3,2,7,9],bool:[3,5,2,7,9],difference_typ:5,document:1,const_refer:5,sprout_noexcept:5,begin:[3,5,2,7,9],http:4,distribut:4,trace:[8,4],sequenc:[0,8],object:8,size_typ:5,initi:5,max_siz:5,crbegin:5,const_iter:5,one_of:[0,7],github:4,algorithm:[0,3,2,4,7,8,9],reverse_iter:5,directori:4,descript:5,elem:5,assign:5,depth:[3,2,7,9],exampl:[3,2,7,9],thi:4,destroi:5,pars:[8,4],sprout_static_constexpr:[3,5,2,7,9]},titles:["Sprout.Algorithm","Welcome to Sprout’s documentation!","any_of","none_of","Sprout C++ Libraries","Class template array","Sprout.Array","one_of","Libraries","all_of"],modules:{},descrefs:{},filenames:["libs/sprout/algorithm/index","index","libs/sprout/algorithm/any_of","libs/sprout/algorithm/none_of","libs/index","libs/sprout/array/array/index","libs/sprout/array/index","libs/sprout/algorithm/one_of","libs/libraries","libs/sprout/algorithm/all_of"]})
|
||||
|
|
@ -6,8 +6,17 @@ Libraries
|
|||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
sprout/array/index
|
||||
sprout/algorithm/index
|
||||
|
||||
.. _sprout-listed_by_alphabetically:
|
||||
*******************************************************************************
|
||||
Libraries Listed Alphabetically
|
||||
*******************************************************************************
|
||||
|
||||
* :doc:`algorithm <./sprout/algorithm/index>` - STL like generic algorithms.
|
||||
* :doc:`array <./sprout/array/index>` - STL compliant class template for storing fixed-size sequences of objects.
|
||||
|
||||
.. _sprout-listed_by_category:
|
||||
*******************************************************************************
|
||||
Libraries Listed by Category
|
||||
|
|
@ -17,11 +26,13 @@ Libraries Listed by Category
|
|||
Containers and Data structures
|
||||
=======================================
|
||||
|
||||
* :doc:`array <./sprout/array/index>` - STL compliant class template for storing fixed-size sequences of objects.
|
||||
|
||||
.. _sprout-listed_by_category-algorithms:
|
||||
Algorithms
|
||||
=======================================
|
||||
|
||||
* :doc:`algorithm <./sprout/algorithm/index>` - STL-like generic algorithms.
|
||||
* :doc:`algorithm <./sprout/algorithm/index>` - STL like generic algorithms.
|
||||
|
||||
.. _sprout-listed_by_category-algorithms:
|
||||
Algorithms
|
||||
|
|
|
|||
|
|
@ -16,11 +16,13 @@ Sprout.Algorithm
|
|||
Non-modifying sequence operations
|
||||
*******************************************************************************
|
||||
|
||||
* :doc:`./all_of`
|
||||
* :doc:`all_of <./all_of>`
|
||||
* :doc:`any_of <./any_of>`
|
||||
* :doc:`none_of <./none_of>`
|
||||
* :doc:`one_of <./one_of>`
|
||||
|
||||
* :doc:`./any_of`
|
||||
Header
|
||||
========================================
|
||||
|
||||
* :doc:`./none_of`
|
||||
|
||||
* :doc:`./one_of`
|
||||
``sprout/algorithm.hpp``
|
||||
|
||||
|
|
|
|||
138
source/libs/sprout/array/array/index.rst
Normal file
138
source/libs/sprout/array/array/index.rst
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
.. _sprout-array-array:
|
||||
###############################################################################
|
||||
Class template array
|
||||
###############################################################################
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
Interface
|
||||
========================================
|
||||
.. sourcecode:: c++
|
||||
|
||||
template <typename T, std::size_t N>
|
||||
class array {
|
||||
// types:
|
||||
typedef T& reference;
|
||||
typedef T const& const_reference;
|
||||
typedef /*implementation-defined*/ iterator;
|
||||
typedef /*implementation-defined*/ const_iterator;
|
||||
typedef std::size_t size_type;
|
||||
typedef std::ptrdiff_t difference_type;
|
||||
typedef T value_type;
|
||||
typedef T* pointer;
|
||||
typedef T const* const_pointer;
|
||||
typedef sprout::reverse_iterator<iterator> reverse_iterator;
|
||||
typedef sprout::reverse_iterator<const_iterator> const_reverse_iterator;
|
||||
|
||||
// constants:
|
||||
SPROUT_STATIC_CONSTEXPR size_type static_size = N;
|
||||
|
||||
T elems[N ? N : 1]; // exposition only
|
||||
|
||||
// construct/copy/destroy:
|
||||
template<typename T2>
|
||||
array& operator=(array<T2, N> const& rhs);
|
||||
template<typename T2>
|
||||
array& operator=(array<T2, N>&& rhs);
|
||||
|
||||
// modifiers:
|
||||
void fill(const_reference u);
|
||||
SPROUT_CONSTEXPR array fill(const_reference value) const;
|
||||
void assign(const_reference value);
|
||||
SPROUT_CONSTEXPR array assign(const_reference value) const;
|
||||
void swap(array&) SPROUT_NOEXCEPT_EXPR(SPROUT_NOEXCEPT_EXPR(std::swap(std::declval<T&>(), std::declval<T&>())));
|
||||
|
||||
// iterators:
|
||||
iterator begin() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator begin() const SPROUT_NOEXCEPT;
|
||||
iterator end() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator end() const SPROUT_NOEXCEPT;
|
||||
reverse_iterator rbegin() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator rbegin() const SPROUT_NOEXCEPT;
|
||||
reverse_iterator rend() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator rend() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator cbegin() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_iterator cend() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator crbegin() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_reverse_iterator crend() const SPROUT_NOEXCEPT;
|
||||
|
||||
// capacity:
|
||||
SPROUT_CONSTEXPR size_type size() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR size_type max_size() const SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR bool empty() const SPROUT_NOEXCEPT;
|
||||
|
||||
// element access:
|
||||
reference operator[](size_type n);
|
||||
SPROUT_CONSTEXPR const_reference operator[](size_type n) const;
|
||||
reference at(size_type n);
|
||||
SPROUT_CONSTEXPR const_reference at(size_type n) const;
|
||||
reference front();
|
||||
SPROUT_CONSTEXPR const_reference front() const;
|
||||
reference back();
|
||||
SPROUT_CONSTEXPR const_reference back() const;
|
||||
pointer data() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_pointer data() const SPROUT_NOEXCEPT;
|
||||
pointer c_array() SPROUT_NOEXCEPT;
|
||||
SPROUT_CONSTEXPR const_pointer c_array() const SPROUT_NOEXCEPT;
|
||||
};
|
||||
|
||||
|
||||
Description
|
||||
========================================
|
||||
|
||||
Member functions
|
||||
----------------------------------------
|
||||
|
||||
(initializer)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`(initializer) <./array/initializer->`
|
||||
|
||||
construct/copy/destroy
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`operator= <./array/operator-assign>`
|
||||
|
||||
modifiers
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`fill <./array/fill>`
|
||||
* :doc:`assign <./array/assign>`
|
||||
|
||||
iterators
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`begin <./array/begin>`
|
||||
* :doc:`end <./array/end>`
|
||||
* :doc:`rbegin <./array/rbegin>`
|
||||
* :doc:`rend <./array/rend>`
|
||||
* :doc:`cbegin <./array/cbegin>`
|
||||
* :doc:`cend <./array/cend>`
|
||||
* :doc:`crbegin <./array/crbegin>`
|
||||
* :doc:`crend <./array/crend>`
|
||||
|
||||
capacity
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`size <./array/size>`
|
||||
* :doc:`max_size <./array/max_size>`
|
||||
* :doc:`empty <./array/empty>`
|
||||
|
||||
element access
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* :doc:`operator[] <./array/operator-subscript>`
|
||||
* :doc:`at <./array/at>`
|
||||
* :doc:`front <./array/front>`
|
||||
* :doc:`back <./array/back>`
|
||||
* :doc:`data <./array/data>`
|
||||
* :doc:`c_array <./array/c_array>`
|
||||
|
||||
Header
|
||||
========================================
|
||||
|
||||
``sprout/array/array.hpp``
|
||||
|
||||
Convenience header: ``sprout/array.hpp``
|
||||
|
||||
39
source/libs/sprout/array/index.rst
Normal file
39
source/libs/sprout/array/index.rst
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
.. _sprout-array:
|
||||
###############################################################################
|
||||
Sprout.Array
|
||||
###############################################################################
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
array/index
|
||||
|
||||
Interface
|
||||
========================================
|
||||
.. sourcecode:: c++
|
||||
|
||||
template <typename T, std::size_t N>
|
||||
class array;
|
||||
|
||||
template<typename T, std::size_t N>
|
||||
inline void swap(sprout::array<T, N>& lhs, sprout::array<T, N>& rhs) SPROUT_NOEXCEPT_EXPR(SPROUT_NOEXCEPT_EXPR(lhs.swap(rhs)));
|
||||
|
||||
template<typename T, std::size_t N>
|
||||
inline SPROUT_CONSTEXPR sprout::array<T, N> to_array(T const (& arr)[N]);
|
||||
|
||||
Classes
|
||||
========================================
|
||||
|
||||
* :doc:`array <./array/index>`
|
||||
|
||||
Non-member functions
|
||||
========================================
|
||||
|
||||
* :doc:`swap <./swap>`
|
||||
* :doc:`to_array <./to_array>`
|
||||
|
||||
Header
|
||||
========================================
|
||||
|
||||
``sprout/array.hpp``
|
||||
|
||||
Loading…
Add table
Reference in a new issue