Changeset ff87b8 in git


Ignore:
Timestamp:
Jun 5, 2014, 3:43:22 AM (9 years ago)
Author:
Oleksandr Motsak <motsak@…>
Branches:
(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')
Children:
c6573ff5338e7b1f606ac98942ea8efabad3e12c
Parents:
df6b8127c4a93e70fde851a509199b9da0e93d1a
git-author:
Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-06-05 03:43:22+02:00
git-committer:
Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-06-05 16:47:15+02:00
Message:
Better doxygen descriptions
Files:
1 deleted
21 edited

Legend:

Unmodified
Added
Removed

  • Singular/singular.dox

    rdf6b81 rff87b8  
    44 *
    55 * Singular can be easily extended by means of dynamic modules:
    6  * \subpage dynmodules_page
     6 * - \subpage dynmodules_page
    77 *
    88 * TODO: The sub-package structure is not yet defined for Singular package...

  • factory/factory.dox

    rdf6b81 rff87b8  
    1 /*! \page factory_page Factory
     1/*! \page factory_page Univariate polynomial factorization (factory)
    22 *
    33 * Factory is a C++ class library that implements a recursive representation
    … …  
    1313 *
    1414 * The interface to the polynomial system of Factory is provided by a single
    15  * class `CanonicalForm' which can deal with elements of the coefficient
     15 * class `\ref CanonicalForm' which can deal with elements of the coefficient
    1616 * domain as well as polynomials.
    1717 *

  • kernel/GBEngine/GBEngine.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_GBEngine_page "GB-based and related algorithms"
     1/*! \page kernel_GBEngine_page GB-based and related algorithms
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/combinatorics/combinatorics.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_combinatorics_page "Combinatorical algorithms"
     1/*! \page kernel_combinatorics_page Combinatorical algorithms
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/fglm/fglm.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_fglm_page "FGLM algorithms"
     1/*! \page kernel_fglm_page FGLM algorithms
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/groebner_walk/groebner_walk.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_groebner_walk_page "Groebner Walk algorithms"
     1/*! \page kernel_groebner_walk_page Groebner-Walk algorithms
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/kernel.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_page Kernel
     1/*! \page kernel_page More involved mathematical algorithms (kernel)
    22 *
    3  * Algorithms using libpolys (\ref libpolys_page) and other mathematical features.
     3 * Algorithms using \ref libpolys_page and other mathematical features for Singular.
    44 *
    55 * The files in kernel/ directory are combined into a internal library
    … …  
    88 * that can be shared among the following sub-packages:
    99 *
    10  * \subpage kernel_numeric_page
    11  * \subpage kernel_combinatorics_page
    12  * \subpage kernel_GBEngine_page
    13  * \subpage kernel_groebner_walk_page
    14  * \subpage kernel_fglm_page
    15  * \subpage kernel_maps_page
    16  * \subpage kernel_spectrum_page
    17  * \subpage kernel_linear_algebra_page
    18  * \subpage kernel_oswrapper_page
    19  *
    20  * just a sample:
    21  * \subpage kernel_sample_page
     10 * - \subpage kernel_numeric_page
     11 * - \subpage kernel_combinatorics_page
     12 * - \subpage kernel_GBEngine_page
     13 * - \subpage kernel_groebner_walk_page
     14 * - \subpage kernel_fglm_page
     15 * - \subpage kernel_maps_page
     16 * - \subpage kernel_spectrum_page
     17 * - \subpage kernel_linear_algebra_page
     18 * - \subpage kernel_oswrapper_page
    2219 *
    2320 */

  • kernel/linear_algebra/linear_algebra.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_linear_algebra_page "Linar algebra related algorithms"
     1/*! \page kernel_linear_algebra_page Linar algebra related algorithms
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/maps/maps.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_maps_page "Fast maps"
     1/*! \page kernel_maps_page Fast polynomial maps
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/numeric/numeric.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_numeric_page "Numeric algorithms"
     1/*! \page kernel_numeric_page Numerical algorithms for Singular
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/oswrapper/oswrapper.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_oswrapper_page "Wrappers over host OS functions"
     1/*! \page kernel_oswrapper_page Wrappers over host OS functions
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • kernel/spectrum/spectrum.dox

    rdf6b81 rff87b8  
    1 /*! \page kernel_spectrum_page "Spectrum-related algorithms"
     1/*! \page kernel_spectrum_page Spectrum-related algorithms
    22 *
    33 * This sub-package of kernel (\ref kernel_page) contains

  • libpolys/coeffs/coeffs.dox

    rdf6b81 rff87b8  
    1 /*! \page libpolys_coeffs_page Coeffs Sub-Package of libpolys
     1/*! \page libpolys_coeffs_page Coefficients for Singular rings and algebras
    22 *
    33 * Here we implement number arithmetic for some rings/fields (coeff. or number domains): \ref coeffs (Q, ZZ, etc?)

  • libpolys/coeffs/coeffs.h

    rdf6b81 rff87b8  
    572572
    573573
    574 /// @todo: Describe me!!! --> Hans
    575 ///
    576 /// !!! Recommendation: This method is to cryptic to be part of the user-
     574/// !!! Recommendation: This method is too cryptic to be part of the user-
    577575/// !!!                 interface. As defined here, it is merely a helper
    578576/// !!!                 method for parsing number input strings.

  • libpolys/libpolys.dox

    rdf6b81 rff87b8  
    1 /*! \page  libpolys_page Libpolys
     1/*! \page  libpolys_page Basic Data Structures for Singular (libpolys)
     2 *
    23 * This is a (mostly) separate package containing the definition and implementaion for
    34 * Singular data structures, such as,
    … …  
    67 * as well as related arithmetic and minimal necessary functionality.
    78 *
    8  * \subpage libpolys_misc_page
    9  * \subpage libpolys_reporter_page
    10  * \subpage libpolys_coeffs_page
    11  * \subpage libpolys_polys_page
     9 * - \subpage libpolys_misc_page
     10 * - \subpage libpolys_reporter_page
     11 * - \subpage libpolys_coeffs_page
     12 * - \subpage libpolys_polys_page
    1213 *
    1314 */

  • libpolys/misc/misc.dox

    rdf6b81 rff87b8  
    1 /*! \page libpolys_misc_page "Misc. things"
     1/*! \page libpolys_misc_page Miscellaneous things
    22 *
    3  * intvec, intvec64?, option, test, global vars?
     3 * - \ref intvec,
     4 * - \ref intvec64,
     5 * - \ref option, \ref test,
     6 * - and global vars...
     7 *
    48 * Common auxiliary.h is supposed to contain some generally useful macro
    59 *

  • libpolys/polys/polys.dox

    rdf6b81 rff87b8  
    1 /*! \page libpolys_polys_page "Polynomials and polynomial rings over coeff. domains"
     1/*! \page libpolys_polys_page Multivariate polynomial rings and algebras
    22 *
    33 * Here is the declaration and impelemntaion of a polynomial ring over a coeff. domain (\ref ring),

  • libpolys/reporter/reporter.dox

    rdf6b81 rff87b8  
    1 /*! \page libpolys_reporter_page "Reporter Sub-Package"
     1/*! \page libpolys_reporter_page Reporter
    22 *
    33 * The most basic printing and error/warning procedures

  • main.dox

    rdf6b81 rff87b8  
    1 /*! \mainpage Singular
    2  *
    3  * <A HREF="http://www.singular.uni-kl.de">CAS Singular</A>
    4  *
    5  * Main source repository is on github.
    6  * For more manuals see <A HREF="https://github.com/Singular/Sources/wiki/">WIKI</A>.
    7  *
    8  * Singular package diagram with dependencies is as follows:
    9  * \dotfile Includes.dot "Package diagram"
    10  *
    11  * Introductory description of separate packages follows:
    12  *
    13  * \tableofcontents
    14  *
    15  * \subpage omalloc_page
    16  * \subpage resources_page
    17  * \subpage factory_page
    18  * \subpage libpolys_page
    19  * \subpage kernel_page
    20  * \subpage singular_page
    21  *
     1/*! \mainpage Singular dev. manual
     2
     3<A HREF="http://www.singular.uni-kl.de">CAS Singular</A>
     4
     5Main source repository is on github.
     6For more manuals see <A HREF="https://github.com/Singular/Sources/wiki/">WIKI</A>.
     7
     8Singular package diagram with dependencies is as follows:
     9\dotfile Includes.dot Package diagram
     10
     11Introductory description of separate packages follows:
     12- \subpage omalloc_page
     13- \subpage resources_page
     14- \subpage factory_page
     15- \subpage libpolys_page
     16- \subpage kernel_page
     17- \subpage singular_page
     18
    2219 */

  • omalloc/omalloc.dox

    rdf6b81 rff87b8  
    1 /*! \page omalloc_page omalloc
     1/*! \page omalloc_page Singular memory manager for small chunks (omalloc)
    22 *
    33 * This is the Singular-specific memory manager which is tunned to
    … …  
    55 * size as efficient as it is possible (a few machine instructions in most cases).
    66 *
    7  * As described in my short intro to omalloc <A HREF="https://MY_OMALLOC_TALK?">short talk</A>
     7 * As described in my short intro to omalloc <A HREF="https://OLEKSANDR_OMALLOC_TALK?">short talk</A>
    88 * there are several usage possibilities (levels) of omalloc:
    9  * 1. low-level - very performant (with Bins)
    10  * 1. high-level - link against libomalloc and use the usual malloc and free
     9 * - low-level - very performant (with omalloc_Bin's)
     10 * - high-level - link against libomalloc and use the usual malloc and free
    1111 *
    1212 * For more details see
    … …  
    1414 *
    1515 * Note that this package has no further dependencies,
    16  * while it is used by the rest of Singular packages (\ref factory_page, \ref libpolys_page, \ref kernel_page, \ref singular_page)
     16 * while it is used by the rest of Singular packages
     17 * - \ref factory_page
     18 * - \ref libpolys_page
     19 * - \ref kernel_page
     20 * - \ref singular_page
    1721 *
    1822 */

  • resources/resources.dox

    rdf6b81 rff87b8  
    1 /*! \page resources_page This is a package that handled the system environment variables and especially the search path for Singular resources.
     1/*! \page resources_page System environment and resource management
    22 *
    3  * Handles the system environment variables and especially
    4  * the search path for Singular resources (like libraries and modules)
     3 * This is a package that handled the system environment variables and especially the search path for Singular resources (like libraries and modules).
    54 *
    65 * This may be used by factory in order to search for its precomputed
    … …  
    87 *
    98 * Note that this package has no further dependencies,
    10  * while it is used by the rest of Singular packages (\ref factory_page, \ref libpolys_page, \ref kernel_page, \ref singular_page).
     9 * while it is used by the rest of Singular packages:
     10 * - \ref factory_page,
     11 * - \ref libpolys_page,
     12 * - \ref kernel_page,
     13 * - \ref singular_page.
    1114 *
    1215 */
Note: See TracChangeset for help on using the changeset viewer.