Module: ppl/ppl Branch: master Commit: f3342c5e5b7b30f4a698d3500f1f22890384a8bc URL: http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=f3342c5e5b7b3...
Author: Patricia Hill p.m.hill@leeds.ac.uk Date: Tue Mar 23 21:06:16 2010 +0000
Added documentation for prolog wrap_assign/8 predicate.
---
interfaces/Prolog/Prolog_interface.dox | 6 +++++ .../ppl_interface_generator_prolog_dox_code.m4 | 21 ++++++++++++++++++++ 2 files changed, 27 insertions(+), 0 deletions(-)
diff --git a/interfaces/Prolog/Prolog_interface.dox b/interfaces/Prolog/Prolog_interface.dox index dd147ad..f1e9538 100644 --- a/interfaces/Prolog/Prolog_interface.dox +++ b/interfaces/Prolog/Prolog_interface.dox @@ -317,6 +317,12 @@ The specification uses the following grammar rules: P_Func --> [] list of map relations | [Vars_Pair | P_Func].
+ Width --> bits_8 | bits_16 | bits_32 | bits_64 | bits_128 + + Representation --> unsigned | signed_2_complement + + Overflow --> overflow_wraps | overflow_undefined | overflow_impossible + Optimization_Mode --> max | min
MIP_Problem_Status --> unfeasible diff --git a/interfaces/Prolog/ppl_interface_generator_prolog_dox_code.m4 b/interfaces/Prolog/ppl_interface_generator_prolog_dox_code.m4 index 7564825..15e2694 100644 --- a/interfaces/Prolog/ppl_interface_generator_prolog_dox_code.m4 +++ b/interfaces/Prolog/ppl_interface_generator_prolog_dox_code.m4 @@ -946,6 +946,27 @@ m4_define(`ppl_@CLASS@_unconstrain_space_dimensions_trans_doc',
')
+m4_define(`ppl_@CLASS@_wrap_assign_trans_doc', +`dnl +<P><CODE>ppl_@CLASS@_wrap_assign(+Handle, +List_of_PPL_Var, +Width, +Representation, +Overflow, +Constraint_System, +C_unsigned, +Boolean)</CODE><BR> + <EM>Transforms the m4_this_ppl_one_object \p P referenced by + <CODE>Handle</CODE> by wrapping the dimensions given by + <CODE>List_of_PPL_Vars</CODE> while respecting the specified + <CODE>Width</CODE>|COMMA| <CODE>Representation</CODE> and + <CODE>Overflow</CODE> behavior of all these variables. The + <CODE>Constraint_System</CODE> represents the conditional or + looping construct guard with respect to which wrapping is + performed. The non-negative integer <CODE>C_unsigned</CODE> and + <CODE>Boolean</CODE> allow control of the complexity/precision + ratio; higher values for <CODE>C_unsigned</CODE> will lead to + possibly greater precision while a true value for + <CODE>Boolean</CODE> indicates that the space dimensions should be + wrapped individually. See Section \extref{Wrapping_Operator|COMMA| + Wrapping Operator} for a more detailed description of this + operator.</EM> + +') + dnl ----------------------------------------------------------------- dnl Documentation for the concatenation predicates; dnl -----------------------------------------------------------------