Ah, it looks that I did not understand your original email. I think MPG says somewhere that if there is nothing said about propagation strength it is domain consistent. It might even be true ;-)
But I think you are right that we should say it in the reference docs what the propagators achieve and in many places we do. I'll go through the ref docs and fix it for the next release. Cheers Christian -- Christian Schulte, KTH, web.it.kth.se/~cschulte/ -----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of Kish Shen Sent: Monday, September 26, 2011 8:38 PM To: [email protected] Subject: Re: [gecode-users] documentation for member propagator Hi Christian, On 26/09/2011 19:13, Christian Schulte wrote: > As I said before, the argument is there. Always. But doxygen sometimes > does not take the declaration (where the optional argument is and must > be there) but the definition (where the optional argument cannot be > there) for generating the docs. I understand that doxygen may sometimes miss arguments. I assume this should be considered a bug, and if possible (and if you know how the bug behaves), avoid the bug by avoiding the situation that will cause the argument to be missed. For the case of element (and also precede), are you saying that doxygen has a problem that prevents it from picking up the description of some of the variables? Here is one example of element in the reference manual that does not describe icl (even though it is listed in the specification of the procedure): void Gecode::element ( Home home, IntSharedArray n, IntVar x0, BoolVar x1, IntConLevel icl = ICL_DEF ) Post propagator for . Throws an exception of type Int::OutOfLimits, if the integers in n exceed the limits in Int::Limits. =================== and here is an description that does give information on icl: void Gecode::element ( Home home, const IntVarArgs & x, IntVar y0, IntVar y1, IntConLevel icl = ICL_DEF ) Post propagator for . Supports both bounds (icl = ICL_BND) and domain consistency (icl = ICL_DOM, default). ============== I don't know doxygen at all, but is the text "Supports both bounds...." in the source for both of these, and a bug in doxygen is preventing the description from being generated in the first case? (I am assuming that both versions supports ICL_BND and ICL_DOM) 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. _______________________________________________ Gecode users mailing list [email protected] https://www.gecode.org/mailman/listinfo/gecode-users _______________________________________________ Gecode users mailing list [email protected] https://www.gecode.org/mailman/listinfo/gecode-users
