Eliminate jstructural

Affects: io7m-com/.github#2
io7m-com · May 4, 2024 · 24b7caa · 24b7caa
1 parent 1c487af
commit 24b7caa
Show file tree

Hide file tree

Showing 13 changed files with 74 additions and 536 deletions.
diff --git a/README.in b/README.in
@@ -0,0 +1,33 @@
+
+## jnfp
+
+Java functions to convert between floating point and _normalized fixed point_
+values.
+
+## Features
+
+* Conversion between unsigned normalized fixed-point numbers and floating point numbers.
+* Conversion between signed normalized fixed-point numbers and floating point numbers.
+* High coverage test suite.
+* [OSGi-ready](https://www.osgi.org/)
+* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
+* ISC license.
+
+## Usage
+
+Convert a floating point value to its 32-bit unsigned normalized fixed point
+representation:
+
+```
+var r = NFPUnsignedFloatLong.toUnsignedNormalized(0.25, 32);
+```
+
+Convert a 32-bit unsigned normalized fixed point value to its floating point
+representation:
+
+```
+var s = NFPUnsignedFloatLong.fromUnsignedNormalized(r, 32);
+```
+
+Classes exist for signed, unsigned, `int`, `long`, `float`, and `double`
+specializations.
diff --git a/README.md b/README.md
@@ -13,3 +13,37 @@ jnfp
 | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/jnfp/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/jnfp/actions?query=workflow%3Amain.linux.temurin.lts)|
 | OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jnfp/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/jnfp/actions?query=workflow%3Amain.windows.temurin.current)|
 | OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jnfp/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/jnfp/actions?query=workflow%3Amain.windows.temurin.lts)|
+
+## jnfp
+
+Java functions to convert between floating point and _normalized fixed point_
+values.
+
+## Features
+
+* Conversion between unsigned normalized fixed-point numbers and floating point numbers.
+* Conversion between signed normalized fixed-point numbers and floating point numbers.
+* High coverage test suite.
+* [OSGi-ready](https://www.osgi.org/)
+* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
+* ISC license.
+
+## Usage
+
+Convert a floating point value to its 32-bit unsigned normalized fixed point
+representation:
+
+```
+var r = NFPUnsignedFloatLong.toUnsignedNormalized(0.25, 32);
+```
+
+Convert a 32-bit unsigned normalized fixed point value to its floating point
+representation:
+
+```
+var s = NFPUnsignedFloatLong.fromUnsignedNormalized(r, 32);
+```
+
+Classes exist for signed, unsigned, `int`, `long`, `float`, and `double`
+specializations.
+
diff --git a/com.io7m.jnfp.documentation/pom.xml b/com.io7m.jnfp.documentation/pom.xml
diff --git a/com.io7m.jnfp.documentation/src/main/assembly/documentation.xml b/com.io7m.jnfp.documentation/src/main/assembly/documentation.xml
diff --git a/com.io7m.jnfp.documentation/src/main/java/com/io7m/jnfp/documentation/Documentation.java b/com.io7m.jnfp.documentation/src/main/java/com/io7m/jnfp/documentation/Documentation.java
diff --git a/com.io7m.jnfp.documentation/src/main/java/com/io7m/jnfp/documentation/package-info.java b/com.io7m.jnfp.documentation/src/main/java/com/io7m/jnfp/documentation/package-info.java
diff --git a/com.io7m.jnfp.documentation/src/main/java/module-info.java b/com.io7m.jnfp.documentation/src/main/java/module-info.java