chiark / gitweb /
Fix an inaccurate comment.
authorSimon Tatham <anakin@pobox.com>
Tue, 6 Nov 2018 18:34:47 +0000 (18:34 +0000)
committerSimon Tatham <anakin@pobox.com>
Tue, 6 Nov 2018 18:37:23 +0000 (18:37 +0000)
latin_solver_diff_set takes a boolean input parameter to indicate
whether the 'Extreme'-level variant of set elimination is permitted.
But it's commented in the header file as having a boolean _output_
parameter which it sets if it _ended up_ using that variant. Probably
the latter was how it worked in an early draft, and I changed my mind
later without changing the comment.

latin.h

diff --git a/latin.h b/latin.h
index e13050e9a8c074d9b5b279d30ce6fc45b13b5113..747cfb61f7b6f10583a66747293f9d67724f19d8 100644 (file)
--- a/latin.h
+++ b/latin.h
@@ -78,8 +78,8 @@ void latin_solver_free_scratch(struct latin_solver_scratch *scratch);
 /* Looped positional elimination */
 int latin_solver_diff_simple(struct latin_solver *solver);
 
-/* Looped set elimination; *extreme is set if it used
- * the more difficult single-number elimination. */
+/* Looped set elimination; extreme permits use of the more difficult
+ * single-number elimination. */
 int latin_solver_diff_set(struct latin_solver *solver,
                           struct latin_solver_scratch *scratch,
                           int extreme);