Repository : ssh://darcs.haskell.org//srv/darcs/ghc On branch : ghc-7.6
http://hackage.haskell.org/trac/ghc/changeset/09c9b1058758c902139dec25823eecb2c93d7f99 >--------------------------------------------------------------- commit 09c9b1058758c902139dec25823eecb2c93d7f99 Author: Austin Seipp <[email protected]> Date: Sun Aug 5 15:06:33 2012 -0500 Update 'unboxed tuples' section of users guide. In particular, many of the restrictions on using unboxed tuples went away thanks to Max Bolingbroke, and they can now be bound to variables without pattern matching, and passed as arguments. Also fix a little formatting in glasgow-exts.xml. Some other parts of this section may be out of date. Signed-off-by: Austin Seipp <[email protected]> MERGED from commit 7473c3d291742175e2e2a4ba98f0c1dba5393599 >--------------------------------------------------------------- docs/users_guide/glasgow_exts.xml | 52 ++++++++++--------------------------- 1 files changed, 14 insertions(+), 38 deletions(-) diff --git a/docs/users_guide/glasgow_exts.xml b/docs/users_guide/glasgow_exts.xml index dde235e..8702758 100644 --- a/docs/users_guide/glasgow_exts.xml +++ b/docs/users_guide/glasgow_exts.xml @@ -71,17 +71,18 @@ documentation</ulink> describes all the libraries that come with GHC. <para>GHC is built on a raft of primitive data types and operations; "primitive" in the sense that they cannot be defined in Haskell itself. While you really can use this stuff to write fast code, - we generally find it a lot less painful, and more satisfying in the - long run, to use higher-level language features and libraries. With - any luck, the code you write will be optimised to the efficient - unboxed version in any case. And if it isn't, we'd like to know - about it.</para> +we generally find it a lot less painful, and more satisfying in the +long run, to use higher-level language features and libraries. With +any luck, the code you write will be optimised to the efficient +unboxed version in any case. And if it isn't, we'd like to know +about it.</para> <para>All these primitive data types and operations are exported by the library <literal>GHC.Prim</literal>, for which there is <ulink url="&libraryGhcPrimLocation;/GHC-Prim.html">detailed online documentation</ulink>. (This documentation is generated from the file <filename>compiler/prelude/primops.txt.pp</filename>.) </para> + <para> If you want to mention any of the primitive data types or operations in your program, you must first import <literal>GHC.Prim</literal> to bring them @@ -94,8 +95,7 @@ and <link linkend="unboxed-tuples">unboxed tuples</link>, which we briefly summarise here. </para> <sect2 id="glasgow-unboxed"> -<title>Unboxed types -</title> +<title>Unboxed types</title> <para> <indexterm><primary>Unboxed types (Glasgow extension)</primary></indexterm> @@ -202,8 +202,7 @@ since <literal>b</literal> has type <literal>Int#</literal>. </sect2> <sect2 id="unboxed-tuples"> -<title>Unboxed Tuples -</title> +<title>Unboxed tuples</title> <para> Unboxed tuples aren't really exported by <literal>GHC.Exts</literal>; @@ -238,46 +237,19 @@ tuples to avoid unnecessary allocation during sequences of operations. </para> <para> -There are some pretty stringent restrictions on the use of unboxed tuples: +There are some restrictions on the use of unboxed tuples: <itemizedlist> -<listitem> +<listitem> <para> Values of unboxed tuple types are subject to the same restrictions as other unboxed types; i.e. they may not be stored in polymorphic data structures or passed to polymorphic functions. - </para> </listitem> -<listitem> -<para> -No variable can have an unboxed tuple type, nor may a constructor or function -argument have an unboxed tuple type. The following are all illegal: -<programlisting> - data Foo = Foo (# Int, Int #) - - f :: (# Int, Int #) -> (# Int, Int #) - f x = x - - g :: (# Int, Int #) -> Int - g (# a,b #) = a - - h x = let y = (# x,x #) in ... -</programlisting> -</para> -</listitem> <listitem> <para> -Unboxed tuples may not be nested. So this is illegal: -<programlisting> -f :: (# Int, (# Int, Int #), Bool #) -</programlisting> -</para> -</listitem> -</itemizedlist> -</para> -<para> The typical use of unboxed tuples is simply to return multiple values, binding those multiple results with a <literal>case</literal> expression, thus: <programlisting> @@ -299,6 +271,10 @@ above example desugars like this: </programlisting> Indeed, the bindings can even be recursive. </para> +</listitem> +</itemizedlist> + +</para> </sect2> </sect1> _______________________________________________ Cvs-ghc mailing list [email protected] http://www.haskell.org/mailman/listinfo/cvs-ghc
