Linting

Author: James Mitchell

.gaplint.yml

@@ -0,0 +1,2 @@
+disable:
+  - align-assignments

.gaplint_ignore

@@ -1,7 +1,7 @@
 #############################################################################
 ##
-#W  PackageInfo.g
-#Y  Copyright (C) 2015-18                                James D. Mitchell
+##  PackageInfo.g
+##  Copyright (C) 2015-18                                James D. Mitchell
 ##
 ##  Licensing information can be found in the README.md file of this package.
 ##

PackageInfo.g

@@ -23,11 +23,11 @@
     determining the clique number of a digraph. 
     <Example><![CDATA[
 gap> gr := CompleteDigraph(4);;
-gap> CliqueNumber(gr); 
+gap> CliqueNumber(gr);
 4
 gap> gr := Digraph([[1, 2, 4, 4], [1, 3, 4], [2, 1], [1, 2]]);
 <multidigraph with 4 vertices, 11 edges>
-gap> CliqueNumber(gr); 
+gap> CliqueNumber(gr);
 3]]></Example>
 </Description>
 </ManSection>
@@ -571,10 +571,10 @@ gap> DigraphIndependentSets(gr, [], [4, 5], 1, 2);
 gap> gr := CompleteDigraph(5);
 <digraph with 5 vertices, 20 edges>
 gap> user_param := [];;
-gap> f := function(a, b) # Calculate size of clique
+gap> f := function(a, b)  # Calculate size of clique
 >   AddSet(user_param, Size(b));
 > end;;
-gap> CliquesFinder(gr, f, user_param, infinity, [], [], false, fail, 
+gap> CliquesFinder(gr, f, user_param, infinity, [], [], false, fail,
 >                  true);
 [ 1, 2, 3, 4, 5 ]
 gap> CliquesFinder(gr, fail, [], 5, [2, 4], [3], false, fail, false);

doc/cliques.xml

@@ -596,7 +596,7 @@ gap> ReadPlainTextDigraph(filename, ",", 1, ['/', '%']);
     <Example><![CDATA[
 gap> gr := Digraph([[2], [1, 3, 4], [2, 4], [2, 3]]);
 <digraph with 4 vertices, 8 edges>
-gap> filename := Concatenation(DIGRAPHS_Dir(), 
+gap> filename := Concatenation(DIGRAPHS_Dir(),
 >                              "/tst/out/dimacs.dimacs");;
 gap> WriteDIMACSDigraph(filename, gr);;
 gap> ReadDIMACSDigraph(filename);

doc/io.xml

@@ -161,7 +161,7 @@ gap> gr := Digraph([[2], [3, 3], [3], [2]]);
 <multidigraph with 4 vertices, 5 edges>
 gap> G := AutomorphismGroup(gr);
 Group([ (1,2), (3,4) ])
-gap> P1 := Projection(G, 1); 
+gap> P1 := Projection(G, 1);
 1st projection of Group([ (1,2), (3,4) ])
 gap> P2 := Projection(G, 2);
 2nd projection of Group([ (1,2), (3,4) ])
@@ -270,7 +270,7 @@ gap> gr := Digraph([[2], [3, 3], [3], [2], [2]]);
 <multidigraph with 5 vertices, 6 edges>
 gap> G := AutomorphismGroup(gr, [1, 1, 2, 3, 1]);
 Group([ (1,2), (3,4) ])
-gap> P1 := Projection(G, 1); 
+gap> P1 := Projection(G, 1);
 1st projection of Group([ (1,2), (3,4) ])
 gap> P2 := Projection(G, 2);
 2nd projection of Group([ (1,2), (3,4) ])

doc/isomorph.xml

@@ -48,7 +48,7 @@ true
 gap> DigraphGroup(ddigraph);
 Group([ (1,2,3,4)(5,6,7,8), (1,5)(2,6)(3,7)(4,8) ])
 gap> AutomorphismGroup(ddigraph) =
-> Group([(6, 8), (5, 7), (4, 6), (3, 5), (2, 4), 
+> Group([(6, 8), (5, 7), (4, 6), (3, 5), (2, 4),
 >        (1, 2)(3, 4)(5, 6)(7, 8)]);
 true
 gap> digraph := Digraph([[2, 3], [], []]);

doc/orbits.xml

@@ -179,7 +179,7 @@ gap> IsJoinSemilatticeDigraph(gr);
 true
 gap> IsLatticeDigraph(gr);
 true
-gap> gr := Digraph([[1, 1, 1], [1, 1, 2, 2], 
+gap> gr := Digraph([[1, 1, 1], [1, 1, 2, 2],
 >                   [1, 3, 3], [1, 2, 3, 3, 4]]);
 <multidigraph with 4 vertices, 15 edges>
 gap> IsMeetSemilatticeDigraph(gr);

doc/prop.xml

@@ -1,7 +1,7 @@
 #############################################################################
 ##
-#W  attr.gd
-#Y  Copyright (C) 2014-17                                James D. Mitchell
+##  attr.gd
+##  Copyright (C) 2014-17                                James D. Mitchell
 ##
 ##  Licensing information can be found in the README file of this package.
 ##

gap/attr.gd

@@ -1,7 +1,7 @@
 #############################################################################
 ##
-#W  attr.gi
-#Y  Copyright (C) 2014-17                                James D. Mitchell
+##  attr.gi
+##  Copyright (C) 2014-17                                James D. Mitchell
 ##
 ##  Licensing information can be found in the README file of this package.
 ##
@@ -96,12 +96,12 @@ function(digraph)
     ErrorNoReturn("Digraphs: ChromaticNumber: usage,\n",
                   "the digraph (1st argument) must not have loops,");
   elif nr = 0 then
-    return 0; # chromatic number = 0 iff <digraph> has 0 verts
+    return 0;  # chromatic number = 0 iff <digraph> has 0 verts
   elif IsNullDigraph(digraph) then
-    return 1; # chromatic number = 1 iff <digraph> has >= 1 verts & no edges
+    return 1;  # chromatic number = 1 iff <digraph> has >= 1 verts & no edges
   elif IsBipartiteDigraph(digraph) then
-    return 2; # chromatic number = 2 iff <digraph> has >= 2 verts & is bipartite
-              # <digraph> has at least 2 vertices at this stage
+    return 2;  # chromatic number = 2 iff <digraph> has >= 2 verts & is bipartite
+               # <digraph> has at least 2 vertices at this stage
   fi;
 
   # The chromatic number of <digraph> is at least 3 and at most nr
@@ -916,9 +916,9 @@ function(digraph)
     return rec(diameter := fail, girth := infinity);
   fi;
 
-  #TODO improve this, really check if the complexity is better with the group
-  #or without, or if the group is not known, but the number of vertices makes
-  #the usual algorithm impossible.
+  # TODO improve this, really check if the complexity is better with the group
+  # or without, or if the group is not known, but the number of vertices makes
+  # the usual algorithm impossible.
 
   outer_reps := DigraphOrbitReps(digraph);
   diameter   := 0;
@@ -1052,7 +1052,7 @@ function(digraph)
 
   # The average degree
   m := Float(Sum(OutDegreeSequence(digraph)) / n);
-  verts := [1 .. n]; # We don't want DigraphVertices as that's immutable
+  verts := [1 .. n];  # We don't want DigraphVertices as that's immutable
 
   if IsMultiDigraph(digraph) then
     mat := List(verts, x -> verts * 0);
@@ -1153,7 +1153,7 @@ function(graph, reflexive)
   # Try correct method vis-a-vis complexity
   if m + n + (m * n) < (n * n * n) then
     sorted := DigraphTopologicalSort(graph);
-    if sorted <> fail then # Method for big acyclic digraphs (loops allowed)
+    if sorted <> fail then  # Method for big acyclic digraphs (loops allowed)
       out   := EmptyPlist(n);
       trans := EmptyPlist(n);
       for v in sorted do
@@ -1321,21 +1321,22 @@ function(digraph)
   digraph := DigraphSymmetricClosure(DigraphRemoveAllMultipleEdges(digraph));
   colour := ListWithIdenticalEntries(n, 0);
 
-  #This means there is a vertex we haven't visited yet
+  # This means there is a vertex we haven't visited yet
   while 0 in colour do
     root := Position(colour, 0);
     colour[root] := 1;
     queue := [root];
     Append(queue, OutNeighboursOfVertex(digraph, root));
     while queue <> [] do
-      #Explore the first element of queue
+      # Explore the first element of queue
       node := queue[1];
       node_neighbours := OutNeighboursOfVertex(digraph, node);
       for i in node_neighbours do
-        #If node and its neighbour have the same colour, graph is not bipartite
+        # If node and its neighbour have the same colour, graph is not
+        # bipartite
         if colour[node] = colour[i] then
           return [false, fail, fail];
-        elif colour[i] = 0 then # Give i opposite colour to node
+        elif colour[i] = 0 then  # Give i opposite colour to node
           if colour[node] = 1 then
             colour[i] := 2;
           else