[m-rev.] for review: add documentation for benchmkar_det_io/7

[Julien Fischer]

On Sun, 17 Oct 2021, Zoltan Somogyi wrote:

>
> 2021-10-17 20:14 GMT+11:00 "Julien Fischer" <jfischer at opturion.com>:
>> +    % benchmark_det_io(Pred, In, Out, !State, Repeats, Time) is similar to
>> +    % benchmark_det, except that it used for benchmarking a det predicate Pred
>
> it IS ...

Fixed.

>> +    % which destructively updates some unique state State, in addition to
>> +    % taking the input In and producing the output Out.
>> +    % State will usually be the I/O state, but it may be some other unique
>> +    % data structure.
>> +    %
>>  :- pred benchmark_det_io(pred(T1, T2, T3, T3), T1, T2, T3, T3, int, int).
>>  :- mode benchmark_det_io(pred(in, out, di, uo) is det, in, out, di, uo,
>>      in, out) is cc_multi.
>
> I would s/T3/State/g

Done.


> Otherwise, the diff is fine.

Thanks for that.

Julien.