diff options
author | Chris Lattner <sabre@nondot.org> | 2005-04-25 17:34:15 +0000 |
---|---|---|
committer | Chris Lattner <sabre@nondot.org> | 2005-04-25 17:34:15 +0000 |
commit | 37b6b097ff30daf3f8152f7da57b12fcefd0883c (patch) | |
tree | 373ffddf5d345bce9b38703b1f028dff0147c3ba | |
parent | d1039cc5817f32b6d8c01b2a659928014ad45c90 (diff) | |
download | llvm-37b6b097ff30daf3f8152f7da57b12fcefd0883c.zip llvm-37b6b097ff30daf3f8152f7da57b12fcefd0883c.tar.gz llvm-37b6b097ff30daf3f8152f7da57b12fcefd0883c.tar.bz2 |
document 'opaque' types
llvm-svn: 21535
-rw-r--r-- | llvm/docs/LangRef.html | 44 |
1 files changed, 43 insertions, 1 deletions
diff --git a/llvm/docs/LangRef.html b/llvm/docs/LangRef.html index 3cf3b0e..0c5346a 100644 --- a/llvm/docs/LangRef.html +++ b/llvm/docs/LangRef.html @@ -39,6 +39,7 @@ <li><a href="#t_pointer">Pointer Type</a></li> <li><a href="#t_struct">Structure Type</a></li> <li><a href="#t_packed">Packed Type</a></li> + <li><a href="#t_opaque">Opaque Type</a></li> </ol> </li> </ol> @@ -750,18 +751,27 @@ reference to another object, which must live in memory.</p> <!-- _______________________________________________________________________ --> <div class="doc_subsubsection"> <a name="t_packed">Packed Type</a> </div> <div class="doc_text"> + <h5>Overview:</h5> + <p>A packed type is a simple derived type that represents a vector of elements. Packed types are used when multiple primitive data are operated in parallel using a single instruction (SIMD). A packed type requires a size (number of elements) and an underlying primitive data type. Packed types are considered <a href="#t_firstclass">first class</a>.</p> + <h5>Syntax:</h5> -<pre> < <# elements> x <elementtype> ><br></pre> + +<pre> + < <# elements> x <elementtype> > +</pre> + <p>The number of elements is a constant integer value, elementtype may be any integral or floating point type.</p> + <h5>Examples:</h5> + <table class="layout"> <tr class="layout"> <td class="left"> @@ -778,6 +788,38 @@ be any integral or floating point type.</p> </table> </div> +<!-- _______________________________________________________________________ --> +<div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div> +<div class="doc_text"> + +<h5>Overview:</h5> + +<p>Opaque types are used to represent unknown types in the system. This +corresponds (for example) to the C notion of a foward declared structure type. +In LLVM, opaque types can eventually be resolved to any type (not just a +structure type).</p> + +<h5>Syntax:</h5> + +<pre> + opaque +</pre> + +<h5>Examples:</h5> + +<table class="layout"> + <tr class="layout"> + <td class="left"> + <tt>opaque</tt> + </td> + <td class="left"> + An opaque type.<br/> + </td> + </tr> +</table> +</div> + + <!-- *********************************************************************** --> <div class="doc_section"> <a name="constants">Constants</a> </div> <!-- *********************************************************************** --> |