This version of ResClasses needs at least GAP 4.5.4, Polycyclic 2.6 [EN11] and GAPDoc 1.4 [LN12]. It can be used on all platforms for which GAP is available. ResClasses is completely written in the GAP language and does neither contain nor require external binaries.
Like any other GAP package, ResClasses must be installed in the pkg
subdirectory of the GAP distribution. This is accomplished by extracting the distribution file in this directory. By default, the package ResClasses is autoloaded. If you have switched autoloading of packages off, you can load ResClasses via LoadPackage( "resclasses" );
.
‣ ResClassesTest ( ) | ( function ) |
Returns: nothing.
Performs tests of the ResClasses package. Errors, i.e. differences to the correct results of the test computations, are reported. The processed test files are in the directory pkg/resclasses/tst
.
‣ ResClassesTestExamples ( ) | ( function ) |
Returns: nothing.
Runs all examples in the manual of the ResClasses package, and reports any differences between the actual output and the output printed in the manual.
‣ ResClassesBuildManual ( ) | ( function ) |
Returns: nothing.
This function is a development tool which builds the manual of the ResClasses package in the file formats LaTeX, PDF, HTML and ASCII text. This is accomplished using the GAPDoc package by Frank Lübeck and Max Neunhöffer. Building the manual is possible only on UNIX systems and requires PDFLaTeX. As all files generated by this function are included in the distribution file anyway, users will not need it.
‣ ConvertPackageFilesToUNIXLineBreaks ( package ) | ( function ) |
Returns: nothing.
This function is a development tool which converts the text files of package package from Windows- to UNIX line breaks. Here package is assumed to be either "resclasses"
or "rcwa"
.
‣ RemoveTemporaryPackageFiles ( package ) | ( function ) |
Returns: nothing.
This function is a development tool which cleans up the temporary files of package package. Here package is assumed to be either "resclasses"
or "rcwa"
.
‣ DownloadFile ( url ) | ( function ) |
Returns: the contents of the file with URL url in the form of a string if that file exists and the download was successful, and fail
otherwise.
This function needs the IO package, and as most system-related functions it works only under UNIX. Also the computer must of course be connected to the Internet.
‣ SendEmail ( sendto, copyto, subject, text ) | ( function ) |
Returns: zero if everything worked correctly, and a system error number otherwise.
Sends an e-mail with subject subject and body text to the addresses in the list sendto, and copies it to those in the list copyto. The first two arguments must be lists of strings, and the latter two must be strings.
As most system-related functions, SendEmail
works only under UNIX. Also the computer must of course be connected to the Internet.
‣ EmailLogFile ( addresses ) | ( function ) |
Returns: zero if everything worked correctly, and a system error number otherwise.
Sends the current log file by e-mail to addresses, if GAP is in logging mode and one is working under UNIX, and does nothing otherwise. The argument addresses must be either a list of e-mail addresses or a single e-mail address. Long log files are abbreviated, i.e. if the log file is larger than 64KB, then any output is truncated at 1KB, and if the log file is still longer than 64KB afterwards, it is truncated at 64KB.
generated by GAPDoc2HTML