README.txt 3.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
===========================
 Introduction to Vaucanson
===========================

:Date: 2005-01-15

Vaucanson_, a C++ generic library for weighted finite state machine.

.. _Vaucanson: http://www.lrde.epita.fr/vaucanson

.. contents::


Overview
========

Firstly  initiated by  Jacques  Sakarovitch in  2000,  Vaucanson is  a
project   developed   by   the   Ecole   Nationale   Supérieure   des
Télécommunications [1] and the EPITA Research and Development Laboratory
(LRDE) [2].

.. [1] http://www.enst.fr

.. [2] http://www.lrde.epita.fr

The goal of this library is  to enable the development of C++ programs
in  an abstract  and  general way  with,  at the  same  time, a  large
specialization power. Indeed, on the one hand, we can write algorithms
working on  every automaton with  weights over any semirings  and with
words  from any  free monoids.  And on  the other  hand,  a particular
algorithm  can   be  specialized  for  a   particular  data  structure
implementing only a pseudo behaviour.

34
35
36
37
38
39
40
Yet,   Vaucanson  is  an   ongoing  development   project.   Therefore
algorithms,  data  structures and  the  general  architecture are  not
totally stable and well tested.

In the  ``doc/help`` directory,  you can find  a short howto  to start
programming  with Vaucanson.  The ``src``  directory  contains several
demonstrations,     but     you    can     also     look    at     the
41
42
43
44
45
46
47
48
49
50
51
52
``include/vaucanson/algorithms``  to be  introduced to  the  basics of
Vaucanson.

Please send  any question or  comments to ``vaucanson@lrde.epita.fr``,
and bug reports to ``vaucanson-bugs@lrde.epita.fr``.

Installation
============

See   the   documentation   file  ``INSTALL.txt``   for   installation
instructions.

53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
See Also
========

There are other sources of interest in the distribution.

- Headline news about the project can be found in the file ``NEWS`` at
  the root of the source tree.

- Documentation  about the  XML  I/O  subsystem can  be  found in  the
  ``doc/xml`` subdirectory.

- The library  reference manual, generated by Doxygen_,  is located in
  ``doc/ref``. It comes distributed as an archive of HTML files called
  ``ref.tar.gz``.

- Information about  the test suite generation mechanism  can be found
  in the file ``src/tests/test-suites/README``.

- There   are  some  demonstration   programs  distributed   with  the
  project.  See  the ``src/demos``  subdirectory.  Some  of these  are
  noteworthy:

  - Usage   examples  in   subdirectories   ``src/demos/samples``  and
    ``src/demos/xml/samples``.

  - Vaucanson-FSM (``src/demos/fsm/README.txt``) is aimed at providing
    an emulation of the FSM toolbox [3].

  - Vaucanswig  (``src/demos/vaucanswig/doc/README.txt``) is  aimed at
    providing a dynamic language interpreter to the Vaucanson library.

.. _Doxygen: http://www.doxygen.org

.. [3] http://www.research.att.com/~mohri/fsm/

88
89
90
91
Licence
=======

Vaucanson  is released under  the GNU  Lesser General  Public Licence.
92
See the file ``COPYING`` (at the root of the source tree) for details.
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121


Contacts
========

The team can be  reached by mail at ``vaucanson@lrde.epita.fr``. Snail
mail addresses follow.

* Vaucanson - ENST

  | Jacques Sakarovitch
  | 46, rue Barrault
  | F-75013 Paris
  | France

* Vaucanson - LIAFA

  | Sylvain Lombardy
  | 175, rue du Chevaleret
  | F-75013 Paris
  | France

* Vaucanson - LRDE

  | 24,rue Pasteur
  | Paristalie, batiment X, aile Mistral
  | F-94270 Le Kremlin Bicêtre cedex
  | France