Introducing the concept of 'Quantity' to facility unit conversion bet…

…ter. (WIP)

.mvn/jvm.config

@@ -1 +1 @@
--Dfile.encoding=UTF-8 -Djava.awt.headless=true -Duser.language=da -ea
+-Dfile.encoding=UTF-8 -ea

mihxil-math-theories/src/main/java/org/meeuw/math/abstractalgebra/test/MultiplicativeGroupTheory.java

@@ -46,6 +46,7 @@ default void powNegative1(
     }
     @Override
     @Property
+    @Label("powNegative2 group")
     default void powNegative2(
          @ForAll(ELEMENTS) E v1
     )  {
@@ -59,6 +60,7 @@ default void powNegative2(
     }
     @Override
     @Property
+    @Label("powNegative3 group")
     default void powNegative3(
          @ForAll(ELEMENTS) E v1
     )  {

mihxil-math-theories/src/main/java/org/meeuw/math/abstractalgebra/test/MultiplicativeSemiGroupTheory.java

@@ -51,28 +51,34 @@ default void pow3(
     }
 
 
+    @SuppressWarnings("ConstantConditions")
     @Property
     default void pow0(
          @ForAll(ELEMENTS) E v1
     )  {
         assertThatThrownBy(() -> v1.pow(0)).isInstanceOf(ReciprocalException.class);
     }
 
+    @SuppressWarnings("ConstantConditions")
     @Property
     @Label("powNegative1 semigroup")
     default void powNegative1(
          @ForAll(ELEMENTS) E v1
     )  {
         assertThatThrownBy(() -> v1.pow(-1)).isInstanceOf(ReciprocalException.class);
     }
+    @SuppressWarnings("ConstantConditions")
     @Property
+    @Label("powNegative2 semigroup")
     default void powNegative2(
          @ForAll(ELEMENTS) E v1
     )  {
         assertThatThrownBy(() -> v1.pow(-2)).isInstanceOf(ReciprocalException.class);
 
     }
+    @SuppressWarnings("ConstantConditions")
     @Property
+    @Label("powNegative3 semigroup")
     default void powNegative3(
          @ForAll(ELEMENTS) E v1
     )  {

mihxil-math/src/main/java/org/meeuw/math/ReflectionUtils.java

@@ -0,0 +1,33 @@
+package org.meeuw.math;
+
+import lombok.extern.java.Log;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.util.function.Consumer;
+
+@Log
+public class ReflectionUtils {
+
+    private ReflectionUtils() {
+    }
+
+    @SuppressWarnings("unchecked")
+    public static <C, D> void forConstants(Class<C> clazz, Class<D> constantClass, Consumer<D> consumer) {
+        for (Field f : clazz.getDeclaredFields()) {
+            if (Modifier.isPublic(f.getModifiers()) &&
+                Modifier.isStatic(f.getModifiers()) &&
+                constantClass.isAssignableFrom(f.getType())) {
+                try {
+                    consumer.accept((D) f.get(null));
+                } catch (IllegalAccessException e) {
+                    log.warning(e.getMessage());
+                }
+            }
+        }
+    }
+
+    public static <C> void forConstants(Class<C> clazz, Consumer<C> consumer) {
+        forConstants(clazz, clazz, consumer);
+    }
+}

mihxil-math/src/main/java/org/meeuw/math/streams/CartesianSpliterator.java

@@ -276,9 +276,9 @@ private boolean shiftCurrentFix() {
             }
             if (limitIterators[elementCurrentlyFixedAtLimit] != null) {
                 // this proposal is not finished, so we can use it.
-                if (limitIterators[elementCurrentlyFixedAtLimit].tryAdvance(a -> {
-                    current[elementCurrentlyFixedAtLimit] = a;
-                })) {
+                if (limitIterators[elementCurrentlyFixedAtLimit].tryAdvance(a ->
+                    current[elementCurrentlyFixedAtLimit] = a)
+                ) {
                     if (initializeForNewFix()) {
                         return true;
                     }
@@ -387,9 +387,9 @@ private static <E> Class<E> determineElementClass(Supplier<Spliterator<? extends
         final List<Class<?>> classes = new ArrayList<>();
         if (generators.length > 0) {
             for (Supplier<Spliterator<? extends E>> generator : generators) {
-                if (generator.get().tryAdvance(e -> {
-                    container[0] = e.getClass();
-                })) {
+                if (generator.get().tryAdvance(e ->
+                    container[0] = e.getClass())
+                ) {
                     classes.add(container[0]);
                 }
             }

mihxil-math/src/test/java/org/meeuw/test/math/streams/CartesianSpliteratorTest.java

@@ -10,10 +10,10 @@
 
 import org.junit.jupiter.api.Test;
 
-import static org.assertj.core.api.Assertions.assertThat;
-
 import org.meeuw.math.streams.CartesianSpliterator;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 @Log4j2
 class CartesianSpliteratorTest {
 
@@ -86,11 +86,13 @@ public void two() {
         testEnd(cartesianSpliterator);
     }
 
+    @SuppressWarnings("UnusedReturnValue")
     @SafeVarargs
     private <E> E[] testAdvance(CartesianSpliterator<? extends E> cartesianSpliterator, E... values) {
-        return testAdvance(cartesianSpliterator, i -> {
-            log.info("Found {}", cartesianSpliterator.currentAsString());
-        }, values);
+        return testAdvance(cartesianSpliterator, i ->
+            log.info("Found {}", cartesianSpliterator.currentAsString()),
+            values
+        );
     }
 
 
@@ -206,9 +208,11 @@ public void infiniteStreams2() throws IOException {
             Supplier<Spliterator<? extends Integer>> positive = () -> Stream.iterate(0, i -> i + 1).spliterator();
             CartesianSpliterator<Integer> cartesianSpliterator =
                 new CartesianSpliterator<>(positive, 2);
-            StreamSupport.stream(cartesianSpliterator, false).limit(1000).forEach(a -> {
-                printer.println(cartesianSpliterator.getIndex() + " " + Stream.of(a).map(String::valueOf).collect(Collectors.joining(" ")));
-                }
+            StreamSupport.stream(cartesianSpliterator, false).limit(1000).forEach(a ->
+                printer.println(
+                    cartesianSpliterator.getIndex() + " " +
+                        Stream.of(a).map(String::valueOf).collect(Collectors.joining(" "))
+                )
             );
         }
     }
@@ -222,9 +226,11 @@ public void infiniteStreams3() throws IOException {
             Supplier<Spliterator<? extends Integer>> positive = () -> Stream.iterate(0, i -> i + 1).spliterator();
             CartesianSpliterator<Integer> cartesianSpliterator =
                 new CartesianSpliterator<>(positive, 3);
-            StreamSupport.stream(cartesianSpliterator, false).limit(1000).forEach(a -> {
-                printer.println(cartesianSpliterator.getIndex() + " " + Stream.of(a).map(String::valueOf).collect(Collectors.joining(" ")));
-                }
+            StreamSupport.stream(cartesianSpliterator, false).limit(1000).forEach(a ->
+                printer.println(
+                    cartesianSpliterator.getIndex() + " " +
+                        Stream.of(a).map(String::valueOf).collect(Collectors.joining(" "))
+                )
             );
         }
     }

mihxil-physics/src/main/java/org/meeuw/physics/BaseUnit.java

@@ -1,14 +1,28 @@
 package org.meeuw.physics;
 
+import java.util.List;
+import java.util.stream.Collectors;
+
 /**
- * Marker interface
+ * Marker interface for a 'base' unit of the associated {@link SystemOfMeasurements}.
+ *
+ * It is a singular {@link Unit} and can be implemented as enums, because a {@link SystemOfMeasurements} normally has
+ * a fixed number of {@link BaseUnit}s, one for each possible {@link Dimension}.
  */
 public interface BaseUnit extends Unit {
 
     SystemOfMeasurements getSystem();
 
     Dimension getDimension();
 
+    @Override
+    default List<Quantity> getQuantities() {
+        DimensionalAnalysis analysis = new DimensionalAnalysis(DimensionExponent.of(getDimension(), 1));
+        return Quantity.getQuantities().stream()
+            .filter(q -> q.getDimensionalAnalysis().equals(analysis))
+            .collect(Collectors.toList());
+    }
+
     @Override
     default DimensionalAnalysis getDimensions() {
         return DimensionalAnalysis.of(getDimension());

mihxil-physics/src/main/java/org/meeuw/physics/CGS.java

@@ -66,6 +66,8 @@ public SystemOfMeasurements getSystem() {
         }
     }
 
+    public static final Units cmPerS = cm.per(s);
+
     // acceleration
     public static final DerivedUnit Gal =
         new DerivedUnit("Gal", "gal", of(cm, 1), of(s, -2))

mihxil-physics/src/main/java/org/meeuw/physics/DerivedUnit.java

@@ -8,10 +8,14 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.meeuw.math.text.TextUtils;
 import org.meeuw.math.uncertainnumbers.field.UncertainReal;
-
-import static org.meeuw.math.uncertainnumbers.field.UncertainRealField.INSTANCE;
+import org.meeuw.math.uncertainnumbers.field.UncertainRealField;
 
 /**
+ * A 'derived' unit is a singular {@link Unit} which is not a {@link BaseUnit}. It has one symbol, and
+ * may itself be wrapped in a {@link DimensionExponent}.
+ *
+ * Its {@link DimensionalAnalysis} may be complex though. E.g. a {@link SI#J} is a derived unit.
+ *
  * @author Michiel Meeuwissen
  * @since 0.4
  */
@@ -35,7 +39,7 @@ public class DerivedUnit implements Unit {
     final List<Quantity> quantities;
 
     public DerivedUnit(
-        UncertainReal SIFactor,
+        @NonNull UncertainReal SIFactor,
         String name,
         String description,
         UnitExponent... siExponents) {
@@ -59,18 +63,19 @@ private DerivedUnit(
     @lombok.Builder
     private DerivedUnit(
         @NonNull UncertainReal siFactor,
-        int[] exponents,
-        String name,
-        String description,
-        List<UnitExponent> siExponents,
-        @Singular @Nullable List<Quantity> quantities
+        final int[] exponents,
+        final String name,
+        final String description,
+        final List<UnitExponent> unitExponents,
+        final @Singular @Nullable List<Quantity> quantities
         ) {
         this.exponents =  new int[SIUnit.values().length];
         if (exponents != null) {
             System.arraycopy(exponents, 0, this.exponents, 0, this.exponents.length);
         }
-        if (siExponents != null) {
-            for (UnitExponent f : siExponents) {
+        if (unitExponents != null) {
+            for (UnitExponent f : unitExponents) {
+                siFactor = siFactor.times(f.getSIFactor());
                 int[] dimensions = f.getDimensions().getExponents();
                 for (int d = 0; d < dimensions.length; d++) {
                     this.exponents[d] += dimensions[d];
@@ -83,7 +88,6 @@ private DerivedUnit(
         this.quantities = quantities == null ? Collections.emptyList() : quantities;
     }
 
-
     public DerivedUnit(Units units, String name, String description) {
         this.exponents = new int[SIUnit.values().length];
         System.arraycopy(units.getDimensions().getExponents(), 0, this.exponents, 0, this.exponents.length);
@@ -113,7 +117,7 @@ public DerivedUnit(String name, String description, @NonNull UncertainReal siFac
     }
 
     public DerivedUnit(String name, String description, UnitExponent... siExponents) {
-        this(INSTANCE.one(), name, description,  siExponents);
+        this(UncertainRealField.INSTANCE.one(), name, description,  siExponents);
     }
 
     @Override
@@ -202,8 +206,8 @@ public int hashCode() {
     }
 
     public static class Builder {
-        public Builder unitExponents(UnitExponent... siExponents) {
-            return siExponents(Arrays.asList(siExponents));
+        public Builder unitExponent(UnitExponent... siExponents) {
+            return unitExponents(Arrays.asList(siExponents));
         }
 
 

mihxil-physics/src/main/java/org/meeuw/physics/Dimension.java

@@ -4,6 +4,7 @@
 
 /**
  * Representation of a basic physical dimension. This follows the SI recommendation.
+ *
  * @author Michiel Meeuwissen
  * @since 0.3
  */
@@ -18,7 +19,7 @@ public enum Dimension implements DimensionExponent {
     J("luminous intensity");
 
     /**
-     * Just an alias if you can't type greek
+     * Just an alias for if you can't type greek
      */
     static final Dimension TH = Θ;
 
@@ -29,20 +30,19 @@ public enum Dimension implements DimensionExponent {
     @Getter
     final String name;
 
-
     Dimension(char i, String name) {
         toString = String.valueOf(i);
         this.name = name;
     }
 
     Dimension(String name) {
         this.name = name;
-        toString = null;
+        toString = name();
     }
 
     @Override
     public String toString() {
-        return toString == null ? name() : toString;
+        return toString;
     }
 
     @Override

mihxil-physics/src/main/java/org/meeuw/physics/DimensionalAnalysis.java

@@ -3,9 +3,7 @@
 import lombok.Getter;
 import lombok.extern.java.Log;
 
-import java.lang.reflect.Field;
-import java.lang.reflect.Modifier;
-import java.util.*;
+import java.util.Arrays;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
@@ -27,27 +25,6 @@ public class DimensionalAnalysis
     MultiplicativeGroupElement<DimensionalAnalysis>,
     Streamable<DimensionExponent> {
 
-
-    private static final DimensionalAnalysis[] QUANTITIES;
-    static {
-        final List<DimensionalAnalysis> result = new ArrayList<>();
-        for (Field f : DimensionalAnalysis.class.getDeclaredFields()) {
-            if (Modifier.isPublic(f.getModifiers()) && Modifier.isStatic(f.getModifiers()) && f.getType().equals(DimensionalAnalysis.class)) {
-                try {
-                    result.add((DimensionalAnalysis) f.get(null));
-                } catch (IllegalAccessException e) {
-                    log.warning(e.getMessage());
-                }
-
-            }
-        }
-        QUANTITIES = result.toArray(new DimensionalAnalysis[0]);
-    }
-
-    public static DimensionalAnalysis[] getQuantities() {
-        return QUANTITIES;
-    }
-
     @Getter
     final int[] exponents = new int[Dimension.values().length];
 

mihxil-physics/src/main/java/org/meeuw/physics/Planck.java

@@ -19,18 +19,17 @@ public class Planck  implements SystemOfMeasurements {
     public static final Planck INSTANCE = new Planck();
 
     private Planck() {
-
     }
 
-
     @Override
     @NonNull
     public Unit forDimension(Dimension dimension) {
         switch(dimension) {
             case L: return PlanckUnit.PlanckLength;
             case M: return PlanckUnit.PlanckMass;
             case T: return PlanckUnit.PlanckTime;
-            case I: return new DerivedUnit(PlanckUnit.PlanckCharge.dividedBy(PlanckUnit.PlanckTime), "Plank Current", "Planck Current");
+            case I: return new DerivedUnit(PlanckUnit.PlanckCharge.dividedBy(PlanckUnit.PlanckTime),
+                "Plank Current", "Planck Current");
             case Θ: return PlanckUnit.PlanckTemperature;
             case N: return SIUnit.mol;
             case J: return SIUnit.cd;