Merge pull request #514 from Hopding/robust-classifier-type-comparison-513

Changed use of "==" operator to Class.isAssignableFrom method

Author: cogmission

src/main/java/org/numenta/nupic/model/Synapse.java

@@ -239,6 +239,8 @@ public boolean equals(Object obj) {
             return false;
         if(synapseIndex != other.synapseIndex)
             return false;
+        if(permanence != other.permanence)
+            return false;
         return true;
     }
 }

src/main/java/org/numenta/nupic/network/Layer.java

@@ -1934,21 +1934,24 @@ NamedTuple makeClassifiers(MultiEncoder encoder) {
         int i = 0;
         for(EncoderTuple et : encoder.getEncoders(encoder)) {
             names[i] = et.getName();
-            Object fieldClassifier = inferredFields.get(et.getName());
-            if(fieldClassifier == CLAClassifier.class) {
+            Class fieldClassifier = inferredFields.get(et.getName());
+            if(fieldClassifier == null) {
+                LOGGER.info("Not classifying \"" + et.getName() + "\" input field");
+            }
+            else if(CLAClassifier.class.isAssignableFrom(fieldClassifier)) {
                 LOGGER.info("Classifying \"" + et.getName() + "\" input field with CLAClassifier");
                 ca[i] = new CLAClassifier();
-            } else if(fieldClassifier == SDRClassifier.class) {
+            }
+            else if(SDRClassifier.class.isAssignableFrom(fieldClassifier)) {
                 LOGGER.info("Classifying \"" + et.getName() + "\" input field with SDRClassifier");
                 ca[i] = new SDRClassifier();
-            } else if(fieldClassifier != null) {
+            }
+            else {
                 throw new IllegalStateException(
                         "Invalid Classifier class token, \"" + fieldClassifier + "\",\n\t" +
                         "specified for, \"" + et.getName() + "\", input field.\n\t" +
                         "Valid class tokens are CLAClassifier.class and SDRClassifier.class"
                 );
-            } else { // fieldClassifier is null
-                LOGGER.info("Not classifying \"" + et.getName() + "\" input field");
             }
             i++;
         }

src/test/java/org/numenta/nupic/model/SynapseTest.java

@@ -0,0 +1,73 @@
+package org.numenta.nupic.model;
+
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+public class SynapseTest {
+    @Test
+    public void testSynapseEquality() {
+        // Make stuff we need to perform the tests
+        Column column = new Column(1, 0);
+        Cell cell1 = new Cell(column, 0);
+        Cell cell2 = new Cell(column, 1);
+        DistalDendrite segment1 = new DistalDendrite(cell1, 0, 0, 0);
+        DistalDendrite segment2 = new DistalDendrite(cell1, 1, 1, 1);
+
+        // These are the Synapse objects we will use for the tests
+        Synapse synapse1 = new Synapse();
+        Synapse synapse2 = new Synapse();
+
+        /* ----- These are the equality tests: ----- */
+        // synapse1 should equal itself
+        assertTrue(synapse1.equals(synapse1));
+
+        // synapse1 should not equal null
+        assertFalse(synapse1.equals(null));
+
+        // synapse1 should not equal a non-Synapse object
+        assertFalse(synapse1.equals("This is not a Synapse object"));
+
+        // synapse1 should not equal synapse2 because synapse2's
+        // inputIndex != synapse1's inputIndex
+        synapse1.setPresynapticCell(cell1);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should not equal synapse2 because synapse1's
+        // segment is null, but synapse2's segment is not null
+        synapse2 = new Synapse(cell1, segment1, 0, 0);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should not equal synapse2 because synapse1's
+        // segment != synapse2's segment
+        synapse1 = new Synapse(cell1, segment2, 0, 0);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should not equal synapse2 because synapse1's
+        // sourceCell is null, but synapse2's sourceCell is not null
+        synapse1.setPresynapticCell(null);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should not equal synapse2 because synapse1's
+        // sourceCell != synapse2's sourceCell
+        synapse1.setPresynapticCell(cell2);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should not equal synapse2 because synapse1's
+        // synapseIndex != synapse2's synapseIndex
+        synapse1 = new Synapse(cell1, segment1, 0, 0);
+        synapse2 = new Synapse(cell1, segment1, 1, 0);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should not equal synapse2 because synapse1's
+        // permanence != synapse2's permanence
+        synapse1 = new Synapse(cell1, segment1, 0, 0);
+        synapse2 = new Synapse(cell1, segment1, 0, 1);
+        assertFalse(synapse1.equals(synapse2));
+
+        // synapse1 should equal synapse2 because all of their
+        // relevant properties are equal
+        synapse1 = new Synapse(cell1, segment1, 0, 0);
+        synapse2 = new Synapse(cell1, segment1, 0, 0);
+        assertTrue(synapse1.equals(synapse2));
+    }
+}