Changeset 4096 for trunk/library/loopp.lgt

Timestamp:

02/16/08 04:29:57 (11 months ago)

Author:

pmoura

Message:

Clarify fail conditions for the "loop" library object predicates.

Files:

• trunk/library/loopp.lgt (modified) (7 diffs)

trunk/library/loopp.lgt

@@ -7 +7 @@
         date is 2008/2/16,
         comment is 'Loop control constructs protocol.']).
-
 
     :- public(whiledo/2).
@@ -34 +33 @@
     :- mode(forto(+number, +number, @callable), zero_or_one).
     :- info(forto/3, [
-        comment is 'Call Goal counting up from First to Last. Increment is 1. For convenience and clarity, First and Last can be arithmetic expressions.',
+        comment is 'Call Goal counting up from First to Last. Increment is 1. For convenience and clarity, First and Last can be arithmetic expressions. This predicate fails iff the Goal fails.',
         argnames is ['First', 'Last', 'Goal']]).
 
@@ -41 +40 @@
     :- mode(forto(@var, +number, +number, @callable), zero_or_one).
     :- info(forto/4, [
-        comment is 'Call Goal counting up from First to Last and instantiating Count to each successive value. Increment is 1. For convenience and clarity, First and Last can be arithmetic expressions.',
+        comment is 'Call Goal counting up from First to Last and instantiating Count to each successive value. Increment is 1. For convenience and clarity, First and Last can be arithmetic expressions. This predicate fails iff the Goal fails.',
         argnames is ['Count', 'First', 'Last', 'Goal']]).
 
@@ -48 +47 @@
     :- mode(forto(@var, +number, +number, +number, @callable), zero_or_one).
     :- info(forto/5, [
-        comment is 'Call Goal counting up from First to Last and instantiating Count to each successive value. For convenience and clarity, First, Last, and Increment can be arithmetic expressions. The absolute value of Increment is used.',
+        comment is 'Call Goal counting up from First to Last and instantiating Count to each successive value. For convenience and clarity, First, Last, and Increment can be arithmetic expressions. The absolute value of Increment is used. This predicate fails iff the Goal fails.',
         argnames is ['Count', 'First', 'Last', 'Increment', 'Goal']]).
 
@@ -55 +54 @@
     :- mode(fordownto(+number, +number, @callable), zero_or_one).
     :- info(fordownto/3, [
-        comment is 'Call Goal counting down from First to Last. Decrement is 1. For convenience and clarity, First and Last can be arithmetic expressions.',
+        comment is 'Call Goal counting down from First to Last. Decrement is 1. For convenience and clarity, First and Last can be arithmetic expressions. This predicate fails iff the Goal fails.',
         argnames is ['First', 'Last', 'Goal']]).
 
@@ -62 +61 @@
     :- mode(fordownto(@var, +number, +number, @callable), zero_or_one).
     :- info(fordownto/4, [
-        comment is 'Call Goal counting down from First to Last and instantiating Count to each successive value. Decrement is 1. For convenience and clarity, First and Last can be arithmetic expressions.',
+        comment is 'Call Goal counting down from First to Last and instantiating Count to each successive value. Decrement is 1. For convenience and clarity, First and Last can be arithmetic expressions. This predicate fails iff the Goal fails.',
         argnames is ['Count', 'First', 'Last', 'Goal']]).
 
@@ -69 +68 @@
     :- mode(fordownto(@var, +number, +number, +number, @callable), zero_or_one).
     :- info(fordownto/5, [
-        comment is 'Call Goal counting down from First to Last and instantiating Count to each successive value. For convenience and clarity, First, Last, and Decrement can be arithmetic expressions. The absolute value of Decrement is used.',
+        comment is 'Call Goal counting down from First to Last and instantiating Count to each successive value. For convenience and clarity, First, Last, and Decrement can be arithmetic expressions. The absolute value of Decrement is used. This predicate fails iff the Goal fails.',
         argnames is ['Count', 'First', 'Last', 'Decrement', 'Goal']]).