ch.awae.utils.logic

Class LogicCluster

java.lang.Object

ch.awae.utils.logic.LogicCluster

public final class LogicCluster
extends java.lang.Object

A LogicCluster allows the simultaneous evaluation and handling of up to 32 Logic instances. When a cluster is evaluated all its Logic elements are evaluated and the cluster evaluation returns a 32-bit integer representing the result of all the elements. A '1' bit represents a Logic instance that evaluated to true, a '0' bit represents one that evaluated to false. The returned bit pattern can then be easily processed using a switch table. The first element controls the 1s place, the second element the 2s place and so on. In general the n-nth element controls the 2^n place.

Since:

awaeUtils 0.0.6

Author:

Andreas Wälchli

Constructor Summary

Constructors

Constructor and Description
LogicCluster(Logic... elements) Creates a new cluster instance from a list of Logic elements.

Method Summary

Modifier and Type	Method and Description
int	evaluate() Evaluates the cluster.
Logic	pattern(int code) provides a Logic instance testing for a specific evaluation pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogicCluster

public LogicCluster(Logic... elements)

Creates a new cluster instance from a list of Logic elements.

Parameters:

elements - the elements to build a cluster from. may not be null

Throws:

java.lang.NullPointerException - the elements parameter is null

java.lang.IllegalArgumentException - the elements array is empty or contains more than 32 elements

Method Detail

evaluate

public int evaluate()

Evaluates the cluster.

Returns:

a 32-bit integer representation of the evaluation results for all elements. Bits representing non-existing logics instances (i.e. the bits above the last element) always evaluate to a constant 0.

pattern

public Logic pattern(int code)

provides a Logic instance testing for a specific evaluation pattern. Whenever the cluster evaluates to that given pattern the Logic instance evaluates to true.

Parameters:

code - the 32-bit pattern that must be present for the logic instance to evaluate to true

Returns:

a logic instance

Since:

awaeUtils 0.0.7