The Ringing Class Library

Next: Installing and using the library, Previous: Top, Up: Top

1 Introduction

The Ringing Class Library is a collection of C++ classes which implement various concepts found in change ringing, and make it possible to implement programs which use these concepts without having to write the basic algorithms over and over again.

The library is split into several sections:

Classes for dealing with individual rows and changes, and how the interact with each other;
Classes for building and manipulating methods;
Classes for accessing method libraries;
Classes for proving and analysing sequences of rows;
Classes for producing printed output.

Thus it is possible to use whatever part of the library is necessary for your program; for example, a method editing program would use the method classes, whereas a program to simulate call changes would just use the row and change classes.

There are also several utilities included with the library. These demonstrate how to use the Ringing Class Library in your own programs, and are useful in their own right. Currently included are gsiril, a peal proving program with an interface similar to the popular MicroSIRIL program; psline, a utility to print lines for methods in PDF or PostScript; and methsearch, a program which searches for methods satisfying various given criteria. These utilities may be found in the apps subdirectory.

To get information about latest releases of the Ringing Class Library, to report bugs, request features, use forums and access the CVS repository, visit the project web page at http://ringing-lib.sourceforge.net.