Logic (ch.awae.awaeUtils 0.0.6 API)

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface Logic
```
Base interface for composeable boolean logic operating on a Model.
This interface can be implemented by any type capable of evaluating the current Model state to a boolean value. This interface also implements composition functions.

Author:

Andreas Wälchli

Field Summary

Fields
Modifier and Type Field and Description

static Logic FALSE
a logic instance that always evaluates to false

static Logic TRUE
a logic instance that always evaluates to true

Fields
Modifier and Type	Field and Description
`static Logic`	`FALSE` a logic instance that always evaluates to `false`
`static Logic`	`TRUE` a logic instance that always evaluates to `true`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Logic`	`all(Logic... logics)` Creates a logic instance that evaluates to `true` iff all base instance evaluate to `true`.
`default Logic`	`and(Logic other)` Combines this logic instance with another one in an `AND` operation.
`static Logic`	`and(Logic logic0, Logic... logics)` Creates a `Logic` instance that combines all given logic instances with an `AND` operation.
`static Logic`	`any(Logic... logics)` Creates a logic instance that evaluates to `true` if any base instance evaluates to `true`.
`static LogicCluster`	`cluster(Logic... elements)` prepares a function evaluating all given elements and returns a summary representing all states as a number.
`static Logic`	`count(int target, Logic... logics)` Creates a logic instance that counts how many base instances evaluate to `true`.
`default Logic`	`edge()`
`static Logic`	`edge(Logic logic)`
`boolean`	`evaluate()` Evaluates the logic object to a boolean value.
`static Logic`	`none(Logic... logics)` Creates a logic instance that evaluates to `true` iff all base instances evaluate to `false`.
`default Logic`	`not()` Returns an instance with inverted logic.
`static Logic`	`not(Logic logic)` Creates a logic instance with inverted logic.
`default Logic`	`or(Logic other)` Combines this logic instance with another one in an `OR` operation.
`static Logic`	`or(Logic logic0, Logic... logics)` Creates a `Logic` instance that combines all given logic instances with an `OR` operation.

- Field Detail
  - TRUE
```
static final Logic TRUE
```
    a logic instance that always evaluates to true
  - FALSE
```
static final Logic FALSE
```
    a logic instance that always evaluates to false
- Method Detail
  - cluster
```
static LogicCluster cluster(Logic... elements)
```
    prepares a function evaluating all given elements and returns a summary representing all states as a number. Enables quick evaluation of a large group of Logic instances and processing the result with a single switch instead of a lot of if clauses. Every instance evaluating to true is indicated as a 1. The first parameter lies in the unit column, the second in the two's column etc. null parameters will always yield 0 digits. This allows for hex-alignment.
    
    Parameters:
    
    elements - the Logic instances to evaluate. Limited to 32.
    
    Returns:
    
    a function evaluating
  - evaluate
```
boolean evaluate()
```
    Evaluates the logic object to a boolean value. Usually checks if the current Model state satisfies a defined condition.
    
    Returns:
    
    a boolean evaluation of the logic expression
  - not
```
default Logic not()
```
    Returns an instance with inverted logic. This inverted logic instance evaluates this instance and inverts the result.
    
    Returns:
    
    an instance with inverted logic
  - and
```
default Logic and(Logic other)
```
    Combines this logic instance with another one in an AND operation.
    The resulting logic instance evaluates to true iff both this and the other instance evaluate to true. If either instance evaluates to false, the result will be false.
    
    Parameters:
    
    other - the logic instance to combine with this one
    
    Returns:
    
    a logic instance evaluating to the AND composition of both this and the other logic instance
    
    Throws:
    
    java.lang.NullPointerException - if the other parameter is null
  - or
```
default Logic or(Logic other)
```
    Combines this logic instance with another one in an OR operation.
    The resulting logic instance evaluates to true if either this or the other instance evaluates to true (or both).
    
    Parameters:
    
    other - the logic instance to combine with this one
    
    Returns:
    
    a logic instance evaluating to the OR composition of both this and the other logic instance
    
    Throws:
    
    java.lang.NullPointerException - if the other parameter is null
  - edge
```
default Logic edge()
```
  - or
```
static Logic or(Logic logic0,
                Logic... logics)
```
    Creates a Logic instance that combines all given logic instances with an OR operation.
    If any logic instance evaluates to true the combined logic evaluates to true. The instance evaluates to false iff all base logic instances also evaluate to false.
    
    Parameters:
    
    logic0 - the first logic instance
    
    logics - the remaining logic instances
    
    Returns:
    
    a combined logic instance
    
    Throws:
    
    java.lang.NullPointerException - if any parameter is null, or the logics array contains null values.
    
    java.lang.IllegalArgumentException - if the logics array is empty
  - and
```
static Logic and(Logic logic0,
                 Logic... logics)
```
    Creates a Logic instance that combines all given logic instances with an AND operation.
    The instance evaluates to true iff all base logic instances also evaluate to true. If any logic instance evaluates to false the combined logic evaluates to false.
    
    Parameters:
    
    logic0 - the first logic instance
    
    logics - the remaining logic instances
    
    Returns:
    
    a combined logic instance
    
    Throws:
    
    java.lang.NullPointerException - if any parameter is null, or the logics array contains null values.
    
    java.lang.IllegalArgumentException - if the logics array is empty
  - count
```
static Logic count(int target,
                   Logic... logics)
```
    Creates a logic instance that counts how many base instances evaluate to true. The instance evaluates to true iff the number of base instances that evaluate to true matches the given target parameter.
    
    Parameters:
    
    target - the exact number of logic instances that must evaluate to true for this instance to evaluate to true.
    
    logics - the base logic instances
    
    Returns:
    
    the combined logic instances
    
    Throws:
    
    java.lang.NullPointerException - if the logics array is null or any of its elements is null
    
    java.lang.IllegalArgumentException - if the logics array is empty
    
    java.lang.IllegalArgumentException - if the target value is negative or larger than the number of elements in the logics array. Both of these conditions would result in the instance evaluating to false and are therefore prohibited.
  - none
```
static Logic none(Logic... logics)
```
    Creates a logic instance that evaluates to true iff all base instances evaluate to false.
    
    Parameters:
    
    logics - the base logics
    
    Returns:
    
    a combined logic instance
    
    Throws:
    
    java.lang.NullPointerException - if the logics array is null or any of its elements are null
    
    java.lang.IllegalArgumentException - if the logics array is empty
  - all
```
static Logic all(Logic... logics)
```
    Creates a logic instance that evaluates to true iff all base instance evaluate to true. This is essentially identical to an AND operation over all base logics.
    
    Parameters:
    
    logics - the base logics
    
    Returns:
    
    a combined logic instance
    
    Throws:
    
    java.lang.NullPointerException - if the logics array is null or any of its elements are null
    
    java.lang.IllegalArgumentException - if the logics array is empty
  - any
```
static Logic any(Logic... logics)
```
    Creates a logic instance that evaluates to true if any base instance evaluates to true. This is essentially identical to an OR operation over all base logics.
    
    Parameters:
    
    logics - the base logics
    
    Returns:
    
    a combined logic instance
    
    Throws:
    
    java.lang.NullPointerException - if the logics array is null or any of its elements are null
    
    java.lang.IllegalArgumentException - if the logics array is empty
  - not
```
static Logic not(Logic logic)
```
    Creates a logic instance with inverted logic. This inverted instance evaluates to true if the base instance evaluates to false (and vice versa).
    
    Returns:
    
    an instance with inverted logic
    
    Throws:
    
    java.lang.NullPointerException - if the logic parameter is null
  - edge
```
static Logic edge(Logic logic)
```

Interface Logic

Field Summary

Method Summary

Field Detail

TRUE

FALSE

Method Detail

cluster

evaluate

not

and

or

edge

or

and

count

none

all

any

not

edge