Skip to content

Commit 039b22f

Browse files
committed
added brief descriptions on the new folders in the source code
1 parent b02bdb0 commit 039b22f

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

src/doc/source/refman.rst

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,14 +306,16 @@ polynomials in the system.
306306
For sparse system, the information of the Newton polytopes provides
307307
a much sharper root count than the ones provided by the degrees.
308308

309-
There are eight subdirecties in the ``Root_Counts`` directory.
309+
There are nine subdirecties in the ``Root_Counts`` directory.
310310
Total degree and linear-product start systems are constructed
311311
in the subdirectory ``Product``. The subdirectory ``Binomials``
312312
provides solvers for the sparsest polynomial systems.
313313
The subdirectories ``Implift``, ``Stalift``, and ``Dynlift``
314314
implement polyhedral homotopies, respectively with implicit,
315315
static, and dynamic lifting methods. In ``MixedVol`` is an
316316
adaptation of a fast mixed volume calculator.
317+
The code in the folder ``DEMiCs`` applies dynamic enumeration
318+
to compute mixed cells.
317319
Code to exploit permutation symmetry is in the subdirectory ``Symmetry``.
318320
A generalization of the Newton-Puiseux algorithm is implemented in
319321
the subdirectory ``Puiseux``.
@@ -391,6 +393,8 @@ The directory ``CtoPHC`` has two subdirectories, ``Funky`` and ``State``,
391393
which define two different types of interfacing the Ada code with C.
392394
The first type is a functional interface, the second type is an interface
393395
which operates as a state machine.
396+
The first folder ``Types`` in ``CtoPHC`` defines the equivalenties
397+
between the basic array types in C and in Ada.
394398

395399
In a functional interface, the main C program calls an Ada function,
396400
which then calls a C function to process the results computed by the
@@ -406,7 +410,9 @@ The subdirectory ``State`` contains the definition of the
406410
``use_c2phc`` function, which defines more than 700 jobs.
407411
The implementation of this function relies on various container
408412
packages which hold the persistent objects, mainly polynomial systems
409-
and solution lists.
413+
and solution lists. Those container types are defined in the folder
414+
``Structures`` intended to give the C programming access to the main
415+
data structures.
410416

411417
If the main program is not an Ada procedure, but a C function,
412418
then ``adainit`` and ``adafinal`` must be called by the C code,
@@ -789,6 +795,9 @@ either with a QR or an SVD decomposition.
789795
To solve Hermite-Laurent interpolation problems,
790796
a lower triangular echelon form is provided.
791797

798+
The directory ``Laurent`` contains code to work with series
799+
that have a leading terms with negative or positive exponents.
800+
792801
Homotopies, Newton's Method, and Path Trackers
793802
==============================================
794803

@@ -1196,6 +1205,18 @@ for comparison and correctness verification.
11961205

11971206
The code is restricted for randomly generated lifting values.
11981207

1208+
DEMiCs applies dynamic enumeration to compute mixed cells
1209+
---------------------------------------------------------
1210+
1211+
The code in the directory ``DEMiCs`` was developed by
1212+
Tomohiko Mizutani, Akiko Takeda, and Masakazu Kojima.
1213+
The directory contains the original code with a basic interface
1214+
and a second interface that calls the code modified with
1215+
callback functions.
1216+
1217+
The pace at which the mixed cells are computed is faster than
1218+
MixedVol which is beneficial for pipelined polyhedral homotopies.
1219+
11991220
The Newton-Puiseux Method
12001221
-------------------------
12011222

0 commit comments

Comments
 (0)