GAP package GUAVA

Authors: Jasper Cramwinckel, Erik Roijackers, Reinald Baart, Eric Minkes, Lea Ruscio, Robert Miller, Tom Boothby, Joe Fields (maintainer), Cen Tjhai, David Joyner
Needs: GAP in version at least 4.5.2, and suggests also installing the GAP package SONATA.
Operating systems: Any, on which GAP 4 is running.
Current version: 3.14
Contact: fieldsj1@southernct.edu
Download: See below for archives in several formats. Also, GUAVA is now on GitHub: https://github.com/osj1961/guava/

Online Documentation

Here is the documentation of the GUAVA package in several output formats. You should also be able to access these documents from the GAP online help.

Browse the code: on GitHub.

Description

GUAVA is a package that implements coding theory algorithms in GAP. Codes can be created and manipulated and information about codes can be calculated.

GUAVA consists of various files written in the GAP language, and an external program from J. S. Leon for dealing with automorphism groups of codes and isomorphism testing functions (for the manual to his program, click here for the pdf). Several algorithms that need the speed are integrated in the GAP kernel. Please send your bug reports to support.

The functions within GUAVA can be divided into four categories:

Construction of codes. GUAVA can construct non-linear, linear and cyclic codes over an arbitrary finite field. Examples are HadamardCode, ReedMullerCode, BestKnownLinearCode, QRCode and GoppaCode.
Manipulation of codes. These functions allow the user to transform one code into another or to construct a new code from two codes. Examples are PuncturedCode, DualCode, DirectProductCode and UUVCode.
Computation of information about codes. This information is stored in the code record. Examples are MinimumDistance, OuterDistribution, IsSelfDualCode and AutomorphismGroup.
Generation of bounds on linear codes. The table by Brouwer and Verhoeff (as it existed in the mid 1990's) is incorporated into GUAVA. For example, BoundsMinimumDistance.

History

As of 3.10, Joe Fields is the lead maintainer.

See the latest CHANGES.guava file for recent information. The file HISTORY.guava contains further details.

GUAVA and SAGE

The easiest way to begin experimenting with GUAVA is to use it via the SageMathCloud (SMC). One can sign up for a free SMC account or pay a small amount for a subscription (which allows for premium access). Within a SMC project one can create a sage worksheet and set its default language to GAP. Then load GUAVA (see below) and try out its features.

Installation

A fresh install of GAP will include GUAVA by default. The directions in the next paragraph only apply to those who find themselves in the unusual situation of not having the default GUAVA installation. In the majority of cases you can skip to the following paragraph.

To install GUAVA, as a GAP 4 package, unpack the archive file in a directory in the `pkg' hierarchy of your version of GAP 4. (This might be the `pkg' directory of the GAP 4 home directory; it is however also possible to keep an additional `pkg' directory in your private directories, see section "Installing GAP Packages" of the GAP 4 reference manual for details on how to do this.)

After unpacking GUAVA the GAP-only part of GUAVA is installed. The parts of GUAVA depending on J. Leon's backtrack programs package (for computing automorphism groups and code equivalences) are now available in a Window, MacOS and UNIX environments. For Windows machines, separate instructions are available here. For UNIX and MacOS you should proceed as follows:

Linux/UNIX installation instructions:
Go to the newly created `guava' directory and call `./configure GAPPATH' where GAPPATH is the path to the GAP home directory. The default value for GAPPATH is `../..' so if you install the package in the main `pkg' directory it is sufficient to call
```
./configure 
```
This will fetch the architecture type for which GAP has been compiled last and create a `Makefile'. Now call
```
make
```
to compile the binary and to install it in the appropriate place. Note that there is no seperate `
```
make install
```
call.
64-bit linux instructions: The above instructions should suffice to create 64 bit binaries but if there is a problem one can use the `--enable-libsuffix=64' option to configure to force the issue:
```
./configure ../.. --enable-libsuffix=64 

make
```
Mac OS X instructions: The linux instructions should work here as well.

This completes the installation of GUAVA for a single architecture. If you use this installation of GUAVA on different hardware platforms you will have to compile the binary for each platform separately. This is done by calling `configure' and `make' for the package anew immediately after compiling GAP itself for the respective architecture. If your version of GAP is already compiled (and has last been compiled on the same architecture) you do not need to compile GAP again; it is sufficient to call the `configure' script in the GAP home directory.

Hints for GUAVA installation outside the GAP main directory: When you don't have access to the directory of your main GAP installation you can also install the package by unpacking inside a directory MYGAPDIR/pkg. (Don't forget to call "gap" with the -l ";MYGAPDIR" option.) The only drawback with this installation is that in the HTML version of the package documentation the links to the main GAP manuals don't work.

Loading GUAVA

After starting up GAP, the GUAVA package needs to be loaded. Load GUAVA by typing at the GAP prompt:

gap> LoadPackage( "guava" );

In fact, you can automate this by adding

LoadPackage("guava");

to your gaprc file. However, if you wish to start GAP via a workspace with GUAVA preloaded then you should type both LoadPackage("sonata"); and LoadPackage("guava"); before saving your workspace, since one command in GUAVA (versions 3.8 and higher) requires SONATA.

Other GUAVA web pages

covering codes calculations (under construction)

Package Archives for Download

The GUAVA package is available in the following formats:

GUAVA version 3.13 guava-3.13.tar.gz, guava-3.13.tar.bz2,

Previous versions are also archived here. Older versions are available upon request.

GUAVA version 3.12 guava-3.12.tar.gz, guava-3.12.tar.bz2,
GUAVA version 3.11 guava3.11.tar.gz, guava3.11.tar.bz2,
GUAVA version 3.10 guava3.10.tar.gz, guava3.10.tar.bz2,

These tarballs are all about 2-3M in size.

Latest README file.
Latest CHANGES file.
Latest PackageInfo.g file.

Joe Fields / Last modified: 2016-2-04