aboutsummaryrefslogtreecommitdiff
path: root/math/curfit/doc/cvinit.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /math/curfit/doc/cvinit.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'math/curfit/doc/cvinit.hlp')
-rw-r--r--math/curfit/doc/cvinit.hlp55
1 files changed, 55 insertions, 0 deletions
diff --git a/math/curfit/doc/cvinit.hlp b/math/curfit/doc/cvinit.hlp
new file mode 100644
index 00000000..dc891ed2
--- /dev/null
+++ b/math/curfit/doc/cvinit.hlp
@@ -0,0 +1,55 @@
+.help cvinit Jun84 "Curfit Package"
+.ih
+NAME
+cvinit -- initialise curve descriptor
+.ih
+SYNOPSIS
+include <math/curfit.h>
+
+cvinit (cv, curve_type, order, xmin, xmax)
+
+.nf
+pointer cv # curve descriptor
+int curve_type # the fitting function
+int order # order of the fit
+real xmin # minimum x value
+real xmax # maximum x value
+.fi
+.ih
+ARGUMENTS
+.ls cv
+Pointer to the curve descriptor structure.
+.le
+.ls curve_type
+Fitting function.
+Permitted values are LEGENDRE and CHEBYSHEV, for Legendre and
+Chebyshev polynomials and SPLINE3 and SPLINE1 for a cubic spline
+and linear spline with uniformly spaced
+break points.
+.le
+.ls order
+Order of the polynomial to be fit or the number of polynomial pieces
+to be fit by a cubic spline. Order must be greater than or equal to one.
+If curve_type is set to LEGENDRE or CHEBYSHEV and order equals one, a constant
+term is fit to the data.
+.le
+.ls xmax, xmin
+Minimum and maximum x values. All x values of interest
+including the data x values and the x values of any curve to be evaluated
+must fall in the range xmin <= x <= xmax. Checking for out of bounds x
+values is the responsibility of user.
+.le
+.ih
+DESCRIPTION
+Allocate space for the curve descriptor structure and the arrays and
+vectors used by the numerical routines. Initialize all arrays and vectors
+to zero. Return the
+curve descriptor to the calling routine.
+.ih
+NOTES
+CVINIT must be the first CURFIT routine called. CVINIT returns if an
+illegal curve type is requested.
+.ih
+SEE ALSO
+cvfree
+.endhelp