docs

[pspp] / src / math / histogram.h

diff --git a/src/math/histogram.h b/src/math/histogram.h
index 4c0e54fb0488ae38cd931684f52e472476463303..89d4f5e869e7e5a69c767c33546942c811131ab8 100644 (file)
--- a/src/math/histogram.h
+++ b/src/math/histogram.h
@@ -14,8 +14,8 @@
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
-#ifndef __NEW_HISTOGRAM_H__
-#define __NEW_HISTOGRAM_H__
+#ifndef __HISTOGRAM_H__
+#define __HISTOGRAM_H__
 
 #include <stddef.h>
 
@@ -30,7 +30,13 @@ struct histogram
   gsl_histogram *gsl_hist;
 };
 
-struct histogram * histogram_create (int bins, double max, double min);
+/*
+   Prepare a histogram for data which lies in the range [min, max)
+   bin_width is a nominal figure only.  It is a hint about what might be
+   an good approximate bin width, but the implementation will adjust it
+   as it thinks fit.
+ */
+struct histogram * histogram_create (double bin_width, double min, double max);
 
 void histogram_add (struct histogram *h, double y, double c);