Add ForAllX, ForAnyX, FilteredX, NumberX, PerformX

Author: fingolfin

lib/coll.gd

@@ -2421,6 +2421,17 @@ DeclareOperation( "FoldLeftOp", [ IsListOrCollection, IsFunction ] );
 DeclareGlobalFunction( "FoldLeftX" );
 
 
+#############################################################################
+##
+##  TODO: document the following
+##
+DeclareGlobalFunction( "ForAllX" );
+DeclareGlobalFunction( "ForAnyX" );
+DeclareGlobalFunction( "FilteredX" );
+DeclareGlobalFunction( "NumberX" );
+DeclareGlobalFunction( "PerformX" );
+
+
 #############################################################################
 ##
 #F  Sum( <list>[, <init>] ) . . . . . . . . . . sum of the elements of a list

lib/coll.gi

@@ -1830,6 +1830,78 @@ InstallGlobalFunction( ProductX, function ( arg )
 end );
 
 
+#############################################################################
+##
+#M  ForAllX(<obj>,...)
+##
+InstallGlobalFunction( ForAllX, function ( arg )
+    local f;
+    f := Remove(arg);
+    return FoldLeftX(arg, {acc,x} -> acc and CallFuncList(f, x), true, false);
+end );
+
+
+#############################################################################
+##
+#M  ForAnyX(<obj>,...)
+##
+InstallGlobalFunction( ForAnyX, function ( arg )
+    local f;
+    f := Remove(arg);
+    # TODO: implement early abort
+    return FoldLeftX(arg, {acc,x} -> acc or CallFuncList(f, x), false, true);
+end );
+
+
+#############################################################################
+##
+#M  FilteredX(<obj>,...)
+##
+InstallGlobalFunction( FilteredX, function ( arg )
+    local f;
+    f := Remove(arg);
+    return FoldLeftX(arg,
+            function(acc, x)
+                if CallFuncList(f, x) then
+                    Add(acc, ShallowCopy(x));
+                fi;
+                return acc;
+            end, []);
+end);
+
+
+#############################################################################
+##
+#M  NumberX(<obj>,...)
+##
+InstallGlobalFunction( NumberX, function ( arg )
+    local f;
+    f := Remove(arg);
+    return FoldLeftX(arg,
+            function(acc, x)
+                if CallFuncList(f, x) then
+                    return acc + 1;
+                fi;
+                return acc;
+            end, 0);
+end);
+
+
+#############################################################################
+##
+#M  PerformX(<obj>,...)
+##
+InstallGlobalFunction( PerformX, function ( arg )
+    local f;
+    f := Remove(arg);
+    FoldLeftX(arg,
+            function(acc, x)
+                CallFuncList(f, x);
+                return 0;
+            end, 0);
+end);
+
+
 #############################################################################
 ##
 #F  Perform( <list>, <func> )

tst/testinstall/coll.tst

@@ -323,6 +323,57 @@ gap> FoldLeft([1..3], \-);
 gap> FoldLeft([1..3], \-, 0);
 -6
 
+#############################################################################
+#
+# ForAllX
+#
+gap> ForAllX([1..2], [3..4], function(i,j) Display([i,j]); return true; end);
+[ 1, 3 ]
+[ 1, 4 ]
+[ 2, 3 ]
+[ 2, 4 ]
+true
+gap> # verify short circuit works
+gap> ForAllX([1..2], [3..4], function(i,j) Display([i,j]); return false; end);
+[ 1, 3 ]
+false
+
+#############################################################################
+#
+# ForAnyX
+#
+gap> ForAnyX([1..2], [3..4], function(i,j) Display([i,j]); return false; end);
+[ 1, 3 ]
+[ 1, 4 ]
+[ 2, 3 ]
+[ 2, 4 ]
+false
+gap> # verify short circuit works
+gap> ForAnyX([1..2], [3..4], function(i,j) Display([i,j]); return true; end);
+[ 1, 3 ]
+true
+
+#############################################################################
+#
+# FilteredX
+#
+gap> FilteredX([1..2], [3..4], ReturnTrue);
+[ [ 1, 3 ], [ 1, 4 ], [ 2, 3 ], [ 2, 4 ] ]
+
+#############################################################################
+#
+# NumberX
+#
+gap> NumberX([1..2], [3..4], ReturnTrue);
+4
+
+#############################################################################
+#
+# PerformX
+#
+gap> PerformX([1..2], [3..4], Print); Print("\n");
+13142324
+
 #############################################################################
 #
 # List