Skip to content
Snippets Groups Projects
Commit d4edda0a authored by Liam M. Healy's avatar Liam M. Healy
Browse files

Improved docstrings

parent 1e4343e6
No related branches found
No related tags found
No related merge requests found
;; Linear least squares, or linear regression
;; Liam Healy <2008-01-21 12:41:46EST linear-least-squares.lisp>
;; Time-stamp: <2012-12-31 12:30:36EST linear-least-squares.lisp>
;; Time-stamp: <2013-01-01 21:29:30EST linear-least-squares.lisp>
;;
;; Copyright 2008, 2009, 2010, 2011, 2012 Liam M. Healy
;; Copyright 2008, 2009, 2010, 2011, 2012, 2013 Liam M. Healy
;; Distributed under the terms of the GNU General Public License
;;
;; This program is free software: you can redistribute it and/or modify
......@@ -64,7 +64,9 @@
computed using the weights and returned via the parameters
(cov00, cov01, c0v01) as the next three values. The weighted or
unweighted sum of squares of the residuals from the best-fit line,
\chi^2, is returned in as the last value.")
\chi^2, is returned as the last value.
Returns: c0, c1, cov00, cov01, cov11, sumsq.")
(defmfun linear-estimate (x c0 c1 cov00 cov01 cov11)
"gsl_fit_linear_est"
......
;; Elementary functions
;; Liam Healy, Mon Mar 20 2006 - 21:43
;; Time-stamp: <2011-10-29 23:35:51EDT elementary.lisp>
;; Time-stamp: <2012-12-30 10:59:51EST elementary.lisp>
;;
;; Copyright 2006, 2007, 2008, 2009, 2011 Liam M. Healy
;; Copyright 2006, 2007, 2008, 2009, 2011, 2012 Liam M. Healy
;; Distributed under the terms of the GNU General Public License
;;
;; This program is free software: you can redistribute it and/or modify
......@@ -24,14 +24,14 @@
"gsl_sf_multiply_e"
((x :double) (y :double) (ret (:pointer (:struct sf-result))))
:documentation ; FDL
"Multiplies x and y returning the product and associated error.")
"Multiplies two double-floats returning the product and associated error.")
(defmfun multiply-err (x dx y dy)
"gsl_sf_multiply_err_e"
((x :double) (dx :double) (y :double) (dy :double)
(ret (:pointer (:struct sf-result))))
:documentation ; FDL
"Multiplies x and y with associated absolute
"Multiplies two double floats x and y with associated absolute
errors dx and dy. The product xy +/- xy \sqrt((dx/x)^2 +(dy/y)^2)
is returned.")
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment