documentation

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/ExpressionSampler.java

@@ -5,16 +5,16 @@ import com.dfsek.paralithic.eval.parser.Parser;
 import com.dfsek.paralithic.eval.parser.Scope;
 import com.dfsek.paralithic.eval.tokenizer.ParseException;
 import com.dfsek.terra.api.math.noise.NoiseSampler;
-import com.dfsek.terra.api.math.parsii.defined.UserDefinedFunction;
-import com.dfsek.terra.api.math.parsii.noise.NoiseFunction2;
-import com.dfsek.terra.api.math.parsii.noise.NoiseFunction3;
+import com.dfsek.terra.api.math.paralithic.defined.UserDefinedFunction;
+import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction2;
+import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction3;
 import com.dfsek.terra.api.util.seeded.NoiseSeeded;
 import com.dfsek.terra.config.loaders.config.function.FunctionTemplate;
 
 import java.util.Map;
 
 /**
- * Sampler implementation using parsii expression
+ * Sampler implementation using Paralithic expression
  */
 public class ExpressionSampler implements NoiseSampler {
     private final Expression expression;

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/CellularSampler.java

@@ -5,6 +5,9 @@ import com.dfsek.terra.api.math.noise.samplers.noise.simplex.OpenSimplex2Sampler
 import com.dfsek.terra.api.math.vector.Vector2;
 import com.dfsek.terra.api.math.vector.Vector3;
 
+/**
+ * NoiseSampler implementation for Cellular (Voronoi/Worley) Noise.
+ */
 public class CellularSampler extends NoiseFunction {
     private static final double[] RAND_VECS_3D = {
             -0.7292736885d, -0.6618439697d, 0.1735581948d, 0, 0.790292081d, -0.5480887466d, -0.2739291014d, 0, 0.7217578935d, 0.6226212466d,

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/ExpressionFunction.java

@@ -8,6 +8,9 @@ import com.dfsek.paralithic.functions.Function;
 
 import java.util.Map;
 
+/**
+ * NoiseSampler implementation using a Paralithic expression.
+ */
 public class ExpressionFunction extends NoiseFunction {
     private final Expression expression;
 

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/GaussianNoiseSampler.java

@@ -2,6 +2,9 @@ package com.dfsek.terra.api.math.noise.samplers.noise.random;
 
 import com.dfsek.terra.api.math.noise.samplers.noise.NoiseFunction;
 
+/**
+ * NoiseSampler implementation to provide random, normally distributed (Gaussian) noise.
+ */
 public class GaussianNoiseSampler extends NoiseFunction {
     private final WhiteNoiseSampler whiteNoiseSampler; // Back with a white noise sampler.
 

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/WhiteNoiseSampler.java

@@ -2,6 +2,9 @@ package com.dfsek.terra.api.math.noise.samplers.noise.random;
 
 import com.dfsek.terra.api.math.noise.samplers.noise.NoiseFunction;
 
+/**
+ * NoiseSampler implementation to produce random, uniformly distributed (white) noise.
+ */
 public class WhiteNoiseSampler extends NoiseFunction {
     private static final long POSITIVE_POW1 = 0b01111111111L << 52; // Bits that when applied to the exponent/sign section of a double, produce a positive number with a power of 1.
 
@@ -29,7 +32,13 @@ public class WhiteNoiseSampler extends NoiseFunction {
         return (Double.longBitsToDouble(base) - 1.5) * 2;
     }
 
-    private long murmur64(long h) {
+    /**
+     * Murmur64 hashing function
+     *
+     * @param h Input value
+     * @return Hashed value
+     */
+    private static long murmur64(long h) {
         h ^= h >>> 33;
         h *= 0xff51afd7ed558ccdL;
         h ^= h >>> 33;

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2SSampler.java

@@ -1,5 +1,8 @@
 package com.dfsek.terra.api.math.noise.samplers.noise.simplex;
 
+/**
+ * NoiseSampler implementation to provide OpenSimplex2 (Smooth Variant) noise.
+ */
 public class OpenSimplex2SSampler extends SimplexStyleSampler {
     public OpenSimplex2SSampler(int seed) {
         super(seed);

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2Sampler.java

@@ -1,5 +1,8 @@
 package com.dfsek.terra.api.math.noise.samplers.noise.simplex;
 
+/**
+ * NoiseSampler implementation to provide OpenSimplex2 noise.
+ */
 public class OpenSimplex2Sampler extends SimplexStyleSampler {
     private static final double SQRT3 = 1.7320508075688772935274463415059;
 

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/PerlinSampler.java

@@ -1,5 +1,8 @@
 package com.dfsek.terra.api.math.noise.samplers.noise.simplex;
 
+/**
+ * NoiseSampler implementation to provide Perlin Noise.
+ */
 public class PerlinSampler extends SimplexStyleSampler {
     public PerlinSampler(int seed) {
         super(seed);

common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/SimplexStyleSampler.java

@@ -2,6 +2,9 @@ package com.dfsek.terra.api.math.noise.samplers.noise.simplex;
 
 import com.dfsek.terra.api.math.noise.samplers.noise.NoiseFunction;
 
+/**
+ * Abstract NoiseSampler implementation for simplex-style noise functions.
+ */
 public abstract class SimplexStyleSampler extends NoiseFunction {
     protected static final double[] GRADIENTS_2_D = {
             0.130526192220052d, 0.99144486137381d, 0.38268343236509d, 0.923879532511287d, 0.608761429008721d, 0.793353340291235d,

common/src/main/java/com/dfsek/terra/api/math/paralithic/BlankFunction.java

@@ -1,4 +1,4 @@
-package com.dfsek.terra.api.math.parsii;
+package com.dfsek.terra.api.math.paralithic;
 
 
 import com.dfsek.paralithic.functions.dynamic.DynamicFunction;

common/src/main/java/com/dfsek/terra/api/math/paralithic/defined/UserDefinedFunction.java

@@ -1,4 +1,4 @@
-package com.dfsek.terra.api.math.parsii.defined;
+package com.dfsek.terra.api.math.paralithic.defined;
 
 import com.dfsek.paralithic.Expression;
 import com.dfsek.paralithic.eval.parser.Parser;

common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction.java

@@ -1,4 +1,4 @@
-package com.dfsek.terra.api.math.parsii.noise;
+package com.dfsek.terra.api.math.paralithic.noise;
 
 
 import com.dfsek.paralithic.functions.dynamic.DynamicFunction;

common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction2.java

@@ -1,4 +1,4 @@
-package com.dfsek.terra.api.math.parsii.noise;
+package com.dfsek.terra.api.math.paralithic.noise;
 
 import com.dfsek.terra.api.math.noise.NoiseSampler;
 import com.dfsek.terra.util.hash.HashMapDoubleDouble;

common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction3.java

@@ -1,4 +1,4 @@
-package com.dfsek.terra.api.math.parsii.noise;
+package com.dfsek.terra.api.math.paralithic.noise;
 
 import com.dfsek.terra.api.math.noise.NoiseSampler;
 

common/src/main/java/com/dfsek/terra/api/math/vector/Vector2.java

@@ -6,7 +6,6 @@ import net.jafama.FastMath;
 /**
  * oh yeah
  */
-@SuppressWarnings("unused")
 public class Vector2 implements Cloneable {
     private double x;
     private double z;

common/src/main/java/com/dfsek/terra/api/math/vector/Vector3.java

@@ -5,6 +5,9 @@ import com.dfsek.terra.api.platform.world.World;
 import net.jafama.FastMath;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * 3D Mutable Vector
+ */
 public class Vector3 implements Cloneable {
 
 

common/src/main/java/com/dfsek/terra/carving/UserDefinedCarver.java

@@ -6,9 +6,9 @@ import com.dfsek.paralithic.eval.parser.Scope;
 import com.dfsek.paralithic.eval.tokenizer.ParseException;
 import com.dfsek.terra.api.core.TerraPlugin;
 import com.dfsek.terra.api.math.Range;
-import com.dfsek.terra.api.math.parsii.defined.UserDefinedFunction;
-import com.dfsek.terra.api.math.parsii.noise.NoiseFunction2;
-import com.dfsek.terra.api.math.parsii.noise.NoiseFunction3;
+import com.dfsek.terra.api.math.paralithic.defined.UserDefinedFunction;
+import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction2;
+import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction3;
 import com.dfsek.terra.api.math.vector.Vector3;
 import com.dfsek.terra.api.platform.world.World;
 import com.dfsek.terra.api.util.FastRandom;

common/src/main/java/com/dfsek/terra/config/loaders/config/sampler/templates/noise/ExpressionFunctionTemplate.java

@@ -8,9 +8,9 @@ import com.dfsek.tectonic.config.ValidatedConfigTemplate;
 import com.dfsek.tectonic.exception.ValidationException;
 import com.dfsek.terra.api.math.noise.NoiseSampler;
 import com.dfsek.terra.api.math.noise.samplers.noise.ExpressionFunction;
-import com.dfsek.terra.api.math.parsii.BlankFunction;
-import com.dfsek.terra.api.math.parsii.noise.NoiseFunction2;
-import com.dfsek.terra.api.math.parsii.noise.NoiseFunction3;
+import com.dfsek.terra.api.math.paralithic.BlankFunction;
+import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction2;
+import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction3;
 import com.dfsek.terra.api.util.seeded.NoiseSeeded;
 import com.dfsek.terra.config.loaders.config.sampler.templates.SamplerTemplate;
 

common/src/main/java/com/dfsek/terra/config/templates/BiomeTemplate.java

@@ -12,8 +12,8 @@ import com.dfsek.terra.api.core.TerraPlugin;
 import com.dfsek.terra.api.math.ProbabilityCollection;
 import com.dfsek.terra.api.math.noise.NoiseSampler;
 import com.dfsek.terra.api.math.noise.samplers.noise.ConstantSampler;
-import com.dfsek.terra.api.math.parsii.BlankFunction;
-import com.dfsek.terra.api.math.parsii.defined.UserDefinedFunction;
+import com.dfsek.terra.api.math.paralithic.BlankFunction;
+import com.dfsek.terra.api.math.paralithic.defined.UserDefinedFunction;
 import com.dfsek.terra.api.platform.block.BlockData;
 import com.dfsek.terra.api.platform.block.MaterialData;
 import com.dfsek.terra.api.platform.world.Biome;