Dot digraph colours #330

marinaanagno · 2020-07-13T17:59:31Z

Added coloured options for vertices and edges in DotDigraph and DotSymmetricDigraph. We also used a global variable so that DotDigraph, DotVertexLabelledDigraph, DotColoredDigraph, DotSymmetricDigraph and DotSymmetricColoredDigraph do not have repeated code.

james-d-mitchell · 2020-07-15T10:27:10Z

doc/z-chap9.xml

@@ -3,7 +3,9 @@
  <Section><Heading>Visualising a digraph</Heading>
    <#Include Label="Splash">
    <#Include Label="DotDigraph">
+    <#Include Label="DotColoredDigraph">


This line isn't necessary, and is probably what is causing the CI to fail, I suggest removing it.

james-d-mitchell · 2020-07-15T10:27:19Z

doc/z-chap9.xml

    <#Include Label="DotSymmetricDigraph">
+    <#Include Label="DotSymmetricColoredDigraph">


Same for this one.

james-d-mitchell · 2020-07-15T10:28:03Z

doc/display.xml

@@ -98,9 +99,40 @@ gap> Splash(DotDigraph(RandomDigraph(4)));
  </ManSection>
 <#/GAPDoc>

+<#GAPDoc Label="DIGRAPHS_DotDigraph">


We don't usually document functions starting DIGRAPHS_ these are treated as (kind of) private internal functions/methods.

james-d-mitchell · 2020-07-15T10:28:51Z

doc/attr.xml

@@ -133,6 +133,30 @@ gap> DigraphNrEdges(D);
 </ManSection>
 <#/GAPDoc>

+<#GAPDoc Label="DigraphNrLoops">


This chunk shouldn't be here, looks like you've branched DotDigraphColours off DigraphNrLoops but you should have done it from the master branch.

james-d-mitchell · 2020-07-15T10:29:29Z

Thanks for the PR @marinaanagno ! Obviously the CI is failing, I think you need to make a few changes, as mentioned in the comments before having another review.

james-d-mitchell

See the comments.

james-d-mitchell

This looks pretty good! The only thing that's really missing is checks that the argument "colors" are valid (i.e. that you can't get the code you've written to error inside it by providing incorrect arguments) and that the documentation should indicate the requirements of these arguments too. Otherwise, this looks good!

james-d-mitchell · 2020-08-14T08:23:58Z

doc/display.xml

    <Returns>A string.</Returns>
    <Description>
      This function produces a graphical representation of the symmetric
      digraph <A>digraph</A>. <C>DotSymmetricDigraph</C> will return an
      error if <A>digraph</A> is not a symmetric digraph. See
      <Ref Prop="IsSymmetricDigraph"/>.<P/>

+      The function <C>DotSymmetricColoredDigraph</C> differs from <C>DotDigraph</C>
+      only in


Please remove the line break here.

james-d-mitchell · 2020-08-14T08:25:43Z

doc/display.xml

@@ -110,6 +111,10 @@ gap> Splash(DotDigraph(RandomDigraph(4)));
      vertices, with the arrowhead of each line pointing towards the range
      of the edge.<P/>

+      <C>DotColoredDigraph</C> differs from <C>DotDigraph</C> only in
+      that the values in given in the two lists are used to color the vertices and
+      edges of the graph when displayed.  <P/>


I think you should add more details about what values the arguments can have. I.e. what are the possible "colors" of the vertices and edges? what if I want to specify vertex colors but not edge colors, or vice versa? the list of edge colors has to have the same "shape" as the list of Outneighbours right?

james-d-mitchell · 2020-08-14T08:26:33Z

gap/display.gi

+                             vert[i], ", style=filled]")],
+                             [{i, j} -> Concatenation("[color=",
+                             edge[i][j], "]")]));
+  # return DIGRAPHS_DotDigraph(D,


Add a comment that the method above can be replaced with the commented out one when/if Digraphs requires GAP version ??.

james-d-mitchell · 2020-08-14T08:26:51Z

gap/display.gi

 [IsDigraphByOutNeighboursRep],
 function(D)
-  local out, str, i, j;
+  return DIGRAPHS_DotDigraph(D, [i -> Concatenation(" [label=\"",
+                                String(DigraphVertexLabel(D, i)), "\"]")], []);


Same as above, please add a comment.

james-d-mitchell · 2020-08-14T08:27:58Z

gap/display.gi

+"for a digraph by out-neighbours and two lists",
+[IsDigraphByOutNeighboursRep, IsList, IsList],
+function(D, vert, edge)
+  return DIGRAPHS_DotSymmetricDigraph(D,


What happens if the list of colors (edge or vertex) is not valid? I.e. if the list is too short? Or has holes?

james-d-mitchell · 2020-08-14T08:28:09Z

gap/display.gi

+                                     ", style=filled]")],
+                                     [{i, j} -> Concatenation("[color=",
+                                     edge[i][j], "]")]);
+  # return DIGRAPHS_DotSymmetricDigraph(D,


Add a comment as above.

marinaanagno · 2020-08-18T16:36:20Z

We made the suggested changes and also we created some new functions DotVertexColoredDigraph DotEdgeColoredDigraph, DotSymmetricVertexColoredDigraph and DotSymmetricEdgeColoredDigraph that colour edges and vertices independently.

james-d-mitchell · 2020-08-19T13:32:45Z

@marinaanagno I'm not sure that you've pushed your changes, can you please double check? If you've addressed my comments, then they should be showing as "outdated", and at present they aren't.

james-d-mitchell

We discussed this just now, and the only outstanding thing to do is to check that the "color" arguments to these functions are valid.

…etricDigraph

…lled doesn't work yet)

…graph

Fix

wilfwilson · 2021-10-15T18:52:54Z

Thank you for adding this! I like it.

marinaanagno · 2021-10-25T21:48:13Z

Thank you for adding this! I like it.

Glad to hear that! :)

james-d-mitchell reviewed Jul 15, 2020

View reviewed changes

james-d-mitchell requested changes Jul 15, 2020

View reviewed changes

marinaanagno force-pushed the DotDigraphColours branch 2 times, most recently from 9a26093 to e8c8e6b Compare July 15, 2020 14:21

marinaanagno requested a review from james-d-mitchell August 1, 2020 12:04

james-d-mitchell requested changes Aug 14, 2020

View reviewed changes

marinaanagno requested a review from james-d-mitchell August 18, 2020 21:04

james-d-mitchell added the new-feature A label for new features. label Aug 19, 2020

james-d-mitchell requested changes Aug 19, 2020

View reviewed changes

Marina Anagnostopoulou-Merkouri added 13 commits September 9, 2020 17:19

Added colour options for vertices and edges in DotDigraph and DotSymm…

42ce0c2

…etricDigraph

new documentation

5523934

fixed documentation

3f79f1d

changed required gap version

0a0a115

Changed code so that it runs with the required version (DotVertexLabe…

b7e8b35

…lled doesn't work yet)

Made changes compatible with gap-4.9.0, which is the required version

3af6f7b

Fixed a StringFormatted part that I had forgotten to fix

960eadf

Just to switch branches

d2cf9a7

made suggested changes and added some new functions

4ad219d

unfinished work

28b73cf

switch branches

a5ba594

switch branches

1556040

Added error functions for DotColoredDigraph and DotSymmetricColoredDi…

4dc16e4

…graph

marinaanagno force-pushed the DotDigraphColours branch from b5a416b to 4dc16e4 Compare September 9, 2020 16:20

james-d-mitchell mentioned this pull request Sep 16, 2020

Testing travis #335

Closed

james-d-mitchell and others added 2 commits September 16, 2020 18:16

Fix

ef494e3

Merge pull request #1 from james-d-mitchell/DotDigraphColours

48820e4

Fix

james-d-mitchell approved these changes Sep 17, 2020

View reviewed changes

james-d-mitchell merged commit 8384e54 into digraphs:master Sep 17, 2020

james-d-mitchell mentioned this pull request Nov 18, 2020

Coloured DotDigraph output #170

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dot digraph colours #330

Dot digraph colours #330

marinaanagno commented Jul 13, 2020

james-d-mitchell Jul 15, 2020

james-d-mitchell Jul 15, 2020

james-d-mitchell Jul 15, 2020

james-d-mitchell Jul 15, 2020

james-d-mitchell commented Jul 15, 2020

james-d-mitchell left a comment

james-d-mitchell left a comment

james-d-mitchell Aug 14, 2020

james-d-mitchell Aug 14, 2020

james-d-mitchell Aug 14, 2020

james-d-mitchell Aug 14, 2020

james-d-mitchell Aug 14, 2020

james-d-mitchell Aug 14, 2020

marinaanagno commented Aug 18, 2020

james-d-mitchell commented Aug 19, 2020

james-d-mitchell left a comment

wilfwilson commented Oct 15, 2021

marinaanagno commented Oct 25, 2021

		<#Include Label="DotSymmetricDigraph">
		<#Include Label="DotSymmetricColoredDigraph">

Dot digraph colours #330

Dot digraph colours #330

Conversation

marinaanagno commented Jul 13, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

james-d-mitchell commented Jul 15, 2020

james-d-mitchell left a comment

Choose a reason for hiding this comment

james-d-mitchell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marinaanagno commented Aug 18, 2020

james-d-mitchell commented Aug 19, 2020

james-d-mitchell left a comment

Choose a reason for hiding this comment

wilfwilson commented Oct 15, 2021

marinaanagno commented Oct 25, 2021