samples/apifest1/day2/inputandoperation/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() {
    88         VariableInput x1 = Factory.createVariableInput();
    89         VariableInput x2 = Factory.createVariableInput();
    90         Operation and = Factory.createAndOperation(x1, x2);
    91         Operation not = Factory.createNotOperation(x1);
    92         Operation or = Factory.createOrOperation(Factory.createOperationBasedInput(and), Factory.createOperationBasedInput(not));
    93         
    94         x1.setBooleanValue(false);
    95         x2.setBooleanValue(true);
    96         assertTrue(Circuit.evaluateBooleanOperation(or));
    97         
    98         x1.setRealValue(0.0);
    99         x2.setRealValue(1.0);
   100         assertEquals(1.0, Circuit.evaluateRealOperation(or));
   101         
   102         x1.setRealValue(0.5);
   103         x2.setRealValue(0.5);
   104         assertEquals(0.625, Circuit.evaluateRealOperation(or));
   105         
   106         try {
   107             x1.setRealValue(0.0);
   108             x2.setRealValue(2.0);
   109             Circuit.evaluateRealOperation(or);
   110             fail();
   111         } catch (IllegalArgumentException exc) {
   112             //good..
   113         }
   114 
   115     }
   116     
   117     /** Ensure that one variable cannot be filled with two different values.
   118      * Create a circuit for x1 and x1. Make sure that for any usage of your
   119      * API that would not lead to x1 * x1 result, an exception is thrown.
   120      * For example if there was a way to feed the circuit with two different 
   121      * values 0.3 and 0.5 an exception is thrown indicating that this is 
   122      * improper use of the circuit.
   123      */
   124     public void testImproperUseOfTheCircuit() {
   125 
   126         // this is enforced by the setter on the VariableInput.. how to test??
   127         
   128         
   129         
   130 //        fail("task2");
   131         // PS: This request is based on observation that some API from day1
   132         // solved the multiple usage of one variable, by repeating its 
   133         // value multiple times. This tasks says that if this is case of
   134         // your API you must make sure, when that usage of different values
   135         // for one variable is prohibited. If there is no way in your API to
   136         // express this task, just say so, and you do not need to write a test.
   137         // However if anyone else finds a way to simulate such situation in your
   138         // API later, it will get points for breaking your API.
   139     }
   140     
   141     /** Write your own element type called "gte" that will have two inputs and one output.
   142      * The output value will be 1 if x1 >= x2 and 0 otherwise. 
   143      * 
   144      * Create 
   145      * circuit for following expression: (x1 and not(x1)) gte x1
   146      *
   147      * Feed the circuit with 0.5 and verify the result is 0
   148      *
   149      * Feed the same circuit with 1 and verify the result is 0
   150      *
   151      * Feed the same circuit with 0 and verify the result is 1
   152      */
   153     public void testGreaterThanEqualElement() {
   154         VariableInput x1 = Factory.createVariableInput();
   155         Operation not = Factory.createNotOperation(x1);
   156         Operation and = Factory.createAndOperation(x1, Factory.createOperationBasedInput(not));
   157         Operation gte = new GTEOperation(Factory.createOperationBasedInput(and), x1);
   158         
   159         x1.setRealValue(0.5);
   160         assertEquals(0.0, Circuit.evaluateRealOperation(gte));
   161         
   162         x1.setRealValue(1.0);
   163         assertEquals(0.0, Circuit.evaluateRealOperation(gte));
   164         
   165         x1.setRealValue(0.0);
   166         assertEquals(1.0, Circuit.evaluateRealOperation(gte));
   167         
   168     }
   169     
   170     private final class GTEOperation extends Operation {
   171 
   172         private Input input2;
   173 
   174         private Input input1;
   175         
   176         public GTEOperation(Input in1, Input in2) {
   177             super();
   178             input1 = in1;
   179             input2 = in2;
   180         }
   181         
   182         public boolean performBooleanOperation() {
   183             return input1.getRealValue() >= input2.getRealValue();
   184         }
   185 
   186         public double performRealOperation() {
   187             return (input1.getRealValue() >= input2.getRealValue()) ? 1.0 : 0.0;
   188         }
   189         
   190     }
   191 }