v.kcv manual updated; main.c header cosmetics

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@60025 15284696-431f-4ddb-bdfa-cd5b030d7da7

vector/v.kcv/main.c

@@ -3,13 +3,13 @@
  *
  * MODULE:     v.kcv
  *
- * AUTHOR(S):  James Darrell McCauley darrell@mccauley-usa.com
+ * AUTHOR(S):  James Darrell McCauley darrell@mccauley-usa.com (1993-1994)
  *             OGR support by Martin Landa <landa.martin gmail.com> (2009)
- *             Spped-up by Jan Vandrol and Jan Ruzicka (2013)
+ *             Speed-up by Jan Vandrol and Jan Ruzicka (2013)
  *
  * PURPOSE:    Randomly partition points into test/train sets.
  *
- * COPYRIGHT:  (C) 2001-2009 by James Darrell McCauley, and the GRASS Development Team
+ * COPYRIGHT:  (C) 2001-2014 by James Darrell McCauley, and the GRASS Development Team
  *
  *             This program is free software under the GNU General
  *             Public License (>=v2).  Read the file COPYING that

vector/v.kcv/v.kcv.html

@@ -1,45 +1,70 @@
 <h2>DESCRIPTION</h2>
-       <I>v.kcv</I>  randomly  divides  a  points  lists  into  <I>k</I> sets of
-       test/train data (for <b>k</b>-fold <b>c</b>ross <b>v</b>alidation).
-       Test  partitions  are  mutually  exclusive.  That  is,  a point will
-       appear in only one test partition and <I>k-1</I> training  partitions.
-
-       The  program  generates  a random point using the selected
-       random number generator and then finds the closest point to
-       it.  This site is removed from the candidate list (meaning
-       that it will not be selected for any other test  set)  and
-       saved  in the first test partition file.  This is repeated
-       until enough points have been selected for the test partition.
-       The  number  of  points  chosen for test partitions
-       depends upon the number of sites available and the  number
-       of partitions chosen (this number is made as consistent as
-       possible while ensuring that all sites will be chosen  for
-       testing).  This  process of filling up a test partition is
-       done <I>k</I> times.
+
+<em>v.kcv</em> randomly divides a points lists into <em>k</em> sets of
+test/train data (for <b>k</b>-fold <b>c</b>ross <b>v</b>alidation).
+Test partitions are mutually exclusive. That is, a point will appear in
+only one test partition and <em>k-1</em> training partitions.
+
+The module generates a random point using the selected random number
+generator and then finds the closest point to it. This site is removed
+from the candidate list (meaning that it will not be selected for any
+other test set) and saved in the first test partition file. This is
+repeated until enough points have been selected for the test partition.
+The number of points chosen for test partitions depends upon the number
+of sites available and the number of partitions chosen (this number is
+made as consistent as possible while ensuring that all sites will be
+chosen for testing). This process of filling up a test partition is
+done <em>k</em> times.
 
 <h2>NOTES</h2>
-       An ideal random sites generator will follow a Poisson dis
-      <!-- BUG: missing text -->
-       only be as random as the  original  points.   This  program
-       simply divides points up in a random manner.<p>
-       Be  warned  that  random number generation occurs over the
-       intervals defined by the region of the map.<p>
-       This program may not work properly with Lat-long data.
+
+An ideal random sites generator will follow a Poisson distribution and 
+will only be as random as the original sites. This module simply 
+divides vector points up in a random manner.
+
+<p>
+Be warned that random number generation occurs over the
+intervals defined by the current region of the map.
+
+<p>
+This program may not work properly with Lat-long data.
+
+<h2>EXAMPLES</h2>
+
+All examples are based on the North Carolina sample dataset.
+
+<div class="code"><pre>
+g.copy vect=geonames_wake,my_geonames_wake
+v.kcv map=my_geonames_wake column=part k=10
+</pre></div>
+
+<p>
+<div class="code"><pre>
+g.copy vect=geodetic_pts,my_geodetic_pts
+v.kcv map=my_geodetic_pts column=part k=10
+</pre></div>
 
 <h2>SEE ALSO</h2>
-<I><a href=v.random.html>v.random</a></I> and 
-<I><a href=g.region.html>g.region</a></I>
+
+<em>
+<a href=v.random.html>v.random</a>,
+<a href=g.region.html>g.region</a>
+</em>
 
 
 <h2>AUTHOR</h2>
 
-<a href="http://mccauley-usa.com/">James Darrell McCauley</a>
-<a href="mailto:darrell@mccauley-usa.com">&lt;darrell@mccauley-usa.com&gt;</a>,
+James Darrell McCauley,
 <br>when he was at: 
-<a href="http://ABE.www.ecn.purdue.edu/ABE/">Agricultural
-Engineering</a>
+<a href="http://ABE.www.ecn.purdue.edu/ABE/">Agricultural Engineering</a>
 <a href="http://www.purdue.edu/">Purdue University</a>
 
-<p>Update to 5.7 Radim Blazek 10 / 2004
+<p>
+27 Jan 1994: fixed RAND_MAX for Solaris 2.3<br>
+13 Sep 2000: released under GPL<br>
+Updated to 5.7 Radim Blazek 10 / 2004<br>
+OGR support by Martin Landa (2009)<br>
+Speed-up by Jan Vandrol and Jan Ruzicka (2013)
 
-<p><i>Last changed: $Date$</i>
+<p>
+<i>Last changed: $Date$</i>