]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <html> |
2 | <head> | |
3 | <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> | |
4 | <title>rank</title> | |
5 | <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> | |
6 | <meta name="generator" content="DocBook XSL Stylesheets V1.77.1"> | |
7 | <link rel="home" href="../../index.html" title="Chapter 1. Boost.TypeTraits"> | |
8 | <link rel="up" href="../reference.html" title="Alphabetical Reference"> | |
9 | <link rel="prev" href="promote.html" title="promote"> | |
10 | <link rel="next" href="remove_all_extents.html" title="remove_all_extents"> | |
11 | </head> | |
12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> | |
13 | <table cellpadding="2" width="100%"><tr> | |
14 | <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> | |
15 | <td align="center"><a href="../../../../../../index.html">Home</a></td> | |
16 | <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> | |
17 | <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> | |
18 | <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> | |
19 | <td align="center"><a href="../../../../../../more/index.htm">More</a></td> | |
20 | </tr></table> | |
21 | <hr> | |
22 | <div class="spirit-nav"> | |
23 | <a accesskey="p" href="promote.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_all_extents.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> | |
24 | </div> | |
25 | <div class="section"> | |
26 | <div class="titlepage"><div><div><h3 class="title"> | |
27 | <a name="boost_typetraits.reference.rank"></a><a class="link" href="rank.html" title="rank">rank</a> | |
28 | </h3></div></div></div> | |
29 | <pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> | |
30 | <span class="keyword">struct</span> <span class="identifier">rank</span> <span class="special">:</span> <span class="keyword">public</span> <a class="link" href="integral_constant.html" title="integral_constant">integral_constant</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">RANK</span><span class="special">(</span><span class="identifier">T</span><span class="special">)></span> <span class="special">{};</span> | |
31 | </pre> | |
32 | <p> | |
33 | <span class="bold"><strong>Inherits:</strong></span> Class template rank inherits from | |
34 | <code class="computeroutput"><a class="link" href="integral_constant.html" title="integral_constant">integral_constant</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">RANK</span><span class="special">(</span><span class="identifier">T</span><span class="special">)></span></code>, | |
35 | where <code class="computeroutput"><span class="identifier">RANK</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span></code> is the | |
36 | number of array dimensions in type <code class="computeroutput"><span class="identifier">T</span></code>. | |
37 | </p> | |
38 | <p> | |
39 | If <code class="computeroutput"><span class="identifier">T</span></code> is not a (built-in) | |
40 | array type, then <code class="computeroutput"><span class="identifier">RANK</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span></code> is zero. | |
41 | </p> | |
42 | <p> | |
43 | <span class="bold"><strong>Compiler Compatibility:</strong></span> All current compilers | |
44 | are supported by this trait. | |
45 | </p> | |
46 | <p> | |
47 | <span class="bold"><strong>Header:</strong></span> <code class="computeroutput"> <span class="preprocessor">#include</span> | |
48 | <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">type_traits</span><span class="special">/</span><span class="identifier">rank</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> | |
49 | or <code class="computeroutput"> <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">type_traits</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> | |
50 | </p> | |
51 | <p> | |
52 | <span class="bold"><strong>Examples:</strong></span> | |
53 | </p> | |
54 | <div class="blockquote"><blockquote class="blockquote"><p> | |
55 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="keyword">int</span><span class="special">[]></span></code> | |
56 | inherits from <code class="computeroutput"><a class="link" href="integral_constant.html" title="integral_constant">integral_constant</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="number">1</span><span class="special">></span></code>. | |
57 | </p></blockquote></div> | |
58 | <div class="blockquote"><blockquote class="blockquote"><p> | |
59 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="keyword">double</span><span class="special">[</span><span class="number">2</span><span class="special">][</span><span class="number">3</span><span class="special">][</span><span class="number">4</span><span class="special">]>::</span><span class="identifier">type</span></code> is the type <code class="computeroutput"><a class="link" href="integral_constant.html" title="integral_constant">integral_constant</a><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="number">3</span><span class="special">></span></code>. | |
60 | </p></blockquote></div> | |
61 | <div class="blockquote"><blockquote class="blockquote"><p> | |
62 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="keyword">int</span><span class="special">[</span><span class="number">1</span><span class="special">]>::</span><span class="identifier">value</span></code> | |
63 | is an integral constant expression that evaluates to <span class="emphasis"><em>1</em></span>. | |
64 | </p></blockquote></div> | |
65 | <div class="blockquote"><blockquote class="blockquote"><p> | |
66 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="keyword">int</span><span class="special">[][</span><span class="number">2</span><span class="special">]>::</span><span class="identifier">value</span></code> | |
67 | is an integral constant expression that evaluates to <span class="emphasis"><em>2</em></span>. | |
68 | </p></blockquote></div> | |
69 | <div class="blockquote"><blockquote class="blockquote"><p> | |
70 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="keyword">int</span><span class="special">*>::</span><span class="identifier">value</span></code> is an integral constant expression | |
71 | that evaluates to <span class="emphasis"><em>0</em></span>. | |
72 | </p></blockquote></div> | |
73 | <div class="blockquote"><blockquote class="blockquote"><p> | |
74 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="number">3</span><span class="special">></span> <span class="special">>::</span><span class="identifier">value</span></code> is an integral constant expression | |
75 | that evaluates to <span class="emphasis"><em>0</em></span>: <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span></code> | |
76 | is a class type and <span class="bold"><strong>not an array type</strong></span>! | |
77 | </p></blockquote></div> | |
78 | <div class="blockquote"><blockquote class="blockquote"><p> | |
79 | <code class="computeroutput"><span class="identifier">rank</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">value_type</span></code> is the type <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span></code>. | |
80 | </p></blockquote></div> | |
81 | </div> | |
82 | <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> | |
83 | <td align="left"></td> | |
84 | <td align="right"><div class="copyright-footer">Copyright © 2000, 2011 Adobe Systems Inc, David Abrahams, | |
85 | Frederic Bron, Steve Cleary, Beman Dawes, Aleksey Gurtovoy, Howard Hinnant, | |
86 | Jesse Jones, Mat Marcus, Itay Maman, John Maddock, Alexander Nasonov, Thorsten | |
87 | Ottosen, Roman Perepelitsa, Robert Ramey, Jeremy Siek, Robert Stewart and Steven | |
88 | Watanabe<p> | |
89 | Distributed under the Boost Software License, Version 1.0. (See accompanying | |
90 | file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) | |
91 | </p> | |
92 | </div></td> | |
93 | </tr></table> | |
94 | <hr> | |
95 | <div class="spirit-nav"> | |
96 | <a accesskey="p" href="promote.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove_all_extents.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> | |
97 | </div> | |
98 | </body> | |
99 | </html> |