Split up spiff on-line help by ring/field description (#42)

* Split up spiff on-line help by ring/field description * neaten * Add 2023
johnkerl · May 1, 2023 · 0ecdd28 · 0ecdd28
1 parent 360bd34
commit 0ecdd28
Show file tree

Hide file tree

Showing 134 changed files with 412 additions and 347 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,28 @@
+Copyright (c) 2015- John Kerl
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+This software is provided by the copyright holders and contributors "as is" and
+any express or implied warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose are
+disclaimed. In no event shall the copyright holder or contributors be liable
+for any direct, indirect, incidental, special, exemplary, or consequential
+damages (including, but not limited to, procurement of substitute goods or
+services; loss of use, data, or profits; or business interruption) however
+caused and on any theory of liability, whether in contract, strict liability,
+or tort (including negligence or otherwise) arising in any way out of the use
+of this software, even if advised of the possibility of such damage.
+
+I am providing code in this repository to you under an open-source license.
+Because this is my personal repository, the license you receive to my code is
+from me and not from my employer.
diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
-For documentation please see https://github.com/johnkerl/spffl/wiki
+# SPFFL
+
+SPFFL (pronounced _spiffle_) is a small-prime finite-field library, where small means 32 bits or less. Polynomials may have arbitrary degree, as limited by machine resources. Residue field and quotient fields are supported. In addition to the C++ library, there is a command-line tool, named `spiff`, for convenient interactive use.
+
+For more information please see the **[SPFFL wiki page](https://github.com/johnkerl/spffl/wiki/SPFFL-documentation)**.
 
 # Setup disclaimer
 

diff --git a/cli/misc/misc_main.cpp b/cli/misc/misc_main.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/cli/spiff/build/CMakeFiles/3.24.2/CMakeSystem.cmake b/cli/spiff/build/CMakeFiles/3.24.2/CMakeSystem.cmake
diff --git a/cli/spiff/build/CMakeFiles/CMakeOutput.log b/cli/spiff/build/CMakeFiles/CMakeOutput.log
diff --git a/cli/spiff/f2_poly_handlers.cpp b/cli/spiff/f2_poly_handlers.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/cli/spiff/f2_poly_handlers.h b/cli/spiff/f2_poly_handlers.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/cli/spiff/spiff_main.cpp b/cli/spiff/spiff_main.cpp
diff --git a/cli/spiff/z_handlers.cpp b/cli/spiff/z_handlers.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/cli/spiff/z_handlers.h b/cli/spiff/z_handlers.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/classes/teiginfo.h b/pre-cmake/classes/teiginfo.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/classes/tmvpoly.h b/pre-cmake/classes/tmvpoly.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/classes/tmvrat.h b/pre-cmake/classes/tmvrat.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/tools/chpols-2-4-4.cpp b/pre-cmake/tools/chpols-2-4-4.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/tools/f2pmchart.cpp b/pre-cmake/tools/f2pmchart.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/tools/fppmchart.cpp b/pre-cmake/tools/fppmchart.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/tools/single.cpp b/pre-cmake/tools/single.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/tools/solve_unique.cpp b/pre-cmake/tools/solve_unique.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/utils/moebius.cpp b/pre-cmake/utils/moebius.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/pre-cmake/utils/moebius.h b/pre-cmake/utils/moebius.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/base/cmps.h b/spffl/base/cmps.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/base/line_scan.cpp b/spffl/base/line_scan.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/base/line_scan.h b/spffl/base/line_scan.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/base/tokenize.cpp b/spffl/base/tokenize.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/base/tokenize.h b/spffl/base/tokenize.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bitrand/psdes.cpp b/spffl/bitrand/psdes.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bitrand/psdes.h b/spffl/bitrand/psdes.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/bit_matrix_t.cpp b/spffl/bits/bit_matrix_t.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/bit_matrix_t.h b/spffl/bits/bit_matrix_t.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/bit_t.cpp b/spffl/bits/bit_t.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/bit_t.h b/spffl/bits/bit_t.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/bit_vector_t.cpp b/spffl/bits/bit_vector_t.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/bit_vector_t.h b/spffl/bits/bit_vector_t.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/count_bits.cpp b/spffl/bits/count_bits.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/bits/count_bits.h b/spffl/bits/count_bits.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/cli_parser/cmd_line_matrix_ops.h b/spffl/cli_parser/cmd_line_matrix_ops.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/cli_parser/cmd_line_ops.h b/spffl/cli_parser/cmd_line_ops.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/cli_parser/cmd_line_vector_ops.h b/spffl/cli_parser/cmd_line_vector_ops.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/containers/tfacinfo.h b/spffl/containers/tfacinfo.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/containers/tmatrix.h b/spffl/containers/tmatrix.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/containers/tstack.h b/spffl/containers/tstack.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/containers/tvector.h b/spffl/containers/tvector.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2_poly_factor.cpp b/spffl/factorization/f2_poly_factor.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2_poly_factor.h b/spffl/factorization/f2_poly_factor.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2_poly_totient.cpp b/spffl/factorization/f2_poly_totient.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2_poly_totient.h b/spffl/factorization/f2_poly_totient.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2n_poly_factor.cpp b/spffl/factorization/f2n_poly_factor.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2n_poly_factor.h b/spffl/factorization/f2n_poly_factor.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2n_poly_totient.cpp b/spffl/factorization/f2n_poly_totient.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/f2n_poly_totient.h b/spffl/factorization/f2n_poly_totient.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/fp_poly_factor.cpp b/spffl/factorization/fp_poly_factor.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/fp_poly_factor.h b/spffl/factorization/fp_poly_factor.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/fp_poly_totient.cpp b/spffl/factorization/fp_poly_totient.cpp
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================

diff --git a/spffl/factorization/fp_poly_totient.h b/spffl/factorization/fp_poly_totient.h
@@ -1,5 +1,5 @@
 // ================================================================
-// Copyright (c) 2004 John Kerl.
+// Copyright (c) 2004, 2023 John Kerl.
 // kerl.john.r@gmail.com
 // Please see LICENSE.txt.
 // ================================================================