I have added some documentation to permgrps in patch here:
https://github.com/martinbaker/fricasAlgTop/blob/master/permgrps2.patch

This contains documentation only, no code changes.

By 'documentation' I mean comments + literate.
By 'literate' I mean formatted text. I have not tried to follow literate methodology, that is, I have not tried to make a linear story. This is purely intended as reference information which would otherwise go in comments. This just saves lots of lines starting with '--'.

I don't know how you feel about a third party (me) writing comments for other peoples code? Although people here are very good at replying to requests for information on this forum there does not seem to be much enthusiasm for adding to documentation in a more permanent and easily found way?

I don't feel qualified to try to speak for the original authors but I don't think they provided enough information to be able to use or develop the software without spending a lot of time tracing through the code to discover its secrets. I think it is very wasteful for every potential user to have to do this. I was therefore motivated to write these notes. Such information (or better if you can improve it) needs to be in a place where users and developers can find it.

I did find some other sources for information about the
Schreier-Sims algorithm such as this:
https://en.wikipedia.org/wiki/Schreier%E2%80%93Sims_algorithm

Waldek Hebisch referred to these notes by A. Hulpke which contain a
sketch of the algorithm.
http://www.math.colostate.edu/~hulpke/CGT/cgtnotes.pdf

Waldeks description on FriCAS forum here:
https://groups.google.com/forum/?hl=en#!topic/fricas-devel/EtLwgd2dWNU

I find it improves the documentation to use diagrams, I have
therefore put much better documentation on the web page here:
http://www.euclideanspace.com/prog/scratchpad/mycode/discrete/finiteGroup/

I think it is worth studying permgrps.spad even if someone is not interested in developing group related code, this still looks to me like a good case study in how to design code to scale up to very large structures. So perhaps it is worth documenting for that reason alone.

Martin B

--
You received this message because you are subscribed to the Google Groups "FriCAS - 
computer algebra system" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/fricas-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to