docs: add errata section for 'Figurate Numbers (2012)' to README

Author: edelveart

CITATION.cff

@@ -5,7 +5,7 @@ authors:
     given-names: "Edgar Armando"
     orcid: "https://orcid.org/0000-0002-9672-9087"
 title: "Figurate Numbers for Python"
-version: 0.8.0
+version: 1.0.0
 doi:
 date-released: 2024-07-08
 url: "https://github.com/edelveart/figuratenum"

README.md

@@ -5,8 +5,8 @@
 ![PyPI - Wheel](https://img.shields.io/pypi/wheel/figuratenum)
 ![PyPI - Status](https://img.shields.io/pypi/status/figuratenum)
 
-
-FigurateNum is a set of 235 **figurate number generators** based on the book [Figurate Numbers (2012)](https://books.google.com.pe/books/about/Figurate_Numbers.html?id=cDxYdstLPz4C&redir_esc=y) by Michel Deza and Elena Deza.
+**FigurateNum** is a collection of **233 figurate number generators** based on the book
+> [Figurate Numbers](https://books.google.com.pe/books/about/Figurate_Numbers.html?id=cDxYdstLPz4C&redir_esc=y) by Michel Deza and Elena Deza, published in 2012.
 
 FigurateNum generates the following types of **infinite sequences**:
 
@@ -320,6 +320,112 @@ array('d', [1.0, 19.0, 70.0, 170.0, 335.0])
 67. `generalized_k_dimensional_centered_hypercube_numbers(k, start_num = 0)`
 68. `generalized_nexus_numbers(start_num = 0)`
 
+## Errata for *Figurate Numbers (2012)*
+
+This section lists the errata and corrections for the book *Figurate Numbers (2012)* by Michel Deza and Elena Deza. If you find any errors in the content, please feel free to contribute corrections.
+
+- Chapter 1, formula in the table on page 6 says:
+
+  | Name   | Formula             |     |
+  | ------ | ------------------- | --- |
+  | Square | `1/2 (n^2 - 0 * n)` |     |
+
+
+  It should be:
+  | Name   | Formula              |     |
+  | ------ | -------------------- | --- |
+  | Square | `1/2 (2n^2 - 0 * n)` |     |
+
+- Chapter 1, formula in the table on page 51 says:
+
+  | Name                 | Formula               |                       |
+  | -------------------- | --------------------- | --------------------- |
+  | Cent. icosihexagonal | `1/3n^2 - 13 * n + 1` | `546, 728, 936, 1170` |
+
+
+  It should be:
+  | Name                 | Formula               |                       |
+  | -------------------- | --------------------- | --------------------- |
+  | Cent. icosihexagonal | `1/3n^2 - 13 * n + 1` | `547, 729, 937, 1171` |
+
+- Chapter 1, formula in the table on page 51 says:
+
+  | Name                  | Formula |       |
+  | --------------------- | ------- | ----- |
+  | Cent. icosiheptagonal |         | `972` |
+
+
+  It should be:
+  | Name                  | Formula |       |
+  | --------------------- | ------- | ----- |
+  | Cent. icosiheptagonal |         | `973` |
+
+- Chapter 1, formula in the table on page 51 says:
+
+  | Name                 | Formula |      |
+  | -------------------- | ------- | ---- |
+  | Cent. icosioctagonal |         | `84` |
+
+
+  It should be:
+  | Name                 | Formula |      |
+  | -------------------- | ------- | ---- |
+  | Cent. icosioctagonal |         | `85` |
+
+- Chapter 1, page 65 (polite numbers) says:
+  > `inpolite numbers`
+
+  It should read:
+
+  > `impolite numbers`
+
+- Chapter 1, formula (truncated centered pentagonal numbers) on  page 72 says:
+  > `TCSS_5(n) = (35n^2 - 55n) / 2 + 3`
+
+  It should be:
+  > `TCSS_5(n) = (35n^2 - 55n) / 2 + 11`
+
+- Chapter 2, formula of octagonal pyramidal number on  page 92 says:
+  > `n(n+1)(6n-1) / 6`
+
+  It should be:
+  > `n(n+1)(6n-3) / 6`
+
+- Chapter 2, page 140 says:
+  > centered square pyramidal numbers are 1, 6, 19, 44, 85, 111, 146, 231, ...
+
+  This sequence must exclude the number 111:
+
+  > centered square pyramidal numbers are 1, 6, 19, 44, 85, ~~111~~, 146, 231, ...
+
+- Chapter 2, page 155 (generalized centered tetrahedron numbers) says:
+  > `S_3^3(n) = ((2n - 1)(n^2 + n + 3)) / 3`
+
+  Formula must have a negative sign:
+
+  > `S_3^3(n) = ((2n - 1)(n^2 - n + 3)) / 3`
+
+- Chapter 2, page 156 (generalized centered square pyramid numbers) says:
+  > `S_4^3(n) = ((2n - 1) * (n^2 - n + 2)^2) / 3`
+
+  Formula must write:
+
+  > `S_4^3(n) = ((2n - 1) * (n^2 - n + 2)) / 2`
+
+- Chapter 3, page 188 (hyperoctahedral numbers) says:
+  > `hexadecahoron numbers`
+
+  It should read:
+
+  > `hexadecachoron numbers`
+
+- Chapter 3, page 190 (hypericosahedral numbers) says:
+  > `hexacisihoron numbers`
+
+  It should read:
+
+  > `hexacosichoron numbers`
+
 ## Contributing
 
 FigurateNumber is currently under development, and we warmly invite your contributions. Just **fork** the project and then submit a **pull request**:

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "figuratenum"
 version = "0.8.0"
-description = "Generates infinite sequences of figurate numbers for Python."
+description = "Generate 233 infinite figurate number sequences for mathematical research, applications, and exploration in Python."
 readme = "README.md"
 authors = [{ name = "Edgar Armando Delgado Vega" }]
 license = { file = "LICENSE" }
@@ -14,7 +14,7 @@ requires-python = ">=3.9"
 classifiers = [
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 2",
-  "Development Status :: 3 - Alpha",
+  "Development Status :: 5 - Production/Stable",
   "Topic :: Scientific/Engineering :: Mathematics",
   "Topic :: Software Development :: Libraries :: Python Modules",
   "Intended Audience :: Developers",