From 585232633d2b19cb37d29b3be54972544489a957 Mon Sep 17 00:00:00 2001 From: Gerd Heber Date: Thu, 6 Aug 2015 19:32:12 -0500 Subject: [PATCH] Documentation updates. --- src/chain-complexes.lisp | 31 ++++++++++++++++++++++++++++--- src/classes.lisp | 3 +-- src/combinations.lisp | 10 +++++----- src/macros.lisp | 12 ++++++------ 4 files changed, 40 insertions(+), 16 deletions(-) diff --git a/src/chain-complexes.lisp b/src/chain-complexes.lisp index b11d393..db38bf9 100644 --- a/src/chain-complexes.lisp +++ b/src/chain-complexes.lisp @@ -222,7 +222,8 @@ IDNUM or NIL, if it doesn't exist." "--------------------------------------------------------------[function-doc] BUILD-CHCM Args: (&key cmpr basis bsgn intr-dffr strt orgn) -Returns an instance of CHAIN-COMPLEX. The keyword arguments are as follows: +Returns an instance of the class CHAIN-COMPLEX. The keyword arguments are as +follows: :CMPR CMPR, the comparison function for generators @@ -289,8 +290,32 @@ MAKE-INSTANCE. (type (or intr-mrph null) intr) (type strt strt) (list orgn)) - "Returns an instance of MORPHISM. Use this function instead of creating -instances via the standard constructor MAKE-INSTANCE." + "--------------------------------------------------------------[function-doc] +BUILD-MRPH +Args: (&key sorc trgt degr intr strt orgn) +Returns an instance of the class MORPHISM. The keyword arguments are as +follows: + +:SORC SORC, the source object, a CHAIN-COMPLEX type object + +:TRGT TRGT, the target object, a CHAIN-COMPLEX type object + +:DEGR DEGR, the degree of the morphism, an integer + +:INTR INTR, the Lisp function defining the effective mapping + +:STRT STRT, one of the keywords :GNRT or :CMBN, defining the mapping strategy + of the differential homomorphism, either by generator or by + combination. The default is :GNRT + +:ORGN ORGN, a list containing a relevant and carefully chosen comment about + the origin of the chain complex. This comment should be unique + for a Kenzo session (between calls of CAT-INIT), as it is used + for caching purposes. + +Use this function instead of creating instances via the standard constructor +MAKE-INSTANCE. +------------------------------------------------------------------------------" (the morphism (progn (let ((already (find orgn *mrph-list* :test #'equal :key #'orgn))) diff --git a/src/classes.lisp b/src/classes.lisp index 7095b91..6aee627 100644 --- a/src/classes.lisp +++ b/src/classes.lisp @@ -165,8 +165,7 @@ CHAIN-COMPLEX Slots: (cmps basis bsgn dffr grmd efhm idnm orgn) Intances of this class represent chain complexes. The class has 8 slots: -1. CMPR, a comparison function or method for generators, which returns :LESS, - :EQUAL, or :GREATER. +1. CMPR, a comparison function or method for generators. 2. BASIS, a Lisp function, which returns the ordered basis of the free Z-modules (C_p), or the keyword :LOCALLY-EFFECTIVE. diff --git a/src/combinations.lisp b/src/combinations.lisp index da4b900..db15957 100644 --- a/src/combinations.lisp +++ b/src/combinations.lisp @@ -518,8 +518,8 @@ the result combination. "--------------------------------------------------------------[function-doc] CMBN-CMBN Args: (cmpr n-cmbn-list) -Returns the linear combination of a list of integer/combination pairs. The first -argument, CMPR, must be a function or macro, which is used to compare the +Returns the linear combination of a list of integer/combination pairs. The +first argument, CMPR, must be a function or macro, which is used to compare the generators of the input combinations and to order the terms of the result combination. The second argument, N-CMBN-LIST, is a list dotted pairs (CONSes), where the first element is a non-zero integer and the second element is a @@ -574,9 +574,9 @@ combination. "--------------------------------------------------------------[function-doc] NTERM-ADD Args: (cmpr degr &rest rest) -Returns a combination of degree DEGR which is the sum of terms supplied in REST. -The first argument, CMPR, must be a function or macro, which is used to compare -the generators of the input terms and to order the terms of the result +Returns a combination of degree DEGR which is the sum of terms supplied in +REST. The first argument, CMPR, must be a function or macro, which is used to +compare the generators of the input terms and to order the terms of the result combination. If REST is NIL, an instance of the null combination of degree DEGR is returned. ------------------------------------------------------------------------------" diff --git a/src/macros.lisp b/src/macros.lisp index e022bd2..b6c27b0 100644 --- a/src/macros.lisp +++ b/src/macros.lisp @@ -100,7 +100,7 @@ (DEFMACRO TERM-CMBN (degr cffc gnrt) - "------------------------------------------------------------------[macro-doc] + "-----------------------------------------------------------------[macro-doc] TERM-CMBN Args: (degr cffc gnrt) Returns the combination of degree DEGR with the only term CFFC*GNRT. @@ -110,7 +110,7 @@ Returns the combination of degree DEGR with the only term CFFC*GNRT. (DEFMACRO CMBN-NON-ZERO-P (cmbn) - "------------------------------------------------------------------[macro-doc] + "-----------------------------------------------------------------[macro-doc] CMBN-NON-ZERO-P Args: (cmbn) Tests if the combination CMBN is a non-null combination of any degree. @@ -119,7 +119,7 @@ Tests if the combination CMBN is a non-null combination of any degree. (DEFMACRO CMBN-ZERO-P (cmbn) - "------------------------------------------------------------------[macro-doc] + "-----------------------------------------------------------------[macro-doc] CMBN-ZERO-P Args: (cmbn) Tests if the combination CMBN is the null combination of any degree. @@ -147,7 +147,7 @@ Tests if the combination CMBN is the null combination of any degree. ;;; (DEFMACRO CMPR (&rest rest) - "------------------------------------------------------------------[macro-doc] + "-----------------------------------------------------------------[macro-doc] CMPR Args: (&rest rest) Args: (chcm gnrt1 gnrt2) @@ -165,7 +165,7 @@ return the result. (DEFMACRO BASIS (&rest rest) - "------------------------------------------------------------------[macro-doc] + "-----------------------------------------------------------------[macro-doc] BASIS Args: (&rest rest) Args: (chcm) @@ -191,7 +191,7 @@ This function returns an error if the chain complex is locally effective. (DEFMACRO DFFR (&rest rest) - "------------------------------------------------------------------[macro-doc] + "-----------------------------------------------------------------[macro-doc] DFFR Args: (&rest rest) Args: (chcm cmbn)