Release 0.2.7 !

tommyettinger · Feb 3, 2021 · 9923f00 · 9923f00
1 parent 34cd89e
commit 9923f00
Show file tree

Hide file tree

Showing 25 changed files with 165 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -42,15 +42,15 @@ A typical Gradle dependency on anim8 looks like this (in the core module's depen
 ```groovy
 dependencies {
   //... other dependencies are here, like libGDX 1.9.10 or higher
-  api "com.github.tommyettinger:anim8-gdx:0.2.6"
+  api "com.github.tommyettinger:anim8-gdx:0.2.7"
 }
 ```
 
 You can also get a specific commit using JitPack, by following the instructions on
 [JitPack's page for anim8](https://jitpack.io/#tommyettinger/anim8-gdx/57db9e3b6d). 
 
 A .gwt.xml file is present in the sources jar, and because GWT needs it, you can depend on the sources jar with
-`implementation "com.github.tommyettinger:anim8-gdx:0.2.6:sources"`. The PNG-related code isn't available on GWT because
+`implementation "com.github.tommyettinger:anim8-gdx:0.2.7:sources"`. The PNG-related code isn't available on GWT because
 it needs `java.util.zip`, which is unavailable there, but PaletteReducer and AnimatedGif should both work. The GWT
 inherits line, which is needed in `GdxDefinition.gwt.xml` if no dependencies already have it, is:
 ```xml
@@ -79,7 +79,12 @@ different API).
   - DIFFUSION
     - This is Floyd-Steinberg error-diffusion dithering.
     - It tends to look very good in still images, and very bad in animations.
+    - SCATTER is mostly the same as this algorithm, but uses blue noise to break up unpleasant patterns.
   - BLUE_NOISE
+    - Blue noise, if you haven't heard the term, refers to a kind of sequence of values where low-frequency patterns
+      don't appear at all, but mid- and high-frequency patterns are very common. 2D blue noise is common in graphics
+      code, often as a texture but sometimes as a sequence of points; it is used here because most vertebrate eyes
+      employ a blue-noise distribution for sensory cells, and this makes blue noise appear natural to the human eye.
     - Not the typical blue-noise dither; this incorporates a checkerboard pattern as well as a 64x64 blue noise texture.
     - I should probably credit Alan Wolfe for writing so many invaluable articles about blue noise.
     - This may have some issues when the palette is very small; it may not dither strongly enough by default for small

diff --git a/build.gradle b/build.gradle
@@ -18,7 +18,7 @@ apply from: 'publish.gradle'
 sourceCompatibility = 1.7
 
 def projectName = 'anim8-gdx'
-version '0.2.7-SNAPSHOT'
+version '0.2.7'
 group 'com.github.tommyettinger'
 
 //api "com.github.tommyettinger:anim8-gdx:0.2.6"

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (anim8-gdx 0.2.6 API)</title>
+<title>All Classes (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (anim8-gdx 0.2.6 API)</title>
+<title>All Classes (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/AnimatedGif.html b/docs/apidocs/com/github/tommyettinger/anim8/AnimatedGif.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AnimatedGif (anim8-gdx 0.2.6 API)</title>
+<title>AnimatedGif (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AnimatedGif (anim8-gdx 0.2.6 API)";
+            parent.document.title="AnimatedGif (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/AnimatedPNG.html b/docs/apidocs/com/github/tommyettinger/anim8/AnimatedPNG.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AnimatedPNG (anim8-gdx 0.2.6 API)</title>
+<title>AnimatedPNG (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AnimatedPNG (anim8-gdx 0.2.6 API)";
+            parent.document.title="AnimatedPNG (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/AnimationWriter.html b/docs/apidocs/com/github/tommyettinger/anim8/AnimationWriter.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AnimationWriter (anim8-gdx 0.2.6 API)</title>
+<title>AnimationWriter (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AnimationWriter (anim8-gdx 0.2.6 API)";
+            parent.document.title="AnimationWriter (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/Dithered.DitherAlgorithm.html b/docs/apidocs/com/github/tommyettinger/anim8/Dithered.DitherAlgorithm.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Dithered.DitherAlgorithm (anim8-gdx 0.2.6 API)</title>
+<title>Dithered.DitherAlgorithm (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Dithered.DitherAlgorithm (anim8-gdx 0.2.6 API)";
+            parent.document.title="Dithered.DitherAlgorithm (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/Dithered.html b/docs/apidocs/com/github/tommyettinger/anim8/Dithered.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Dithered (anim8-gdx 0.2.6 API)</title>
+<title>Dithered (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Dithered (anim8-gdx 0.2.6 API)";
+            parent.document.title="Dithered (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/OtherMath.BiasGain.html b/docs/apidocs/com/github/tommyettinger/anim8/OtherMath.BiasGain.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>OtherMath.BiasGain (anim8-gdx 0.2.6 API)</title>
+<title>OtherMath.BiasGain (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="OtherMath.BiasGain (anim8-gdx 0.2.6 API)";
+            parent.document.title="OtherMath.BiasGain (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/OtherMath.html b/docs/apidocs/com/github/tommyettinger/anim8/OtherMath.html
@@ -3,21 +3,21 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>OtherMath (anim8-gdx 0.2.6 API)</title>
+<title>OtherMath (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="OtherMath (anim8-gdx 0.2.6 API)";
+            parent.document.title="OtherMath (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {
     }
 //-->
-var methods = {"i0":9,"i1":9,"i2":9};
+var methods = {"i0":9,"i1":9,"i2":9,"i3":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -156,13 +156,19 @@ <h3>Method Summary</h3>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
+<td class="colFirst"><code>static float</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/anim8/OtherMath.html#cbrt-float-">cbrt</a></span>(float&nbsp;x)</code>
+<div class="block">An approximation of the cube-root function for float inputs and outputs.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
 <td class="colFirst"><code>static byte</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/anim8/OtherMath.html#centralize-byte-">centralize</a></span>(byte&nbsp;v)</code>
 <div class="block">Given a byte, pushes any value that isn't extreme toward the center of the 0 to 255 range, and keeps extreme
  values (such as the channel values in the colors max green or black) as they are.</div>
 </td>
 </tr>
-<tr id="i2" class="altColor">
+<tr id="i3" class="rowColor">
 <td class="colFirst"><code>static double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/anim8/OtherMath.html#probit-double-">probit</a></span>(double&nbsp;d)</code>
 <div class="block">A way of taking a double in the (0.0, 1.0) range and mapping it to a Gaussian or normal distribution, so high
@@ -240,7 +246,7 @@ <h4>centralize</h4>
 <a name="probit-double-">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>probit</h4>
 <pre>public static&nbsp;double&nbsp;probit(double&nbsp;d)</pre>
@@ -275,6 +281,33 @@ <h4>probit</h4>
 </dl>
 </li>
 </ul>
+<a name="cbrt-float-">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>cbrt</h4>
+<pre>public static&nbsp;float&nbsp;cbrt(float&nbsp;x)</pre>
+<div class="block">An approximation of the cube-root function for float inputs and outputs.
+ This can be about twice as fast as <code>Math.cbrt(double)</code>. It
+ correctly returns negative results when given negative inputs.
+ <br>
+ Has very low relative error (less than 1E-9) when inputs are uniformly
+ distributed between -512 and 512, and absolute mean error of less than
+ 1E-6 in the same scenario. Uses a bit-twiddling method similar to one
+ presented in Hacker's Delight and also used in early 3D graphics (see
+ https://en.wikipedia.org/wiki/Fast_inverse_square_root for more, but
+ this code approximates cbrt(x) and not 1/sqrt(x)). This specific code
+ was originally by Marc B. Reynolds, posted in his "Stand-alone-junk"
+ repo: https://github.com/Marc-B-Reynolds/Stand-alone-junk/blob/master/src/Posts/ballcube.c#L182-L197 .</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>x</code> - any finite float to find the cube root of</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the cube root of x, approximated</dd>
+</dl>
+</li>
+</ul>
 </li>
 </ul>
 </li>

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/PNG8.html b/docs/apidocs/com/github/tommyettinger/anim8/PNG8.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>PNG8 (anim8-gdx 0.2.6 API)</title>
+<title>PNG8 (anim8-gdx 0.2.7 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="PNG8 (anim8-gdx 0.2.6 API)";
+            parent.document.title="PNG8 (anim8-gdx 0.2.7 API)";
         }
     }
     catch(err) {