samples/apifest1/day2/pinbasedsolution/test/org/netbeans/apifest/boolcircuit/RealTest.java
author Jaroslav Tulach <jtulach@netbeans.org>
Sat, 14 Jun 2008 09:52:45 +0200
changeset 52 4257f4cf226b
permissions -rw-r--r--
Adding samples from API fest to the repository, including pieces of their code in the document, not just links
     1 /*
     2  * The contents of this file are subject to the terms of the Common Development
     3  * and Distribution License (the License). You may not use this file except in
     4  * compliance with the License.
     5  *
     6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
     7  * or http://www.netbeans.org/cddl.txt.
     8  *
     9  * When distributing Covered Code, include this CDDL Header Notice in each file
    10  * and include the License file at http://www.netbeans.org/cddl.txt.
    11  * If applicable, add the following below the CDDL Header, with the fields
    12  * enclosed by brackets [] replaced by your own identifying information:
    13  * "Portions Copyrighted [year] [name of copyright owner]"
    14  *
    15  * The Original Software is NetBeans. The Initial Developer of the Original
    16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
    17  * Microsystems, Inc. All Rights Reserved.
    18  */
    19 
    20 package org.netbeans.apifest.boolcircuit;
    21 
    22 import java.security.CodeSource;
    23 import java.security.Permission;
    24 import java.security.PermissionCollection;
    25 import java.security.Policy;
    26 import java.util.Collection;
    27 import java.util.Collections;
    28 import java.util.Enumeration;
    29 import junit.framework.TestCase;
    30 import junit.framework.*;
    31 
    32 /** This file contains the APIFest quest for day 2. Simply, turn the 
    33  * boolean circuit into circuit that can compute with double values from 0 to 1.
    34  * <p>
    35  * This means that where ever a boolean was used to represent input or 
    36  * output values, one can now use any double number from >= 0 and <= 1.
    37  * Still, to support backward compatibility, the operations with booleans
    38  * has to be kept available and have to work. In fact False shall be 
    39  * treated as 0 and True as 1.
    40  * <p>
    41  * The basic elements has to be modified to work on doubles in the following
    42  * way:
    43  * <ul>
    44  *   <li>negation - neg(x) = 1 - x, this is correct extension as neg(false)=neg(0)=1-0=1=true
    45  *   <li>and - and(x,y) = x * y, again this is fine as and(true,true)=1*1=true and also
    46  *             and(false,true)=0*1=0=false
    47  *   <li>or - or(x,y) = 1 - (1 - x) * (1 - y) and this is also ok as
    48  *             or(false,false) = 1 - (1 - 0) * (1 - 0) = 1 - 1 = 0 = false
    49  *             or(true,false) = 1 - (1 - 1) * (1 - 0) = 1 - 0 * 1 = 1 = true
    50  * </ul>
    51  * <p>
    52  * However as the circuits with doubles are more rich than plain boolean circuits,
    53  * there is additional requirement to allow any user of your API to write its 
    54  * own "element" type. This is all going to be exercise in the tests bellow
    55  * which you are supposed to implement.
    56  */
    57 public class RealTest extends TestCase {
    58     static {
    59         // your code shall run without any permissions
    60     }
    61     
    62     public RealTest(String testName) {
    63         super(testName);
    64     }
    65 
    66     protected void setUp() throws Exception {
    67     }
    68 
    69     protected void tearDown() throws Exception {
    70     }
    71     
    72     
    73     /** First of all create a circuit which will evaluate
    74      * expression (X1 and X2) or not(x1). Hold the circuit
    75      * in some variable.
    76      *
    77      * Feed this circuit with x1=true, x2=false, assert result is false
    78      *
    79      * Feed the same circuit with x1=false, x2=true, assert result is true
    80      *
    81      * Feed the same circuit with x1=0.0, x2=1.0, assert result is 1.0
    82      *
    83      * Feed the same circuit with x1=0.5, x2=0.5, assert result is 0.625
    84      *
    85      * Feed the same circuit with x1=0.0, x2=2.0, make sure it throws an exception
    86      */
    87     public void testX1andX2orNotX1() throws Exception {
    88         boolean fired = false;
    89 
    90         Circuit c = Circuit.construct(
    91             Element.createOr(
    92                 Element.createAnd(
    93                     Element.createInput(0),
    94                     Element.createInput(1)
    95                 ),
    96                 Element.createNot(Element.createInput(0))
    97             )
    98         );
    99         
   100         assertFalse ("false", c.evaluate(true, false));
   101         assertTrue ("true", c.evaluate(false, true));
   102         assertEquals ("1.0", 1.0, c.evaluate(0.0, 1.0));
   103         assertEquals ("0.625", 0.625, c.evaluate(0.5, 0.5));
   104         try {
   105             c.evaluate(0.0, 2.0);
   106         } catch (Exception exc) {
   107             fired = true;
   108         }
   109         assertTrue ("Fired an exception for wrong input", fired);
   110     }
   111     
   112     /** Ensure that one variable cannot be filled with two different values.
   113      * Create a circuit for x1 and x1. Make sure that for any usage of your
   114      * API that would not lead to x1 * x1 result, an exception is thrown.
   115      * For example if there was a way to feed the circuit with two different 
   116      * values 0.3 and 0.5 an exception is thrown indicating that this is 
   117      * improper use of the circuit.
   118      */
   119     public void testImproperUseOfTheCircuit() throws Exception {
   120         final double[] inputs = new double[] {1.0};
   121         
   122         // Cheating a little bit with one more gate, but the same effect
   123         // could be obtained with (hard to achieve) thread race condition.
   124         Circuit evil = Circuit.construct(
   125             Element.createAnd(
   126                 Element.createGate(
   127                     Element.createInput(0),
   128                     Element.createInput(0),
   129                     new Function() {
   130                         public double evaluate(double input1, double input2) {
   131                             inputs[0] = 0.0;
   132                             return input1*input2;
   133                         }
   134 
   135                     }
   136                 ),
   137                 Element.createInput(0)
   138             )
   139         );
   140         assertEquals ("1 and 1 'and' 1 = 1", 1.0, evil.evaluate(inputs));
   141                 
   142     }
   143     
   144     /** Write your own element type called "gte" that will have two inputs and one output.
   145      * The output value will be 1 if x1 >= x2 and 0 otherwise. 
   146      * 
   147      * Create 
   148      * circuit for following expression: (x1 and not(x1)) gte x1
   149      *
   150      * Feed the circuit with 0.5 and verify the result is 0
   151      *
   152      * Feed the same circuit with 1 and verify the result is 0
   153      *
   154      * Feed the same circuit with 0 and verify the result is 1
   155      */
   156     public void testGreaterThanEqualElement() throws Exception {
   157         Circuit c = Circuit.construct(
   158             Element.createGate(
   159                 Element.createAnd(
   160                     Element.createInput(0),
   161                     Element.createNot(Element.createInput(0))
   162                 ),
   163                 Element.createInput(0),
   164                 new Function() {
   165                     public double evaluate(double input1, double input2) {
   166                         return input1 >= input2 ? 1.0 : 0.0;
   167                     }
   168 
   169                 }
   170             )
   171         );
   172         
   173         assertEquals ("0.0", 0.0, c.evaluate(0.5));
   174         assertEquals ("0.0", 0.0, c.evaluate(1.0));
   175         assertEquals ("1.0", 1.0, c.evaluate(0.0));
   176     }
   177 }