[gecode-users] Some more documentation comments

[Kish Shen]

Hi Christian,

On 26/09/2011 19:25, Christian Schulte wrote:
> Hi,
>
> Good point about counts, the GCCAT has overlapping entries (here the
> difference between counts and among is essentially that for one a set is
> represented as a list and otherwise as a set...) where it is not entirely
> clear to me which is which and why they actually deserve different names ;-)
>

I am not sure I understand. From what I can see, among_var allow
Values to be a collection of domain variables (rather than just a 
collection of integers), and NVAR (the count) to also be a domain 
variable, and both among and among_var is defined for the = relation 
only, plus minor differences such as the order of the arguments. counts 
seem to me to correspond exactly to the Gecode count that takes an 
IntSet. [Admittedly I am not very good at reading such specifications, 
so maybe I missed some important point]

> I am not so sure about name mangling in the documentation, I rather like the
> names short. Also, not all type variants are in fact given as a code
> snippet. If I need to see the argument types I go to the reference doc which
> has the full type info.

I understand that you might prefer short names, but I would say: a) 
adding an 's' does not really make the name much longer, and b) in the 
tutorial, the purpose of the text is probably not just to give a short 
specification, but to help the user understand the specific version of 
the constraint, and I personally feel longer names is appropriate here.

To me at least, it is difficult to pick out the specific variant with 
the right type, as I am not familiar with the gecode source for these 
constraints, and many of these constraints have the same name and number 
of arguments, differing only in the type of some of them, and to me at 
least, adding s for names of arrays (and possibly sets) would be a great 
help.

Cheers,

Kish



-- 
This e-mail may contain confidential and privileged material for the
sole use of the intended recipient. Any review, use, distribution or
disclosure by others is strictly prohibited. If you are not the intended
recipient (or authorized to receive for the recipient), please contact
the sender by reply e-mail and delete all copies of this message.
Cisco Systems Limited (Company Number: 02558939), is registered in
England and Wales with its registered office at 1 Callaghan Square,
Cardiff, South Glamorgan CF10 5BT.