Changeset a16c0d in git


Ignore:
Timestamp:
Jul 21, 1997, 1:16:04 PM (27 years ago)
Author:
Jens Schmidt <schmidt@…>
Branches:
(u'spielwiese', '82fc009ea2b0098c1a4896c841bb70860976bdfc')
Children:
88f1ee3d9c5170dcdc7ca2c8a5d84119388cfec0
Parents:
c9923b811c92bcc9112ff6f0f7be7bf412c1ada7
Message:
	* README: doc fix


git-svn-id: file:///usr/local/Singular/svn/trunk@546 2c84dea3-7e68-4137-9b89-c4e89433aadc
File:
1 edited

Legend:

Unmodified
Added
Removed
  • factory/README

    rc9923b8 ra16c0d  
    4242Factorization of multivariate polynomials over the integers is in beta test
    4343stage.
     44
     45
     46Installation
     47------------
     48  See the INSTALL file for instructions on how to install Factory.  The
     49installation procedure conforms more or less to the GNU standard:
     50
     51  ./configure; make; make gftables; make install; make installgftables
     52
     53However, I recommend to read the instructions since there are a lot of
     54non-standard options to configure.
     55
     56
     57
     58Distribution
     59------------
     60  The newest version of Factory is always available by anonymous ftp from
     61
     62                www.mathematik.uni-kl.de:/pub/Math/Factory
     63
     64The Factory distribution consists of three archives:
     65
     66o the Factory source code (factory-<version>.tgz);
     67o some preliminary documentation on Factory (factory-doc-prelim.tgz);
     68o Factory GF(q) addition tables (see below).
    4469
    4570
     
    5479version of Singular (not recommended).
    5580
    56 
    57 Installation
    58 ------------
    59   See the INSTALL file for instructions on how to install Factory.  The
    60 installation procedure conforms more or less to the GNU standard
    61 (configure; make; make install).  However, I recommend to read the
    62 instructions since there are a lot of non-standard options to configure.
    63 
    64 
    65 Distribution
    66 ------------
    67   The newest version of Factory is always available by anonymous ftp from
    68 
    69                 www.mathematik.uni-kl.de:/pub/Math/Factory
    70 
    71 The Factory distribution consists of three archives:
    72 
    73 o the Factory source code (factory-<version>.tgz);
    74 o some preliminary documentation on Factory (factory-doc-prelim.tgz);
    75 o Factory GF(q) addition tables (see below).
    76 
    77 
    78 Documentation
    79 -------------
    80   So far there are only preliminary versions of a user/reference manual and
    81 a tutorial (``A quick start into Factory'').  Please do not expect them to
    82 be complete or even error-free.  For this reason, the documentation is not
    83 included in the source code archive (factory-<version>.tgz).  Instead, you
    84 sources and compiled dvi files reside in factory-doc-prelim.tgz. They will
    85 unpack into a directory factory-doc-prelim/.
     81Configure options:
     82~~~~~~~~~~~~~~~~~~
     83  --with-gmp(=<gmp_inc_path>(,<gmp_lib_path>))
     84                          specify where to find gmp library.
     85  --enable-gmp            together with --with-Singular means: installation
     86                          in process, be graceful when there is no gmp.h
     87
     88  If <gmp_lib_path> is not given, but <gmp_inc_path> is,
     89'<gmp_inc_path>../lib/' is used as <gmp_lib_path>.  If neither
     90<gmp_lib_path> nor <gmp_inc_path> is specified, configure looks in the
     91standard system locations for GMP.
     92
     93  Furthermore, you may specify the symbolic directory '$(includedir)' for
     94<gmp_inc_path>:
     95
     96  --with-gmp='$(includedir)'
     97
     98  This is useful when Factory is delivered as a part of a larger package
     99which also provides the GMP library.  In this case, at configuration time
     100there will not be any gmp.h.  Without this option, Factory's configure
     101script will exit with an error message.  If this symbolic directory is
     102given, the configure script will not look for gmp.h and libgmp.a.  Rather,
     103it will add the option '-I$(includedir)' to its $(CXXFLAGS) and the option
     104'-L$(libdir)' to its $(LDFLAGS) assuming that at compilation time gmp.h and
     105libgmp.a will reside in these directories.
     106  The option --enable-gmp does the same, but it is a special (and ugly)
     107gift to Singular, so it may be used with option --with-Singular only.
     108
     109
     110
     111Memory manager
     112--------------
     113  You can use one of the memory managment tools provided with Factory.
     114There are the 'new' and the 'old' memory manager.  In fact, on some systems
     115the 'old' memory managment seems to be faster then the new one, but so far
     116there have not been systematic timings.
     117  You may trace the actions (alloc/free) of the new memory manager by
     118enabling memory managment.  This produces a *lot* of output.
     119
     120Configure options:
     121~~~~~~~~~~~~~~~~~~
     122  --with-memman(=<memman>) specify factory memory manager.
     123                          <memman> is either 'old' (default), 'new', or 'no'.
     124  --enable-memdebug=<level> switch on memory managment debugging.  Meaningful
     125                          with --with-memman=new only.  <level> may be either
     126                          'no' (default), 'normal', or 'full'.
     127
     128
     129Stream IO
     130---------
     131  For use with other systems which have there own IO routines to print
     132polynomials it is possible to switch of Factory's stream IO.  In this case,
     133you do not need to link libg++ or libiostream with Factory.
     134
     135Configure options:
     136~~~~~~~~~~~~~~~~~~
     137  --disable-streamio      build factory without streamio
     138
     139
     140Diagnostic messages
     141-------------------
     142Factory has three types of diagnostic messages:
     143- Assertions (implemented by the ASSERT macros in assert.h) are used to
     144  ensure preconditions before running an algorithm.  A typical example is
     145  to test f != 0 before dividing by f.
     146- Debugoutput (implemented by the DEBOUT macros in debug.h/debug.cc) is
     147  used to trace complex algorithms, e.g. factorization.
     148- Timing information may be accumulated and printed using the TIMING macros
     149  in timing.h
     150
     151  Since all diagnostic messages are implemented using preprocessor macros,
     152they will completely cease when disbled, thus avoiding any impact on speed.
     153For more information, see section 'Configuring and building Factory for
     154 different configurations' in the INSTALL file.
     155
     156Configure options:
     157~~~~~~~~~~~~~~~~~~
     158  --enable-assertions     build factory with assertions activated
     159  --enable-timing         build factory so it will print timing information
     160  --enable-debugoutput    build factory so it will print debugging information
     161
    86162
    87163
     
    89165------------
    90166  Factory uses addition tables to calculate in GF(p^n) in an efficient way.
     167
     168NOTE: Since the format of the GF(q) tables changed from Factory Version
     1691.2b to Factory Version 1.3a you should get/create them by new!
     170
    91171There are two possibilities to get these tables:
    92172o you get them from the net (factory-gftables.tgz) where you got Factory
     
    95175  the tables takes quite a while!
    96176See the INSTALL file for more information.
    97 
    98 
    99 Examples and Tests
    100 ------------------
    101   So far neither examples nor tests, sorry.  You may have a look at
    102 gengftables.cc which is an application of the most basic Factory features.
    103177
    104178
     
    111185Singulars configure do the work you should:
    112186
    113 configure --with-Singular --enable-gmp
     187  ./configure --with-Singular --enable-gmp
    114188        (or, equivalently: )
    115 configure --with-Singular --with-gmp='${includedir}'
    116 
    117   Furthermore, you should specify --prefix so 'gmake install' will install
     189  ./configure --with-Singular --with-gmp='${includedir}'
     190
     191  Furthermore, you should specify --prefix so 'make install' will install
    118192the files in the places where Singular looks for them.  By default, this is
    119193the top directory of the Singular distribution.  In this case you have to
    120194specify '--prefix=..'.
     195
     196  The Singular GF(q) tables are the same as the Factory GF(q) tables.
     197However, Singular uses a different naming scheme.  Therefore, a Factory
     198configured with '--with-Singular' will not find the GF(q) tables created by
     199gengftables.  But this is not a major drawback since Singular is
     200distributed with ready-to-use GF(q) tables.
     201
     202Configure options:
     203~~~~~~~~~~~~~~~~~~
     204  --with-Singular         build for use with computer algebra system Singular.
     205
     206  Except from setting the #define SINGULAR, this option only changes the
     207defaults to: '--with-memman=no --disable-streamio'.
     208
     209
     210
     211Configure options, dependencies
     212-------------------------------
     213- do not configure --with-Singular --with-memman.  In this case
     214  both Singular and the library will try to initialize memory
     215  managment.
     216
     217- do not configure --disable-streamio --enable-debugoutput.  The
     218  DEBOUT macros need stream IO.
     219
     220- you may configure --with-Singular --enable-streamio, but this
     221  is not supported by Singular.  You will have to change manually
     222  Singular's Makefile.  The same is true for --with-Singular
     223  --enable-debugoutput.
     224
     225- you may configure --with-Singular --enable-timing, but this
     226  will not have any visible effect (except from a slightly slower
     227  running time) because Singular will not print the timing
     228  results.
     229
     230- --enable-gmp has an effect only together with --with-Singular
     231
     232- --with-memdebug has an effect only together with
     233  --with-memman=new
     234
     235
     236Documentation
     237-------------
     238  So far there are only preliminary versions of a user/reference manual and
     239a tutorial ('A quick start into Factory').  Please do not expect them to
     240be complete or even error-free.  For this reason, the documentation is not
     241included in the source code archive (factory-<version>.tgz).  Instead, the
     242sources and compiled dvi files reside in factory-doc-prelim.tgz. They will
     243unpack into a directory factory-doc-prelim/.
     244
     245
     246Examples and Tests
     247------------------
     248  So far neither examples nor tests, sorry.  You may have a look at
     249gengftables.cc which is an application of the most basic Factory features.
    121250
    122251
     
    128257let me know (e-mail: Jens Schmidt <schmidt@mathematik.uni-kl.de>).
    129258Comments and questions are welcome, too.
     259
    130260
    131261
Note: See TracChangeset for help on using the changeset viewer.