[m-rev.] for review: document MR_word_to_float and MR_float_to_word in ref. manual

[Julien Fischer]

On Tue, 6 Jul 2010, Ian MacLarty wrote:

> On Tue, Jul 06, 2010 at 05:39:11PM +1000, Julien Fischer wrote:
>>
>> Branches: main, 10.04
>>
>> Mention MR_word_to_float and MR_float_to_word in the user's guide.
>>
>> doc/reference_manual.texi:
>> 	Add a paragraph about MR_word_to_float() and MR_float_to_word().
>>
>> 	Provide an example of their use in conjunction with the list access
>> 	macros.
>>
>> Julien.
>>
>> Index: reference_manual.texi
>> ===================================================================
>> RCS file: /home/mercury/mercury1/repository/mercury/doc/reference_manual.texi,v
>> retrieving revision 1.443
>> diff -u -r1.443 reference_manual.texi
>> --- reference_manual.texi	7 May 2010 03:12:24 -0000	1.443
>> +++ reference_manual.texi	6 Jul 2010 07:34:40 -0000
>> @@ -6915,6 +6915,25 @@
>>  Note that the use of these macros is subject to some caveats
>>  (@pxref{Memory management for C}).
>>
>> +The implementation provides the macro @samp{MR_word_to_float} for converting a
>> +value of type @samp{MR_Word} to one of type @samp{MR_Float}, and the macro
>> + at samp{MR_float_to_word} for converting a value of type @samp{MR_Float} to one
>> +of type @samp{MR_Word}.
>> +These macros must be used to perform these conversions since for some Mercury
>> +implementations @samp{sizeof(MR_Float)} is greater than @samp{sizeof(MR_Word)}.
>
> Maybe replace "Mercury implementations" with "backends".

In this sense, implementation means (or rather implies) the implementation
of Mercury on a particular platform since the condition referred to in
that paragraph is a platform-specific thing that doesn't have so much to
do with the C backends.  (And none of this has anything to do with the
non-C backends.)

Julien.
--------------------------------------------------------------------------
mercury-reviews mailing list
Post messages to:       mercury-reviews at csse.unimelb.edu.au
Administrative Queries: owner-mercury-reviews at csse.unimelb.edu.au
Subscriptions:          mercury-reviews-request at csse.unimelb.edu.au
--------------------------------------------------------------------------