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
jtulach@52
     1
/*
jtulach@52
     2
 * The contents of this file are subject to the terms of the Common Development
jtulach@52
     3
 * and Distribution License (the License). You may not use this file except in
jtulach@52
     4
 * compliance with the License.
jtulach@52
     5
 *
jtulach@52
     6
 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
jtulach@52
     7
 * or http://www.netbeans.org/cddl.txt.
jtulach@52
     8
 *
jtulach@52
     9
 * When distributing Covered Code, include this CDDL Header Notice in each file
jtulach@52
    10
 * and include the License file at http://www.netbeans.org/cddl.txt.
jtulach@52
    11
 * If applicable, add the following below the CDDL Header, with the fields
jtulach@52
    12
 * enclosed by brackets [] replaced by your own identifying information:
jtulach@52
    13
 * "Portions Copyrighted [year] [name of copyright owner]"
jtulach@52
    14
 *
jtulach@52
    15
 * The Original Software is NetBeans. The Initial Developer of the Original
jtulach@52
    16
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
jtulach@52
    17
 * Microsystems, Inc. All Rights Reserved.
jtulach@52
    18
 */
jtulach@52
    19
jtulach@52
    20
package org.netbeans.apifest.boolcircuit;
jtulach@52
    21
jtulach@52
    22
import java.security.CodeSource;
jtulach@52
    23
import java.security.Permission;
jtulach@52
    24
import java.security.PermissionCollection;
jtulach@52
    25
import java.security.Policy;
jtulach@52
    26
import java.util.Collection;
jtulach@52
    27
import java.util.Collections;
jtulach@52
    28
import java.util.Enumeration;
jtulach@52
    29
import junit.framework.TestCase;
jtulach@52
    30
import junit.framework.*;
jtulach@52
    31
jtulach@52
    32
/** This file contains the APIFest quest for day 2. Simply, turn the 
jtulach@52
    33
 * boolean circuit into circuit that can compute with double values from 0 to 1.
jtulach@52
    34
 * <p>
jtulach@52
    35
 * This means that where ever a boolean was used to represent input or 
jtulach@52
    36
 * output values, one can now use any double number from >= 0 and <= 1.
jtulach@52
    37
 * Still, to support backward compatibility, the operations with booleans
jtulach@52
    38
 * has to be kept available and have to work. In fact False shall be 
jtulach@52
    39
 * treated as 0 and True as 1.
jtulach@52
    40
 * <p>
jtulach@52
    41
 * The basic elements has to be modified to work on doubles in the following
jtulach@52
    42
 * way:
jtulach@52
    43
 * <ul>
jtulach@52
    44
 *   <li>negation - neg(x) = 1 - x, this is correct extension as neg(false)=neg(0)=1-0=1=true
jtulach@52
    45
 *   <li>and - and(x,y) = x * y, again this is fine as and(true,true)=1*1=true and also
jtulach@52
    46
 *             and(false,true)=0*1=0=false
jtulach@52
    47
 *   <li>or - or(x,y) = 1 - (1 - x) * (1 - y) and this is also ok as
jtulach@52
    48
 *             or(false,false) = 1 - (1 - 0) * (1 - 0) = 1 - 1 = 0 = false
jtulach@52
    49
 *             or(true,false) = 1 - (1 - 1) * (1 - 0) = 1 - 0 * 1 = 1 = true
jtulach@52
    50
 * </ul>
jtulach@52
    51
 * <p>
jtulach@52
    52
 * However as the circuits with doubles are more rich than plain boolean circuits,
jtulach@52
    53
 * there is additional requirement to allow any user of your API to write its 
jtulach@52
    54
 * own "element" type. This is all going to be exercise in the tests bellow
jtulach@52
    55
 * which you are supposed to implement.
jtulach@52
    56
 */
jtulach@52
    57
public class RealTest extends TestCase {
jtulach@52
    58
    static {
jtulach@52
    59
        // your code shall run without any permissions
jtulach@52
    60
    }
jtulach@52
    61
    
jtulach@52
    62
    public RealTest(String testName) {
jtulach@52
    63
        super(testName);
jtulach@52
    64
    }
jtulach@52
    65
jtulach@52
    66
    protected void setUp() throws Exception {
jtulach@52
    67
    }
jtulach@52
    68
jtulach@52
    69
    protected void tearDown() throws Exception {
jtulach@52
    70
    }
jtulach@52
    71
    
jtulach@52
    72
    
jtulach@52
    73
    /** First of all create a circuit which will evaluate
jtulach@52
    74
     * expression (X1 and X2) or not(x1). Hold the circuit
jtulach@52
    75
     * in some variable.
jtulach@52
    76
     *
jtulach@52
    77
     * Feed this circuit with x1=true, x2=false, assert result is false
jtulach@52
    78
     *
jtulach@52
    79
     * Feed the same circuit with x1=false, x2=true, assert result is true
jtulach@52
    80
     *
jtulach@52
    81
     * Feed the same circuit with x1=0.0, x2=1.0, assert result is 1.0
jtulach@52
    82
     *
jtulach@52
    83
     * Feed the same circuit with x1=0.5, x2=0.5, assert result is 0.625
jtulach@52
    84
     *
jtulach@52
    85
     * Feed the same circuit with x1=0.0, x2=2.0, make sure it throws an exception
jtulach@52
    86
     */
jtulach@52
    87
    public void testX1andX2orNotX1() {
jtulach@52
    88
        VariableInput x1 = Factory.createVariableInput();
jtulach@52
    89
        VariableInput x2 = Factory.createVariableInput();
jtulach@52
    90
        Operation and = Factory.createAndOperation(x1, x2);
jtulach@52
    91
        Operation not = Factory.createNotOperation(x1);
jtulach@52
    92
        Operation or = Factory.createOrOperation(Factory.createOperationBasedInput(and), Factory.createOperationBasedInput(not));
jtulach@52
    93
        
jtulach@52
    94
        x1.setBooleanValue(false);
jtulach@52
    95
        x2.setBooleanValue(true);
jtulach@52
    96
        assertTrue(Circuit.evaluateBooleanOperation(or));
jtulach@52
    97
        
jtulach@52
    98
        x1.setRealValue(0.0);
jtulach@52
    99
        x2.setRealValue(1.0);
jtulach@52
   100
        assertEquals(1.0, Circuit.evaluateRealOperation(or));
jtulach@52
   101
        
jtulach@52
   102
        x1.setRealValue(0.5);
jtulach@52
   103
        x2.setRealValue(0.5);
jtulach@52
   104
        assertEquals(0.625, Circuit.evaluateRealOperation(or));
jtulach@52
   105
        
jtulach@52
   106
        try {
jtulach@52
   107
            x1.setRealValue(0.0);
jtulach@52
   108
            x2.setRealValue(2.0);
jtulach@52
   109
            Circuit.evaluateRealOperation(or);
jtulach@52
   110
            fail();
jtulach@52
   111
        } catch (IllegalArgumentException exc) {
jtulach@52
   112
            //good..
jtulach@52
   113
        }
jtulach@52
   114
jtulach@52
   115
    }
jtulach@52
   116
    
jtulach@52
   117
    /** Ensure that one variable cannot be filled with two different values.
jtulach@52
   118
     * Create a circuit for x1 and x1. Make sure that for any usage of your
jtulach@52
   119
     * API that would not lead to x1 * x1 result, an exception is thrown.
jtulach@52
   120
     * For example if there was a way to feed the circuit with two different 
jtulach@52
   121
     * values 0.3 and 0.5 an exception is thrown indicating that this is 
jtulach@52
   122
     * improper use of the circuit.
jtulach@52
   123
     */
jtulach@52
   124
    public void testImproperUseOfTheCircuit() {
jtulach@52
   125
jtulach@52
   126
        // this is enforced by the setter on the VariableInput.. how to test??
jtulach@52
   127
        
jtulach@52
   128
        
jtulach@52
   129
        
jtulach@52
   130
//        fail("task2");
jtulach@52
   131
        // PS: This request is based on observation that some API from day1
jtulach@52
   132
        // solved the multiple usage of one variable, by repeating its 
jtulach@52
   133
        // value multiple times. This tasks says that if this is case of
jtulach@52
   134
        // your API you must make sure, when that usage of different values
jtulach@52
   135
        // for one variable is prohibited. If there is no way in your API to
jtulach@52
   136
        // express this task, just say so, and you do not need to write a test.
jtulach@52
   137
        // However if anyone else finds a way to simulate such situation in your
jtulach@52
   138
        // API later, it will get points for breaking your API.
jtulach@52
   139
    }
jtulach@52
   140
    
jtulach@52
   141
    /** Write your own element type called "gte" that will have two inputs and one output.
jtulach@52
   142
     * The output value will be 1 if x1 >= x2 and 0 otherwise. 
jtulach@52
   143
     * 
jtulach@52
   144
     * Create 
jtulach@52
   145
     * circuit for following expression: (x1 and not(x1)) gte x1
jtulach@52
   146
     *
jtulach@52
   147
     * Feed the circuit with 0.5 and verify the result is 0
jtulach@52
   148
     *
jtulach@52
   149
     * Feed the same circuit with 1 and verify the result is 0
jtulach@52
   150
     *
jtulach@52
   151
     * Feed the same circuit with 0 and verify the result is 1
jtulach@52
   152
     */
jtulach@52
   153
    public void testGreaterThanEqualElement() {
jtulach@52
   154
        VariableInput x1 = Factory.createVariableInput();
jtulach@52
   155
        Operation not = Factory.createNotOperation(x1);
jtulach@52
   156
        Operation and = Factory.createAndOperation(x1, Factory.createOperationBasedInput(not));
jtulach@52
   157
        Operation gte = new GTEOperation(Factory.createOperationBasedInput(and), x1);
jtulach@52
   158
        
jtulach@52
   159
        x1.setRealValue(0.5);
jtulach@52
   160
        assertEquals(0.0, Circuit.evaluateRealOperation(gte));
jtulach@52
   161
        
jtulach@52
   162
        x1.setRealValue(1.0);
jtulach@52
   163
        assertEquals(0.0, Circuit.evaluateRealOperation(gte));
jtulach@52
   164
        
jtulach@52
   165
        x1.setRealValue(0.0);
jtulach@52
   166
        assertEquals(1.0, Circuit.evaluateRealOperation(gte));
jtulach@52
   167
        
jtulach@52
   168
    }
jtulach@52
   169
    
jtulach@52
   170
    private final class GTEOperation extends Operation {
jtulach@52
   171
jtulach@52
   172
        private Input input2;
jtulach@52
   173
jtulach@52
   174
        private Input input1;
jtulach@52
   175
        
jtulach@52
   176
        public GTEOperation(Input in1, Input in2) {
jtulach@52
   177
            super();
jtulach@52
   178
            input1 = in1;
jtulach@52
   179
            input2 = in2;
jtulach@52
   180
        }
jtulach@52
   181
        
jtulach@52
   182
        public boolean performBooleanOperation() {
jtulach@52
   183
            return input1.getRealValue() >= input2.getRealValue();
jtulach@52
   184
        }
jtulach@52
   185
jtulach@52
   186
        public double performRealOperation() {
jtulach@52
   187
            return (input1.getRealValue() >= input2.getRealValue()) ? 1.0 : 0.0;
jtulach@52
   188
        }
jtulach@52
   189
        
jtulach@52
   190
    }
jtulach@52
   191
}