libs/numeric/ublas/doc/html/classboost_1_1numeric_1_1ublas_1_1scalar__vector.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>ublas: boost::numeric::ublas::scalar_vector&lt; T, ALLOC &gt; Class Template Reference</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 </head>
   9 <body>
  10 <!-- Generated by Doxygen 1.6.1 -->
  11 <div class="navigation" id="top">
  12   <div class="tabs">
  13     <ul>
  14       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  17       <li><a href="files.html"><span>Files</span></a></li>
  18     </ul>
  19   </div>
  20   <div class="tabs">
  21     <ul>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><b>boost</b>::<b>numeric</b>::<b>ublas</b>::<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>boost::numeric::ublas::scalar_vector&lt; T, ALLOC &gt; Class Template Reference</h1><!-- doxytag: class="boost::numeric::ublas::scalar_vector" --><!-- doxytag: inherits="vector_container&lt; scalar_vector&lt; T, ALLOC &gt; &gt;" -->
  32 <p>A scalar (i.e. unique value) <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a> of type <code>T</code> and a given <code>size</code> A scalar (i.e. unique value) <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a> of type <code>T</code> and a given <code>size</code>. This is a virtual <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a> in the sense that no memory is allocated for storing the unique value more than once: it still acts like any other <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a>. However assigning a new value will change all the value at once. <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a> into a normal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a>. It must first be assigned to another normal <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a> by any suitable means. Its memory footprint is constant.
  33 <a href="#_details">More...</a></p>
  34
  35 <p>Inherits <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector__container.html">vector_container&lt; scalar_vector&lt; T, ALLOC &gt; &gt;</a>.</p>
  36
  37 <p><a href="classboost_1_1numeric_1_1ublas_1_1scalar__vector-members.html">List of all members.</a></p>
  38 <table border="0" cellpadding="0" cellspacing="0">
  39 <tr><td colspan="2"><h2>Classes</h2></td></tr>
  40 <tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector_1_1const__iterator.html">const_iterator</a></td></tr>
  41 <tr><td colspan="2"><h2>Public Types</h2></td></tr>
  42 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f59de9148cd19fd9c9e047d2df7c9b3"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::size_type" ref="a3f59de9148cd19fd9c9e047d2df7c9b3" args="" -->
  43 typedef ALLOC::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
  44 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ac3aca926b7ac85d26b74245265aca8"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::difference_type" ref="a1ac3aca926b7ac85d26b74245265aca8" args="" -->
  45 typedef ALLOC::difference_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
  46 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4abe24032ff1c77a13f588ddb6e631fc"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::value_type" ref="a4abe24032ff1c77a13f588ddb6e631fc" args="" -->
  47 typedef T&nbsp;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
  48 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa5cd51ee96ac10bf6f31a60c3a35d43"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::const_reference" ref="afa5cd51ee96ac10bf6f31a60c3a35d43" args="" -->
  49 typedef const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
  50 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfadb20f76e5ff8c6cc8188d4d6e59a1"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::reference" ref="abfadb20f76e5ff8c6cc8188d4d6e59a1" args="" -->
  51 typedef T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
  52 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac20e17d23fc178962102227fc0907d54"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::const_closure_type" ref="ac20e17d23fc178962102227fc0907d54" args="" -->
  53 typedef const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector__reference.html">vector_reference</a><br class="typebreak"/>
  54 &lt; const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">self_type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_closure_type</b></td></tr>
  55 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6863ed84b5f2802ff3a7497da200a04b"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::closure_type" ref="a6863ed84b5f2802ff3a7497da200a04b" args="" -->
  56 typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector__reference.html">vector_reference</a><br class="typebreak"/>
  57 &lt; <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">self_type</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>closure_type</b></td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e0aed7e2f1cc73b267def85d49234bf"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::storage_category" ref="a4e0aed7e2f1cc73b267def85d49234bf" args="" -->
  59 typedef <a class="el" href="structboost_1_1numeric_1_1ublas_1_1dense__tag.html">dense_tag</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>storage_category</b></td></tr>
  60 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a853fa75318e037846b40ae32dc336b96"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::iterator" ref="a853fa75318e037846b40ae32dc336b96" args="" -->
  61 typedef <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>iterator</b></td></tr>
  62 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cddf30eb51038908a89ee83fe736a63"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::const_reverse_iterator" ref="a9cddf30eb51038908a89ee83fe736a63" args="" -->
  63 typedef reverse_iterator_base<br class="typebreak"/>
  64 &lt; <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector_1_1const__iterator.html">const_iterator</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_reverse_iterator</b></td></tr>
  65 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  66 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace1b2c763e6ee934a1e89475f4faad3c"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::scalar_vector" ref="ace1b2c763e6ee934a1e89475f4faad3c" args="(size_type size, const value_type &amp;value=value_type(1))" -->
  67 BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>scalar_vector</b> (size_type size, const value_type &amp;value=value_type(1))</td></tr>
  68 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6d6e3a70872e6f1fb2ba3dc386feb58"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::scalar_vector" ref="ae6d6e3a70872e6f1fb2ba3dc386feb58" args="(const scalar_vector &amp;v)" -->
  69 BOOST_UBLAS_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><b>scalar_vector</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;v)</td></tr>
  70 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42005788b88036a300b6fa1f6ab5c3b7"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::size" ref="a42005788b88036a300b6fa1f6ab5c3b7" args="() const " -->
  71 BOOST_UBLAS_INLINE size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> () const </td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a402be9dd846ee5d5e27e05b30cd2026a"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::resize" ref="a402be9dd846ee5d5e27e05b30cd2026a" args="(size_type size, bool=true)" -->
  73 BOOST_UBLAS_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><b>resize</b> (size_type size, bool=true)</td></tr>
  74 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31c9fb999575c82d2610d916ce4c586f"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::find_element" ref="a31c9fb999575c82d2610d916ce4c586f" args="(size_type) const " -->
  75 BOOST_UBLAS_INLINE const_pointer&nbsp;</td><td class="memItemRight" valign="bottom"><b>find_element</b> (size_type) const </td></tr>
  76 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fb363048a8931a622ff143a2e4277e9"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::operator()" ref="a8fb363048a8931a622ff143a2e4277e9" args="(size_type) const " -->
  77 BOOST_UBLAS_INLINE const_reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (size_type) const </td></tr>
  78 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f794040baba8d3ecface509d4df3386"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::operator[]" ref="a9f794040baba8d3ecface509d4df3386" args="(size_type) const " -->
  79 BOOST_UBLAS_INLINE const_reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (size_type) const </td></tr>
  80 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72f2abd66c47897bf8eb449201c5a475"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::operator=" ref="a72f2abd66c47897bf8eb449201c5a475" args="(const scalar_vector &amp;v)" -->
  81 BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;v)</td></tr>
  82 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa42ddab2112cebd8a646ef7d59236a1b"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::assign_temporary" ref="aa42ddab2112cebd8a646ef7d59236a1b" args="(scalar_vector &amp;v)" -->
  83 BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>assign_temporary</b> (<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;v)</td></tr>
  84 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1d02dc22090a5e8d3f9bff62e3c1ca"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::swap" ref="a3b1d02dc22090a5e8d3f9bff62e3c1ca" args="(scalar_vector &amp;v)" -->
  85 BOOST_UBLAS_INLINE void&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;v)</td></tr>
  86 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d9c8a1603340a9be87af509ee433a57"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::find" ref="a8d9c8a1603340a9be87af509ee433a57" args="(size_type i) const " -->
  87 BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>find</b> (size_type i) const </td></tr>
  88 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41d8bd2613c4c7e91d0088bc742ad1fc"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::begin" ref="a41d8bd2613c4c7e91d0088bc742ad1fc" args="() const " -->
  89 BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const </td></tr>
  90 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe649bf35f6c5aaf5b4dc06da3521a80"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::end" ref="abe649bf35f6c5aaf5b4dc06da3521a80" args="() const " -->
  91 BOOST_UBLAS_INLINE <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector_1_1const__iterator.html">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>end</b> () const </td></tr>
  92 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d013c961a8cc082cc0d2bd8b5d4ed0"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::rbegin" ref="a67d013c961a8cc082cc0d2bd8b5d4ed0" args="() const " -->
  93 BOOST_UBLAS_INLINE <br class="typebreak"/>
  94 const_reverse_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>rbegin</b> () const </td></tr>
  95 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf7e5abead47b14151c7ed60f09f96f3"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::rend" ref="adf7e5abead47b14151c7ed60f09f96f3" args="() const " -->
  96 BOOST_UBLAS_INLINE <br class="typebreak"/>
  97 const_reverse_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>rend</b> () const </td></tr>
  98 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a6b354fd766d6601b1a878b1ccbd712e8"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::serialize" ref="a6b354fd766d6601b1a878b1ccbd712e8" args="(Archive &amp;ar, const unsigned int)" -->
  99 template&lt;class Archive &gt; </td></tr>
 100 <tr><td class="memTemplItemLeft" align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>serialize</b> (Archive &amp;ar, const unsigned int)</td></tr>
 101 <tr><td colspan="2"><h2>Friends</h2></td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7af3655b93716bb1a0c26f23f3a330d9"></a><!-- doxytag: member="boost::numeric::ublas::scalar_vector::swap" ref="a7af3655b93716bb1a0c26f23f3a330d9" args="(scalar_vector &amp;v1, scalar_vector &amp;v2)" -->
 103 BOOST_UBLAS_INLINE friend void&nbsp;</td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;v1, <a class="el" href="classboost_1_1numeric_1_1ublas_1_1scalar__vector.html">scalar_vector</a> &amp;v2)</td></tr>
 104 </table>
 105 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 106 <h3>template&lt;class T, class ALLOC&gt;<br/>
 107  class boost::numeric::ublas::scalar_vector&lt; T, ALLOC &gt;</h3>
 108
 109 <dl><dt><b>Template Parameters:</b></dt><dd>
 110   <table border="0" cellspacing="2" cellpadding="0">
 111     <tr><td valign="top"></td><td valign="top"><em>T</em>&nbsp;</td><td>type of the objects stored in the <a class="el" href="classboost_1_1numeric_1_1ublas_1_1vector.html" title="A dense vector of values of type T.">vector</a>: it can be anything even if most of the time, scalar types will be used like <code>double</code> or <code>int</code>. Complex types can be used, or even classes like boost::interval. </td></tr>
 112   </table>
 113   </dd>
 114 </dl>
 115 </div>
 116 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Jul 4 20:31:07 2010 for ublas by&nbsp;
 117 <a href="http://www.doxygen.org/index.html">
 118 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
 119 </body>
 120 </html>