From 2c146c894972e2c6ab701b3c66dcf242d7be656f Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Tue, 24 Dec 2019 16:16:13 -0500 Subject: Added Javadoc to the project. --- ...Collections.ConditionalExistenceCollection.html | 532 +++++++++++++++++++ ...ceCollections.ConditionalExistenceIterator.html | 493 ++++++++++++++++++ ...istenceCollections.ConditionalExistenceMap.html | 570 +++++++++++++++++++++ ...istenceCollections.ConditionalExistenceSet.html | 565 ++++++++++++++++++++ .../math/ConditionalExistenceCollections.html | 397 ++++++++++++++ .../math/ConditionalExistenceCollectionsTest.html | 469 +++++++++++++++++ doc/org/unitConverter/math/DecimalComparison.html | 492 ++++++++++++++++++ .../math/ExpressionParser.Builder.html | 391 ++++++++++++++ .../ExpressionParser.PriorityBinaryOperator.html | 425 +++++++++++++++ .../ExpressionParser.PriorityUnaryOperator.html | 425 +++++++++++++++ .../math/ExpressionParser.TokenType.html | 445 ++++++++++++++++ doc/org/unitConverter/math/ExpressionParser.html | 349 +++++++++++++ .../unitConverter/math/ExpressionParserTest.html | 360 +++++++++++++ doc/org/unitConverter/math/ObjectProduct.html | 553 ++++++++++++++++++++ doc/org/unitConverter/math/ObjectProductTest.html | 366 +++++++++++++ ...Collections.ConditionalExistenceCollection.html | 149 ++++++ ...ceCollections.ConditionalExistenceIterator.html | 197 +++++++ ...istenceCollections.ConditionalExistenceMap.html | 149 ++++++ ...istenceCollections.ConditionalExistenceSet.html | 149 ++++++ .../class-use/ConditionalExistenceCollections.html | 124 +++++ .../ConditionalExistenceCollectionsTest.html | 149 ++++++ .../math/class-use/DecimalComparison.html | 124 +++++ .../math/class-use/ExpressionParser.Builder.html | 184 +++++++ .../ExpressionParser.PriorityBinaryOperator.html | 221 ++++++++ .../ExpressionParser.PriorityUnaryOperator.html | 239 +++++++++ .../math/class-use/ExpressionParser.TokenType.html | 212 ++++++++ .../math/class-use/ExpressionParser.html | 166 ++++++ .../math/class-use/ExpressionParserTest.html | 149 ++++++ .../math/class-use/ObjectProduct.html | 515 +++++++++++++++++++ .../math/class-use/ObjectProductTest.html | 149 ++++++ doc/org/unitConverter/math/package-frame.html | 24 + doc/org/unitConverter/math/package-summary.html | 183 +++++++ doc/org/unitConverter/math/package-tree.html | 141 +++++ doc/org/unitConverter/math/package-use.html | 194 +++++++ 34 files changed, 10250 insertions(+) create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html create mode 100644 doc/org/unitConverter/math/DecimalComparison.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.Builder.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.TokenType.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.html create mode 100644 doc/org/unitConverter/math/ExpressionParserTest.html create mode 100644 doc/org/unitConverter/math/ObjectProduct.html create mode 100644 doc/org/unitConverter/math/ObjectProductTest.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html create mode 100644 doc/org/unitConverter/math/class-use/DecimalComparison.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParserTest.html create mode 100644 doc/org/unitConverter/math/class-use/ObjectProduct.html create mode 100644 doc/org/unitConverter/math/class-use/ObjectProductTest.html create mode 100644 doc/org/unitConverter/math/package-frame.html create mode 100644 doc/org/unitConverter/math/package-summary.html create mode 100644 doc/org/unitConverter/math/package-tree.html create mode 100644 doc/org/unitConverter/math/package-use.html (limited to 'doc/org/unitConverter/math') diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html new file mode 100644 index 0000000..3607ffa --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html @@ -0,0 +1,532 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceCollection + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceCollection<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractCollection<E>
      • +
    • +
        +
      • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection<E>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - type of element in collection
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>, java.util.Collection<E>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceCollection<E>
+extends java.util.AbstractCollection<E>
    +
    Elements in this collection only exist if they meet a condition.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      (package private) java.util.Collection<E>collection 
      (package private) java.util.function.Predicate<E>existenceCondition 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceCollection​(java.util.Collection<E> collection, + java.util.function.Predicate<E> existenceCondition) +
      Creates the ConditionalExistenceCollection.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanadd​(E e) 
      voidclear() 
      booleancontains​(java.lang.Object o) 
      java.util.Iterator<E>iterator() 
      booleanremove​(java.lang.Object o) 
      intsize() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        collection

        +
        final java.util.Collection<E> collection
        +
        • +
      + + + +
        +
      • +

        existenceCondition

        +
        final java.util.function.Predicate<E> existenceCondition
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceCollection

        +
        private ConditionalExistenceCollection​(java.util.Collection<E> collection,
+                                       java.util.function.Predicate<E> existenceCondition)
        +
        Creates the ConditionalExistenceCollection.
        +
        +
        Parameters:
        +
        collection -
        +
        existenceCondition -
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

        +
        public boolean add​(E e)
        +
        +
        Specified by:
        +
        add in interface java.util.Collection<E>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<E>
        +
        Overrides:
        +
        clear in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains​(java.lang.Object o)
        +
        +
        Specified by:
        +
        contains in interface java.util.Collection<E>
        +
        Overrides:
        +
        contains in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<E> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.util.Collection<E>
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<E>
        +
        Specified by:
        +
        iterator in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove​(java.lang.Object o)
        +
        +
        Specified by:
        +
        remove in interface java.util.Collection<E>
        +
        Overrides:
        +
        remove in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<E>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<E>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html new file mode 100644 index 0000000..0a3a963 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html @@ -0,0 +1,493 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceIterator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceIterator<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceIterator<E>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - type of elements in iterator
    +
    +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<E>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceIterator<E>
+extends java.lang.Object
+implements java.util.Iterator<E>
    +
    Elements in this wrapper iterator only exist if they pass a condition.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      (package private) java.util.function.Predicate<E>existenceCondition 
      (package private) booleanhasNext 
      (package private) java.util.Iterator<E>iterator 
      (package private) EnextElement 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceIterator​(java.util.Iterator<E> iterator, + java.util.function.Predicate<E> condition) +
      Creates the ConditionalExistenceIterator.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private voidgetAndSetNextElement() +
      Gets the next element, and sets nextElement and hasNext accordingly.
      +
      booleanhasNext() 
      Enext() 
      voidremove() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Iterator

        +forEachRemaining
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        iterator

        +
        final java.util.Iterator<E> iterator
        +
        • +
      + + + +
        +
      • +

        existenceCondition

        +
        final java.util.function.Predicate<E> existenceCondition
        +
        • +
      + + + +
        +
      • +

        nextElement

        +
        E nextElement
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        boolean hasNext
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceIterator

        +
        private ConditionalExistenceIterator​(java.util.Iterator<E> iterator,
+                                     java.util.function.Predicate<E> condition)
        +
        Creates the ConditionalExistenceIterator.
        +
        +
        Parameters:
        +
        iterator -
        +
        condition -
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAndSetNextElement

        +
        private void getAndSetNextElement()
        +
        Gets the next element, and sets nextElement and hasNext accordingly.
        +
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<E>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public E next()
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<E>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public void remove()
        +
        +
        Specified by:
        +
        remove in interface java.util.Iterator<E>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html new file mode 100644 index 0000000..1b7b1a7 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html @@ -0,0 +1,570 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceMap + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceMap<K,​V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractMap<K,​V>
      • +
    • +
        +
      • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap<K,​V>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - key type
    +
    V - value type
    +
    +
    +
    All Implemented Interfaces:
    +
    java.util.Map<K,​V>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceMap<K,​V>
+extends java.util.AbstractMap<K,​V>
    +
    Mappings in this map only exist if the entry passes some condition.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.util.AbstractMap

        +java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from interface java.util.Map

        +java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      (package private) java.util.function.Predicate<java.util.Map.Entry<K,​V>>entryExistenceCondition 
      (package private) java.util.Map<K,​V>map 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceMap​(java.util.Map<K,​V> map, + java.util.function.Predicate<java.util.Map.Entry<K,​V>> entryExistenceCondition) +
      Creates the ConditionalExistenceMap.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleancontainsKey​(java.lang.Object key) 
      java.util.Set<java.util.Map.Entry<K,​V>>entrySet() 
      Vget​(java.lang.Object key) 
      java.util.Set<K>keySet() 
      Vput​(K key, + V value) 
      Vremove​(java.lang.Object key) 
      java.util.Collection<V>values() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractMap

        +clear, clone, containsValue, equals, hashCode, isEmpty, putAll, size, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Map

        +compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        map

        +
        java.util.Map<K,​V> map
        +
        • +
      + + + +
        +
      • +

        entryExistenceCondition

        +
        java.util.function.Predicate<java.util.Map.Entry<K,​V>> entryExistenceCondition
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceMap

        +
        private ConditionalExistenceMap​(java.util.Map<K,​V> map,
+                                java.util.function.Predicate<java.util.Map.Entry<K,​V>> entryExistenceCondition)
        +
        Creates the ConditionalExistenceMap.
        +
        +
        Parameters:
        +
        map -
        +
        entryExistenceCondition -
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey​(java.lang.Object key)
        +
        +
        Specified by:
        +
        containsKey in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        containsKey in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        +
        +
        Specified by:
        +
        entrySet in interface java.util.Map<K,​V>
        +
        Specified by:
        +
        entrySet in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public V get​(java.lang.Object key)
        +
        +
        Specified by:
        +
        get in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        get in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<K> keySet()
        +
        +
        Specified by:
        +
        keySet in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        keySet in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + + + +
        +
      • +

        put

        +
        public V put​(K key,
+             V value)
        +
        +
        Specified by:
        +
        put in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        put in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public V remove​(java.lang.Object key)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        remove in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<V> values()
        +
        +
        Specified by:
        +
        values in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        values in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html new file mode 100644 index 0000000..060e2a3 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html @@ -0,0 +1,565 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceSet + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceSet<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractCollection<E>
      • +
    • +
        +
      • java.util.AbstractSet<E>
        • +
      • +
          +
        • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet<E>
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - type of element in set
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceSet<E>
+extends java.util.AbstractSet<E>
    +
    Elements in this set only exist if a certain condition is true.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.function.Predicate<E>existenceCondition 
      private java.util.Set<E>set 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceSet​(java.util.Set<E> set, + java.util.function.Predicate<E> existenceCondition) +
      Creates the ConditionalNonexistenceSet.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanadd​(E e)
      voidclear() 
      booleancontains​(java.lang.Object o) 
      java.util.Iterator<E>iterator() 
      booleanremove​(java.lang.Object o) 
      intsize() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractSet

        +equals, hashCode, removeAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, containsAll, isEmpty, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +parallelStream, removeIf, stream, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Set

        +addAll, containsAll, isEmpty, retainAll, spliterator, toArray, toArray
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        set

        +
        private final java.util.Set<E> set
        +
        • +
      + + + +
        +
      • +

        existenceCondition

        +
        private final java.util.function.Predicate<E> existenceCondition
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceSet

        +
        private ConditionalExistenceSet​(java.util.Set<E> set,
+                                java.util.function.Predicate<E> existenceCondition)
        +
        Creates the ConditionalNonexistenceSet.
        +
        +
        Parameters:
        +
        set - set to use
        +
        existenceCondition - condition where element exists
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

        +
        public boolean add​(E e)
        +
        +

        + Note that this method returns false if e does not pass the existence condition.

        +
        +
        Specified by:
        +
        add in interface java.util.Collection<E>
        +
        Specified by:
        +
        add in interface java.util.Set<E>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<E>
        +
        Specified by:
        +
        clear in interface java.util.Set<E>
        +
        Overrides:
        +
        clear in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains​(java.lang.Object o)
        +
        +
        Specified by:
        +
        contains in interface java.util.Collection<E>
        +
        Specified by:
        +
        contains in interface java.util.Set<E>
        +
        Overrides:
        +
        contains in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<E> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.util.Collection<E>
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<E>
        +
        Specified by:
        +
        iterator in interface java.util.Set<E>
        +
        Specified by:
        +
        iterator in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove​(java.lang.Object o)
        +
        +
        Specified by:
        +
        remove in interface java.util.Collection<E>
        +
        Specified by:
        +
        remove in interface java.util.Set<E>
        +
        Overrides:
        +
        remove in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<E>
        +
        Specified by:
        +
        size in interface java.util.Set<E>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<E>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.html new file mode 100644 index 0000000..2764146 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.html @@ -0,0 +1,397 @@ + + + + + +ConditionalExistenceCollections + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.math
+

Class ConditionalExistenceCollections

+
+
+ +
+
    +
  • +
    +
    +
    public final class ConditionalExistenceCollections
+extends java.lang.Object
    +
    Elements in these wrapper collections only exist if they pass a condition. +

    + All of the collections in this class are "views" of the provided collections. They are mutable if the provided + collections are mutable, they allow null if the provided collections allow null, they will reflect changes in the + provided collection, etc. +

    + The modification operations will always run the corresponding operations, even if the conditional existence + collection doesn't change. For example, if you have a set that ignores even numbers, add(2) will still add a 2 to the + backing set (but the conditional existence set will say it doesn't exist). +

    + The returned collections do not pass the hashCode and equals operations through to the backing collections, + but rely on Object's equals and hashCode methods. This is necessary to preserve the contracts + of these operations in the case that the backing collections are sets or lists. +

    + Other than that, the only difference between the provided collections and the returned collections are that + elements don't exist if they don't pass the provided condition.

    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <E> java.util.Collection<E>conditionalExistenceCollection(java.util.Collection<E> collection, + java.util.function.Predicate<E> existenceCondition) +
      Elements in the returned wrapper collection are ignored if they don't pass a condition.
      +
      static <E> java.util.Iterator<E>conditionalExistenceIterator(java.util.Iterator<E> iterator, + java.util.function.Predicate<E> existenceCondition) +
      Elements in the returned wrapper iterator are ignored if they don't pass a condition.
      +
      static <K,V> java.util.Map<K,V>conditionalExistenceMap(java.util.Map<K,V> map, + java.util.function.Predicate<java.util.Map.Entry<K,V>> entryExistenceCondition) +
      Mappings in the returned wrapper map are ignored if the corresponding entry doesn't pass a condition
      +
      static <E> java.util.Set<E>conditionalExistenceSet(java.util.Set<E> set, + java.util.function.Predicate<E> existenceCondition) +
      Elements in the returned wrapper set are ignored if they don't pass a condition.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceCollections

        +
        public ConditionalExistenceCollections()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        conditionalExistenceCollection

        +
        public static final <E> java.util.Collection<E> conditionalExistenceCollection(java.util.Collection<E> collection,
+                                                                               java.util.function.Predicate<E> existenceCondition)
        +
        Elements in the returned wrapper collection are ignored if they don't pass a condition.
        +
        +
        Type Parameters:
        +
        E - type of elements in collection
        +
        Parameters:
        +
        collection - collection to wrap
        +
        existenceCondition - elements only exist if this returns true
        +
        Returns:
        +
        wrapper collection
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        conditionalExistenceIterator

        +
        public static final <E> java.util.Iterator<E> conditionalExistenceIterator(java.util.Iterator<E> iterator,
+                                                                           java.util.function.Predicate<E> existenceCondition)
        +
        Elements in the returned wrapper iterator are ignored if they don't pass a condition.
        +
        +
        Type Parameters:
        +
        E - type of elements in iterator
        +
        Parameters:
        +
        iterator - iterator to wrap
        +
        existenceCondition - elements only exist if this returns true
        +
        Returns:
        +
        wrapper iterator
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        conditionalExistenceMap

        +
        public static final <K,V> java.util.Map<K,V> conditionalExistenceMap(java.util.Map<K,V> map,
+                                                                     java.util.function.Predicate<java.util.Map.Entry<K,V>> entryExistenceCondition)
        +
        Mappings in the returned wrapper map are ignored if the corresponding entry doesn't pass a condition
        +
        +
        Type Parameters:
        +
        K - type of key in map
        +
        V - type of value in map
        +
        Parameters:
        +
        map - map to wrap
        +
        entryExistenceCondition - mappings only exist if this returns true
        +
        Returns:
        +
        wrapper map
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        conditionalExistenceSet

        +
        public static final <E> java.util.Set<E> conditionalExistenceSet(java.util.Set<E> set,
+                                                                 java.util.function.Predicate<E> existenceCondition)
        +
        Elements in the returned wrapper set are ignored if they don't pass a condition.
        +
        +
        Type Parameters:
        +
        E - type of elements in set
        +
        Parameters:
        +
        set - set to wrap
        +
        existenceCondition - elements only exist if this returns true
        +
        Returns:
        +
        wrapper set
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html b/doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html new file mode 100644 index 0000000..e08b3f5 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html @@ -0,0 +1,469 @@ + + + + + +ConditionalExistenceCollectionsTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollectionsTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ConditionalExistenceCollectionsTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class ConditionalExistenceCollectionsTest
+extends java.lang.Object
    +
    Tests the #ConditionalExistenceCollections.
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      (package private) ConditionalExistenceCollections.ConditionalExistenceIterator<java.lang.String>getTestIterator() +
      The returned iterator ignores elements that don't start with "a".
      +
      (package private) java.util.Map<java.lang.String,​java.lang.Integer>getTestMap() +
      The returned map ignores mappings where the value is zero.
      +
      (package private) voidtestContainsKeyObject() +
      Test method for org.unitConverter.math.ZeroIsNullMap#containsKey(java.lang.Object).
      +
      (package private) voidtestContainsValueObject() +
      Test method for org.unitConverter.math.ZeroIsNullMap#containsValue(java.lang.Object).
      +
      (package private) voidtestEntrySet() +
      Test method for org.unitConverter.math.ZeroIsNullMap#entrySet().
      +
      (package private) voidtestGetObject() +
      Test method for org.unitConverter.math.ZeroIsNullMap#get(java.lang.Object).
      +
      (package private) voidtestIterator() 
      (package private) voidtestKeySet() +
      Test method for org.unitConverter.math.ZeroIsNullMap#keySet().
      +
      (package private) voidtestValues() +
      Test method for org.unitConverter.math.ZeroIsNullMap#values().
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceCollectionsTest

        +
        ConditionalExistenceCollectionsTest()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getTestMap

        +
        java.util.Map<java.lang.String,​java.lang.Integer> getTestMap()
        +
        The returned map ignores mappings where the value is zero.
        +
        +
        Returns:
        +
        map to be used for test data
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        testContainsKeyObject

        +
        @Test
+void testContainsKeyObject()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#containsKey(java.lang.Object).
        +
        • +
      + + + +
        +
      • +

        testContainsValueObject

        +
        @Test
+void testContainsValueObject()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#containsValue(java.lang.Object).
        +
        • +
      + + + +
        +
      • +

        testEntrySet

        +
        @Test
+void testEntrySet()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#entrySet().
        +
        • +
      + + + +
        +
      • +

        testGetObject

        +
        @Test
+void testGetObject()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#get(java.lang.Object).
        +
        • +
      + + + +
        +
      • +

        testIterator

        +
        @Test
+void testIterator()
        +
        • +
      + + + +
        +
      • +

        testKeySet

        +
        @Test
+void testKeySet()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#keySet().
        +
        • +
      + + + +
        +
      • +

        testValues

        +
        @Test
+void testValues()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#values().
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/DecimalComparison.html b/doc/org/unitConverter/math/DecimalComparison.html new file mode 100644 index 0000000..6b013fc --- /dev/null +++ b/doc/org/unitConverter/math/DecimalComparison.html @@ -0,0 +1,492 @@ + + + + + +DecimalComparison + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.math
+

Class DecimalComparison

+
+
+ +
+
    +
  • +
    +
    +
    public final class DecimalComparison
+extends java.lang.Object
    +
    A class that contains methods to compare float and double values.
    +
    +
    Since:
    +
    2019-03-18, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static doubleDOUBLE_EPSILON +
      The value used for double comparison.
      +
      static floatFLOAT_EPSILON +
      The value used for float comparison.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static booleanequals(double a, + double b) +
      Tests for equality of double values using DOUBLE_EPSILON.
      +
      static booleanequals(double a, + double b, + double epsilon) +
      Tests for double equality using a custom epsilon value.
      +
      static booleanequals(float a, + float b) +
      Tests for equality of float values using FLOAT_EPSILON.
      +
      static booleanequals(float a, + float b, + float epsilon) +
      Tests for float equality using a custom epsilon value.
      +
      static inthash(double d) +
      Takes the hash code of doubles.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DOUBLE_EPSILON

        +
        public static final double DOUBLE_EPSILON
        +
        The value used for double comparison. If two double values are within this value multiplied by the larger value, + they are considered equal.
        +
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        FLOAT_EPSILON

        +
        public static final float FLOAT_EPSILON
        +
        The value used for float comparison. If two float values are within this value multiplied by the larger value, + they are considered equal.
        +
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(double a,
+                                   double b)
        +
        Tests for equality of double values using DOUBLE_EPSILON. +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon using equals(double, double, double) (this does not make a violation of + transitivity impossible, it just significantly reduces the chances of it happening) +
        2. Use BigDecimal instead of double (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        See Also:
        +
        #hashCode(double)
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(double a,
+                                   double b,
+                                   double epsilon)
        +
        Tests for double equality using a custom epsilon value. + +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon (this does not make a violation of transitivity impossible, it just significantly + reduces the chances of it happening) +
        2. Use BigDecimal instead of double (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        epsilon - allowed difference
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(float a,
+                                   float b)
        +
        Tests for equality of float values using FLOAT_EPSILON. + +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon using equals(float, float, float) (this does not make a violation of + transitivity impossible, it just significantly reduces the chances of it happening) +
        2. Use BigDecimal instead of float (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(float a,
+                                   float b,
+                                   float epsilon)
        +
        Tests for float equality using a custom epsilon value. + +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon (this does not make a violation of transitivity impossible, it just significantly + reduces the chances of it happening) +
        2. Use BigDecimal instead of float (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        epsilon - allowed difference
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        hash

        +
        public static final int hash(double d)
        +
        Takes the hash code of doubles. Values that are equal according to equals(double, double) will have the + same hash code.
        +
        +
        Parameters:
        +
        d - double to hash
        +
        Returns:
        +
        hash code of double
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ExpressionParser.Builder.html b/doc/org/unitConverter/math/ExpressionParser.Builder.html new file mode 100644 index 0000000..563f6eb --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.Builder.html @@ -0,0 +1,391 @@ + + + + + +ExpressionParser.Builder + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.math
+

Class ExpressionParser.Builder<T>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of object that exists in parsed expressions
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    +
    public static final class ExpressionParser.Builder<T>
+extends java.lang.Object
    +
    A builder that can create ExpressionParser<T> instances.
    +
    +
    Since:
    +
    2019-03-17, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Builder(java.util.function.Function<java.lang.String,? extends T> objectObtainer) +
      Creates the Builder.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder(java.util.function.Function<java.lang.String,? extends T> objectObtainer)
        +
        Creates the Builder.
        +
        +
        Parameters:
        +
        objectObtainer - a function that can turn strings into objects of the type handled by the parser.
        +
        Throws:
        +
        java.lang.NullPointerException - if objectObtainer is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addBinaryOperator

        +
        public ExpressionParser.Builder<T> addBinaryOperator(java.lang.String text,
+                                                     java.util.function.BinaryOperator<T> operator,
+                                                     int priority)
        +
        Adds a binary operator to the builder.
        +
        +
        Parameters:
        +
        text - text used to reference the operator, like '+'
        +
        operator - operator to add
        +
        priority - operator's priority, which determines which operators are applied first
        +
        Returns:
        +
        this builder
        +
        Throws:
        +
        java.lang.NullPointerException - if text or operator is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        addSpaceFunction

        +
        public ExpressionParser.Builder<T> addSpaceFunction(java.lang.String operator)
        +
        Adds a function for spaces. You must use the text of an existing binary operator.
        +
        +
        Parameters:
        +
        operator - text of operator to use
        +
        Returns:
        +
        this builder
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        addUnaryOperator

        +
        public ExpressionParser.Builder<T> addUnaryOperator(java.lang.String text,
+                                                    java.util.function.UnaryOperator<T> operator,
+                                                    int priority)
        +
        Adds a unary operator to the builder.
        +
        +
        Parameters:
        +
        text - text used to reference the operator, like '-'
        +
        operator - operator to add
        +
        priority - operator's priority, which determines which operators are applied first
        +
        Returns:
        +
        this builder
        +
        Throws:
        +
        java.lang.NullPointerException - if text or operator is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        build

        +
        public ExpressionParser<T> build()
        +
        +
        Returns:
        +
        an ExpressionParser<T> instance with the properties given to this builder
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html b/doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html new file mode 100644 index 0000000..ad8f42a --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html @@ -0,0 +1,425 @@ + + + + + +ExpressionParser.PriorityBinaryOperator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ExpressionParser.PriorityBinaryOperator<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ExpressionParser.PriorityBinaryOperator<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of operand and result
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<ExpressionParser.PriorityBinaryOperator<T>>, java.util.function.BiFunction<T,​T,​T>, java.util.function.BinaryOperator<T>
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    private abstract static class ExpressionParser.PriorityBinaryOperator<T>
+extends java.lang.Object
+implements java.util.function.BinaryOperator<T>, java.lang.Comparable<ExpressionParser.PriorityBinaryOperator<T>>
    +
    A binary operator with a priority field that determines which operators apply first.
    +
    +
    Since:
    +
    2019-03-17, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intpriority +
      The operator's priority.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PriorityBinaryOperator​(int priority) +
      Creates the PriorityBinaryOperator.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        priority

        +
        private final int priority
        +
        The operator's priority. Higher-priority operators are applied before lower-priority operators
        +
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PriorityBinaryOperator

        +
        public PriorityBinaryOperator​(int priority)
        +
        Creates the PriorityBinaryOperator.
        +
        +
        Parameters:
        +
        priority - operator's priority
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(ExpressionParser.PriorityBinaryOperator<T> o)
        +
        Compares this object to another by priority. + +

        + +

        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<T>
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPriority

        +
        public final int getPriority()
        +
        +
        Returns:
        +
        priority
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html b/doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html new file mode 100644 index 0000000..cddfb62 --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html @@ -0,0 +1,425 @@ + + + + + +ExpressionParser.PriorityUnaryOperator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ExpressionParser.PriorityUnaryOperator<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ExpressionParser.PriorityUnaryOperator<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of operand and result
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<ExpressionParser.PriorityUnaryOperator<T>>, java.util.function.Function<T,​T>, java.util.function.UnaryOperator<T>
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    private abstract static class ExpressionParser.PriorityUnaryOperator<T>
+extends java.lang.Object
+implements java.util.function.UnaryOperator<T>, java.lang.Comparable<ExpressionParser.PriorityUnaryOperator<T>>
    +
    A unary operator with a priority field that determines which operators apply first.
    +
    +
    Since:
    +
    2019-03-17, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intpriority +
      The operator's priority.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PriorityUnaryOperator​(int priority) +
      Creates the PriorityUnaryOperator.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intcompareTo​(ExpressionParser.PriorityUnaryOperator<T> o) +
      Compares this object to another by priority.
      +
      intgetPriority() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.function.Function

        +andThen, apply, compose
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        priority

        +
        private final int priority
        +
        The operator's priority. Higher-priority operators are applied before lower-priority operators
        +
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PriorityUnaryOperator

        +
        public PriorityUnaryOperator​(int priority)
        +
        Creates the PriorityUnaryOperator.
        +
        +
        Parameters:
        +
        priority - operator's priority
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(ExpressionParser.PriorityUnaryOperator<T> o)
        +
        Compares this object to another by priority. + +

        + +

        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<T>
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPriority

        +
        public final int getPriority()
        +
        +
        Returns:
        +
        priority
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ExpressionParser.TokenType.html b/doc/org/unitConverter/math/ExpressionParser.TokenType.html new file mode 100644 index 0000000..40c9d05 --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.TokenType.html @@ -0,0 +1,445 @@ + + + + + +ExpressionParser.TokenType + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Enum ExpressionParser.TokenType

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ExpressionParser.TokenType>
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    private static enum ExpressionParser.TokenType
+extends java.lang.Enum<ExpressionParser.TokenType>
    +
    The types of tokens that are available.
    +
    +
    Since:
    +
    2019-03-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private TokenType() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static ExpressionParser.TokenTypevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ExpressionParser.TokenType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TokenType

        +
        private TokenType()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ExpressionParser.TokenType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ExpressionParser.TokenType c : ExpressionParser.TokenType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ExpressionParser.TokenType valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ExpressionParser.html b/doc/org/unitConverter/math/ExpressionParser.html new file mode 100644 index 0000000..601bf35 --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.html @@ -0,0 +1,349 @@ + + + + + +ExpressionParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.math
+

Class ExpressionParser<T>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of object that exists in parsed expressions
    +
    +
    +
    +
    public final class ExpressionParser<T>
+extends java.lang.Object
    +
    An object that can parse expressions with unary or binary operators.
    +
    +
    Since:
    +
    2019-03-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class ExpressionParser.Builder<T> +
      A builder that can create ExpressionParser<T> instances.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static charCLOSING_BRACKET +
      The closing bracket.
      +
      static charOPENING_BRACKET +
      The opening bracket.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      TparseExpression(java.lang.String expression) +
      Parses an expression.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        OPENING_BRACKET

        +
        public static final char OPENING_BRACKET
        +
        The opening bracket.
        +
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        CLOSING_BRACKET

        +
        public static final char CLOSING_BRACKET
        +
        The closing bracket.
        +
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseExpression

        +
        public T parseExpression(java.lang.String expression)
        +
        Parses an expression.
        +
        +
        Parameters:
        +
        expression - expression to parse
        +
        Returns:
        +
        result
        +
        Throws:
        +
        java.lang.NullPointerException - if expression is null
        +
        Since:
        +
        2019-03-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ExpressionParserTest.html b/doc/org/unitConverter/math/ExpressionParserTest.html new file mode 100644 index 0000000..e39075d --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParserTest.html @@ -0,0 +1,360 @@ + + + + + +ExpressionParserTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ExpressionParserTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ExpressionParserTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class ExpressionParserTest
+extends java.lang.Object
    +
    A test for the ExpressionParser class. This is NOT part of this program's public API.
    +
    +
    Since:
    +
    2019-03-22, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ObjectProduct.html b/doc/org/unitConverter/math/ObjectProduct.html new file mode 100644 index 0000000..08f8e8f --- /dev/null +++ b/doc/org/unitConverter/math/ObjectProduct.html @@ -0,0 +1,553 @@ + + + + + +ObjectProduct + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.math
+

Class ObjectProduct<T>

+
+
+ +
+
    +
  • +
    +
    +
    public final class ObjectProduct<T>
+extends java.lang.Object
    +
    An immutable product of multiple objects of a type, such as base units. The objects can be multiplied and + exponentiated.
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static final <T> ObjectProduct<T> empty()
        +
        Returns an empty ObjectProduct of a certain type
        +
        +
        Type Parameters:
        +
        T - type of objects that can be multiplied
        +
        Returns:
        +
        empty product
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        fromExponentMapping

        +
        public static final <T> ObjectProduct<T> fromExponentMapping(java.util.Map<T,java.lang.Integer> map)
        +
        Gets an ObjectProduct from an object-to-integer mapping
        +
        +
        Type Parameters:
        +
        T - type of object in product
        +
        Parameters:
        +
        map - map mapping objects to exponents
        +
        Returns:
        +
        object product
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + + + +
        +
      • +

        oneOf

        +
        public static final <T> ObjectProduct<T> oneOf(T object)
        +
        Gets an ObjectProduct that has one of the inputted argument, and nothing else.
        +
        +
        Parameters:
        +
        object - object that will be in the product
        +
        Returns:
        +
        product
        +
        Throws:
        +
        java.lang.NullPointerException - if object is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        dividedBy

        +
        public ObjectProduct<T> dividedBy(ObjectProduct<T> other)
        +
        Calculates the quotient of two products
        +
        +
        Parameters:
        +
        other - other product
        +
        Returns:
        +
        quotient of two products
        +
        Throws:
        +
        java.lang.NullPointerException - if other is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        exponentMap

        +
        public java.util.Map<T,java.lang.Integer> exponentMap()
        +
        +
        Returns:
        +
        immutable map mapping objects to exponents
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        getBaseSet

        +
        public final java.util.Set<T> getBaseSet()
        +
        +
        Returns:
        +
        a set of all of the base objects with non-zero exponents that make up this dimension.
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      + + + + + +
        +
      • +

        getExponent

        +
        public int getExponent(T dimension)
        +
        Gets the exponent for a specific dimension.
        +
        +
        Parameters:
        +
        dimension - dimension to check
        +
        Returns:
        +
        exponent for that dimension
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        isSingleObject

        +
        public boolean isSingleObject()
        +
        +
        Returns:
        +
        true if this product is a single object, i.e. it has one exponent of one and no other nonzero exponents
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        times

        +
        public ObjectProduct<T> times(ObjectProduct<T> other)
        +
        Multiplies this product by another
        +
        +
        Parameters:
        +
        other - other product
        +
        Returns:
        +
        product of two products
        +
        Throws:
        +
        java.lang.NullPointerException - if other is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        toExponent

        +
        public ObjectProduct<T> toExponent(int exponent)
        +
        Returns this product, but to an exponent
        +
        +
        Parameters:
        +
        exponent - exponent
        +
        Returns:
        +
        result of exponentiation
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Converts this product to a string using the objects' Object.toString() method. If objects have a long + toString representation, it is recommended to use toString(Function) instead to shorten the returned + string. + +

        +

        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.util.function.Function<T,java.lang.String> objectToString)
        +
        Converts this product to a string. The objects that make up this product are represented by + objectToString
        +
        +
        Parameters:
        +
        objectToString - function to convert objects to strings
        +
        Returns:
        +
        string representation of product
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ObjectProductTest.html b/doc/org/unitConverter/math/ObjectProductTest.html new file mode 100644 index 0000000..2fb1aa4 --- /dev/null +++ b/doc/org/unitConverter/math/ObjectProductTest.html @@ -0,0 +1,366 @@ + + + + + +ObjectProductTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ObjectProductTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ObjectProductTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class ObjectProductTest
+extends java.lang.Object
    +
    Tests for ObjectProduct using BaseDimension as a test object. This is NOT part of this program's public API.
    +
    +
    Since:
    +
    2018-12-12, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ObjectProductTest() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidtestEquals() +
      Tests UnitDimension#equals
      +
      voidtestExponents() +
      Tests UnitDimension's exponentiation
      +
      voidtestMultiplicationAndDivision() +
      Tests UnitDimension's multiplication and division.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObjectProductTest

        +
        ObjectProductTest()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        testEquals

        +
        @Test
+public void testEquals()
        +
        Tests UnitDimension#equals
        +
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        testExponents

        +
        @Test
+public void testExponents()
        +
        Tests UnitDimension's exponentiation
        +
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        testMultiplicationAndDivision

        +
        @Test
+public void testMultiplicationAndDivision()
        +
        Tests UnitDimension's multiplication and division.
        +
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html new file mode 100644 index 0000000..b8b2122 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html new file mode 100644 index 0000000..c521457 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceIterator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceIterator

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html new file mode 100644 index 0000000..fe3a0ec --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html new file mode 100644 index 0000000..e35104b --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.html new file mode 100644 index 0000000..d56f5bf --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html new file mode 100644 index 0000000..4fa2386 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollectionsTest + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollectionsTest

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollectionsTest
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/DecimalComparison.html b/doc/org/unitConverter/math/class-use/DecimalComparison.html new file mode 100644 index 0000000..0090edb --- /dev/null +++ b/doc/org/unitConverter/math/class-use/DecimalComparison.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.math.DecimalComparison + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.DecimalComparison

+
+
No usage of org.unitConverter.math.DecimalComparison
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html b/doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html new file mode 100644 index 0000000..fdedeca --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html @@ -0,0 +1,184 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.Builder + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ExpressionParser.Builder

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html new file mode 100644 index 0000000..86c2daf --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html @@ -0,0 +1,221 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.PriorityBinaryOperator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParser.PriorityBinaryOperator

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html new file mode 100644 index 0000000..1d8f896 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html @@ -0,0 +1,239 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.PriorityUnaryOperator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParser.PriorityUnaryOperator

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html b/doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html new file mode 100644 index 0000000..7932193 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html @@ -0,0 +1,212 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.TokenType + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParser.TokenType

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.html b/doc/org/unitConverter/math/class-use/ExpressionParser.html new file mode 100644 index 0000000..2e75c83 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.html @@ -0,0 +1,166 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ExpressionParser

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParserTest.html b/doc/org/unitConverter/math/class-use/ExpressionParserTest.html new file mode 100644 index 0000000..cdee52e --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParserTest.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParserTest + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParserTest

+
+
No usage of org.unitConverter.math.ExpressionParserTest
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ObjectProduct.html b/doc/org/unitConverter/math/class-use/ObjectProduct.html new file mode 100644 index 0000000..1f326fa --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ObjectProduct.html @@ -0,0 +1,515 @@ + + + + + +Uses of Class org.unitConverter.math.ObjectProduct + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ObjectProduct

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ObjectProductTest.html b/doc/org/unitConverter/math/class-use/ObjectProductTest.html new file mode 100644 index 0000000..bb7eca6 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ObjectProductTest.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ObjectProductTest + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ObjectProductTest

+
+
No usage of org.unitConverter.math.ObjectProductTest
+
+ + + diff --git a/doc/org/unitConverter/math/package-frame.html b/doc/org/unitConverter/math/package-frame.html new file mode 100644 index 0000000..46d3edd --- /dev/null +++ b/doc/org/unitConverter/math/package-frame.html @@ -0,0 +1,24 @@ + + + + + +org.unitConverter.math + + + + + +

org.unitConverter.math

+
+

Classes

+ +
+ + diff --git a/doc/org/unitConverter/math/package-summary.html b/doc/org/unitConverter/math/package-summary.html new file mode 100644 index 0000000..ea8dec5 --- /dev/null +++ b/doc/org/unitConverter/math/package-summary.html @@ -0,0 +1,183 @@ + + + + + +org.unitConverter.math + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package org.unitConverter.math

+
+
Supplementary classes that are not related to units, but are necessary for their function.
+
+

See: Description

+
+
+ + + + +

Package org.unitConverter.math Description

+
Supplementary classes that are not related to units, but are necessary for their function.
+
+
Since:
+
2019-03-14, v0.2.0
+
Author:
+
Adrien Hopkins
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/package-tree.html b/doc/org/unitConverter/math/package-tree.html new file mode 100644 index 0000000..116fe4e --- /dev/null +++ b/doc/org/unitConverter/math/package-tree.html @@ -0,0 +1,141 @@ + + + + + +org.unitConverter.math Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package org.unitConverter.math

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/package-use.html b/doc/org/unitConverter/math/package-use.html new file mode 100644 index 0000000..35075d2 --- /dev/null +++ b/doc/org/unitConverter/math/package-use.html @@ -0,0 +1,194 @@ + + + + + +Uses of Package org.unitConverter.math + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
org.unitConverter.math

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3