Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debouncing boolean #12

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions src/lib/DebouncedBoolean.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package lib;

import java.util.LinkedList;

public class DebouncedBoolean implements DebouncedBooleanInterface {
private LinkedList<Boolean> queue;
private final int windowSize;
private int count;

/**
* Creates and initializes the queue.
* @param size Sets the size of values being looked at
* @param initial Initializes the queue to a boolean type.
*/
public DebouncedBoolean(int size, boolean initial) {
if (size <= 0) {
throw new IllegalArgumentException(size + " is not a valid window size");
}
if (initial) {
count = size;
} else {
count = -size;
}
windowSize = size;
queue = new LinkedList<Boolean>();

}

/*
* @see lib.DebouncedBooleanInterface#add(boolean)
*/
@Override
public void add(boolean value) {
if (queue.size() == windowSize) {
queue.removeFirst();
queue.addLast(value);
} else {
queue.addLast(value);
}
if (value) {
count++;
} else {
count--;
}
}

/*
* @see lib.DebouncedBooleanInterface#get()
*/
@Override
public boolean get() {
return count >= 0;
}
}
20 changes: 20 additions & 0 deletions src/lib/DebouncedBooleanInterface.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package lib;

/**
* A Debounced Boolean is used to keep track of a windowed size amount of booleans being added the
* window.
*/
public interface DebouncedBooleanInterface {
/**
* Adds the new boolean to the average and removes the least recent boolean if there would be more
* than the windowSize value.
*
* @param value Boolean being passed into the queue.
*/
void add(boolean value);

/**
* @return Boolean that determines if the queue is true or false.
*/
boolean get();
}
2 changes: 1 addition & 1 deletion src/lib/MovingAverage.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public void update(double val) {
queue.addLast(val);
}

/*
/*
* @see lib.MovingAverageInterface#getAverage()
*/
@Override
Expand Down
74 changes: 74 additions & 0 deletions test/com/nutrons/nu17/BooleanTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
package com.nutrons.nu17;

import static org.junit.Assert.*;
import com.nutrons.nu17.*;

import org.junit.Test;

import lib.DebouncedBoolean;
import lib.DebouncedBooleanInterface;

public class BooleanTest {
@Test
public void allFalse() {
DebouncedBooleanInterface x = new DebouncedBoolean(3, true);
x.add(false);
assertEquals(true, x.get());
x.add(false);
assertEquals(true, x.get());
x.add(false);
assertEquals(true, x.get());
x.add(false);
assertEquals(false, x.get());
}

@Test
public void allTrue() {
DebouncedBooleanInterface x = new DebouncedBoolean(3, false);
x.add(true);
assertEquals(false, x.get());
x.add(true);
assertEquals(false, x.get());
x.add(true);
assertEquals(true, x.get());
x.add(true);
assertEquals(true, x.get());
}

@Test
public void changingValues() {
DebouncedBooleanInterface x = new DebouncedBoolean(3, true);
x.add(false);
assertEquals(true, x.get());
x.add(false);
assertEquals(true, x.get());
x.add(false);
assertEquals(true, x.get());
x.add(false);
assertEquals(false, x.get());
x.add(false);
assertEquals(false, x.get());
x.add(false);
assertEquals(false, x.get());
x.add(false);
assertEquals(false, x.get());
x.add(true);
assertEquals(false, x.get());
x.add(true);
assertEquals(false, x.get());
x.add(true);
assertEquals(false, x.get());
x.add(true);
assertEquals(true, x.get());
}

@Test(expected = IllegalArgumentException.class)
public void negativeExceptionTest() {
DebouncedBooleanInterface x = new DebouncedBoolean(-1, true);
}

@Test(expected = IllegalArgumentException.class)
public void zeroExceptionTest() {
DebouncedBooleanInterface x = new DebouncedBoolean(0, true);
}
}