Changeset 5605 in project


Ignore:
Timestamp:
08/22/07 10:25:37 (12 years ago)
Author:
Ivan Raikov
Message:

Added some descriptions to the eggdoc documentation; updates in the meta and setup files.

Location:
blas/branches/safe
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • blas/branches/safe/blas-eggdoc.scm

    r5548 r5605  
    1111     (description "An interface to level 1, 2 and 3 BLAS linear algebra routines.")
    1212
    13      (author (url "mailto:felix@call-with-current-continuation.org" "Felix Winkelmann") " and "
    14              (url "mailto:raikov@cc.gatech.edu" "Ivan Raikov"))
     13     (author ((url "mailto:felix@call-with-current-continuation.org" "Felix Winkelmann") " and "
     14              (url "mailto:iraikov@ece.gatech.edu" "Ivan Raikov")))
    1515
    1616     (history
     
    8484                     (td (i "unsafe-blas:zgemm!"))))))
    8585             
    86       (subsection "BLAS level 1 routines"
     86      (subsection "BLAS level 1 routines" )
    8787
    88       (subsection "BLAS level 2 routines"
     88      (subsection "BLAS level 2 routines")
    8989
    9090      (subsection "BLAS level 3 routines"
     91                  (subsubsection "General matrix multiply-add"
     92                   (procedure  "blas:sgemm:: ORDER * TRANSA * TRANSB * M * N * K * ALPHA * A * B * BETA * C [LDA * LDB * LDC] -> F32VECTOR "
     93                       (procedure  "blas:dgemm:: ORDER * TRANSA * TRANSB * M * N * K * ALPHA * A * B * BETA * C [LDA * LDB * LDC] -> F64VECTOR ")
     94                       (procedure  "blas:cgemm:: ORDER * TRANSA * TRANSB * M * N * K * ALPHA * A * B * BETA * C [LDA * LDB * LDC] -> F32VECTOR ")
     95                       (procedure  "blas:zgemm:: ORDER * TRANSA * TRANSB * M * N * K * ALPHA * A * B * BETA * C [LDA * LDB * LDC] -> F64VECTOR ")
     96                               
     97                       (p (tt "xGEMM") " performs matrix-matrix multiply-add operation of the form "
     98                          (tt "C := alpha*op( A )*op( B ) + beta*C") ", where " (tt "op( X )") " is "
     99                          "one of " (tt "op( X ) = X") " or " (tt "op( X ) = X'") ". ")
     100                       (p (tt "ALPHA") " and " (tt "BETA") " are  scalars, and " (tt "A") ", " (tt "B")
     101                          " and " (tt "C") " are matrices, with " (tt "op( A )") " an " (tt "M x K")
     102                          " matrix, "  (tt "op( B )") " a " (tt "K x N") " matrix and " (tt "C")
     103                          " an " (tt "M x N") " matrix. ")))
     104                  ))
    91105
    92 fsig: (blas:sgemm order transA transB m n k alpha a b beta c . rest)
    93 fsig: (blas:dgemm order transA transB m n k alpha a b beta c . rest)
    94 fsig: (blas:cgemm order transA transB m n k alpha a b beta c . rest)
    95 fsig: (blas:zgemm order transA transB m n k alpha a b beta c . rest)
     106     (examples (pre #<<EOF
    96107
    97 fsig: (blas:ssymm order side uplo m n alpha a b beta c . rest)
    98 fsig: (blas:dsymm order side uplo m n alpha a b beta c . rest)
    99 fsig: (blas:csymm order side uplo m n alpha a b beta c . rest)
    100 fsig: (blas:zsymm order side uplo m n alpha a b beta c . rest)
     108(require-extension srfi-4)
     109(require-extension blas)
    101110
    102 fsig: (blas:chemm order side uplo m n alpha a b beta c . rest)
    103 fsig: (blas:zhemm order side uplo m n alpha a b beta c . rest)
     111(define order blas:ColMajor)
     112(define n 4)
    104113
    105 fsig: (blas:ssyrk order uplo trans n k alpha a beta c . rest)
    106 fsig: (blas:dsyrk order uplo trans n k alpha a beta c . rest)
    107 fsig: (blas:csyrk order uplo trans n k alpha a beta c . rest)
    108 fsig: (blas:zsyrk order uplo trans n k alpha a beta c . rest)
     114EOF
     115))
    109116
    110 fsig: (blas:cherk order uplo trans n k alpha a beta c . rest)
    111 fsig: (blas:zherk order uplo trans n k alpha a beta c . rest)
     117     (license
     118"Copyright (c) 2003-2006, Felix L. Winkelmann
     119Copyright (c) 2007, Ivan Raikov
    112120
    113 fsig: (blas:ssyr2k order uplo trans n k alpha a b beta c . rest)
    114 fsig: (blas:dsyr2k order uplo trans n k alpha a b beta c . rest)
    115 fsig: (blas:csyr2k order uplo trans n k alpha a b beta c . rest)
    116 fsig: (blas:zsyr2k order uplo trans n k alpha a b beta c . rest)
     121All rights reserved.
    117122
    118 fsig: (blas:cher2k order uplo trans n k alpha a b beta c . rest)
    119 fsig: (blas:zher2k order uplo trans n k alpha a b beta c . rest)
     123Redistribution and use in source and binary forms, with or without
     124modification, are permitted provided that the following conditions are
     125met:
    120126
    121 fsig: (blas:strmm order side uplo transA diag m n alpha a b . rest)
    122 fsig: (blas:dtrmm order side uplo transA diag m n alpha a b . rest)
    123 fsig: (blas:ctrmm order side uplo transA diag m n alpha a b . rest)
    124 fsig: (blas:ztrmm order side uplo transA diag m n alpha a b . rest)
     127  Redistributions of source code must retain the above copyright
     128notice, this list of conditions and the following disclaimer.
    125129
    126 fsig: (blas:strsm order side uplo transA diag m n alpha a b . rest)
    127 fsig: (blas:dtrsm order side uplo transA diag m n alpha a b . rest)
    128 fsig: (blas:ctrsm order side uplo transA diag m n alpha a b . rest)
    129 fsig: (blas:ztrsm order side uplo transA diag m n alpha a b . rest)
     130  Redistributions in binary form must reproduce the above copyright
     131notice, this list of conditions and the following disclaimer in the
     132documentation and/or other materials provided with the distribution.
     133
     134  Neither the name of the author nor the names of its contributors may
     135be used to endorse or promote products derived from this software
     136without specific prior written permission.
     137
     138THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     139CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
     140BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
     141FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     142COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     143INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     144BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
     145OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     146ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
     147TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
     148USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
     149DAMAGE."))))
     150
     151
     152(if (eggdoc->html doc) (void))
     153
     154
     155;; fsig: (blas:ssymm order side uplo m n alpha a b beta c . rest)
     156;; fsig: (blas:dsymm order side uplo m n alpha a b beta c . rest)
     157;; fsig: (blas:csymm order side uplo m n alpha a b beta c . rest)
     158;; fsig: (blas:zsymm order side uplo m n alpha a b beta c . rest)
     159
     160;; fsig: (blas:chemm order side uplo m n alpha a b beta c . rest)
     161;; fsig: (blas:zhemm order side uplo m n alpha a b beta c . rest)
     162
     163;; fsig: (blas:ssyrk order uplo trans n k alpha a beta c . rest)
     164;; fsig: (blas:dsyrk order uplo trans n k alpha a beta c . rest)
     165;; fsig: (blas:csyrk order uplo trans n k alpha a beta c . rest)
     166;; fsig: (blas:zsyrk order uplo trans n k alpha a beta c . rest)
     167
     168;; fsig: (blas:cherk order uplo trans n k alpha a beta c . rest)
     169;; fsig: (blas:zherk order uplo trans n k alpha a beta c . rest)
     170
     171;; fsig: (blas:ssyr2k order uplo trans n k alpha a b beta c . rest)
     172;; fsig: (blas:dsyr2k order uplo trans n k alpha a b beta c . rest)
     173;; fsig: (blas:csyr2k order uplo trans n k alpha a b beta c . rest)
     174;; fsig: (blas:zsyr2k order uplo trans n k alpha a b beta c . rest)
     175
     176;; fsig: (blas:cher2k order uplo trans n k alpha a b beta c . rest)
     177;; fsig: (blas:zher2k order uplo trans n k alpha a b beta c . rest)
     178
     179;; fsig: (blas:strmm order side uplo transA diag m n alpha a b . rest)
     180;; fsig: (blas:dtrmm order side uplo transA diag m n alpha a b . rest)
     181;; fsig: (blas:ctrmm order side uplo transA diag m n alpha a b . rest)
     182;; fsig: (blas:ztrmm order side uplo transA diag m n alpha a b . rest)
     183
     184;; fsig: (blas:strsm order side uplo transA diag m n alpha a b . rest)
     185;; fsig: (blas:dtrsm order side uplo transA diag m n alpha a b . rest)
     186;; fsig: (blas:ctrsm order side uplo transA diag m n alpha a b . rest)
     187;; fsig: (blas:ztrsm order side uplo transA diag m n alpha a b . rest)
  • blas/branches/safe/blas.meta

    r5544 r5605  
    11;;; blas.meta -*- Hen -*-
    22
    3 ((date "2003-04-17")
    4  (egg "blas.egg")
     3((egg "blas.egg")
     4
    55 (synopsis "An interface to level 1, 2 and 3 BLAS routines")
     6
    67 (license "BSD")
     8
    79 (category math)
    8  (needs easyffi)
    9  (author
    10    "<a href=\"mailto:felix@call-with-current-continuation.org\">felix</a>")
    11  (files "blas.setup" "blas.scm" "blas.html"))
     10
     11 (needs easyffi testbase)
     12
     13 (author "<a href=\"mailto:felix@call-with-current-continuation.org\">felix</a>")
     14
     15 (files "blas.setup" "blas.scm" "blas-eggdoc.scm"))
  • blas/branches/safe/blas.setup

    r5544 r5605  
    2121  ("<Accelerate/Accelerate.h>" . "-framework Accelerate"))
    2222
    23 (compile -s  -d2 blas.scm -emit-exports blas.exports -L "\"" ,ld-options "\"" -X easyffi)
     23(run (csi -qbs blas-eggdoc.scm > blas.html))
     24
     25(compile -s -d0 -O3 blas.scm -emit-exports blas.exports -L "\"" ,ld-options "\"" -X easyffi)
    2426
    2527(install-extension
    2628 'blas
    27  "blas.so"
    28  '((version 1.8)
     29 `("blas.so" "blas.html" "blas.exports")
     30 '((version 2.0)
    2931   (documentation "blas.html")
    3032   (exports "blas.exports") ) )
Note: See TracChangeset for help on using the changeset viewer.