math: Improve comments.
[pspp] / src / math / np.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2008, 2009 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #ifndef __NP_H__
18 #define __NP_H__
19
20 #include "order-stats.h"
21
22 struct casewriter;
23
24 enum
25   {
26     NP_IDX_Y = 0,
27     NP_IDX_NS,
28     NP_IDX_DNS,
29     n_NP_IDX
30   };
31
32 /* Statistics needed to produce a normal probability plot with
33    np_plot_create(). */
34 struct np
35 {
36   struct order_stats parent;
37
38   double n;
39   double mean;
40   double stddev;
41
42   double prev_cc;
43
44   double ns_min;
45   double ns_max;
46
47   double dns_min;
48   double dns_max;
49
50   double y_min;
51   double y_max;
52
53   struct casewriter *writer;
54 };
55
56
57 struct np * np_create (double n, double mean, double var);
58
59 #endif