Domains (JModelGen 0.3.3 API)

java.lang.Object
- jmodelgen.util.Domains

```
public class Domains
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Domains.Adaptor<S,T>
Provides a simple mechanism for adapting one domain for another return type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Domains.Adaptor<S,T>` Provides a simple mechanism for adapting one domain for another return type.

Field Summary

Fields
Modifier and Type Field and Description

static Domain EMPTY
A simple constant representing the empty domain.

Fields
Modifier and Type	Field and Description
`static Domain`	`EMPTY` A simple constant representing the empty domain.

Constructor Summary

Constructors
Constructor and Description

Domains()

Constructors
Constructor and Description
`Domains()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Domain<List<T>>`	`append(Domain<List<T>> domain, T item)` Map every element in a given domain of lists to a corresponding domain of lists where each element has a given item appended onto the end.
`static <T> void`	`apply(Domain<T> domain, long n, java.util.function.Consumer<T> consumer)` Apply a given lambda consumer to exactly `n` elements of a domain chosen uniformly at random according to Knuth's algorithm S.
`static <T> void`	`apply(Domain<T> domain, java.util.function.Predicate<T> condition, java.util.function.Consumer<T> consumer)` Apply a given lambda consumer to all elements matching a given condition of a domain.
`static Domain<Boolean>`	`Bool()` A simple domain for boolean values.
`static <T> Domain<T>`	`Constrained(Domain<T> domain, java.util.function.Predicate<T> constraint)` A domain constructed from all values in a given domain meeting a given constraint.
`static <T> Domain<T>`	`Finite(T... items)` A domain constructed from a finite set of values.
`static Domain<Integer>`	`Int(int lower, int upper)` A domain for integers based on a range which includes all values between a given lower bound and a given upper bound (inclusive).
`static <T> Domain<List<T>>`	`List(int min, int max, Domain<T> generator)` Return a domain which generates lists whose length is between a given minimum and maximum value.
`static void`	`main(String[] args)`
`static <T> Domain<T>`	`ParallelConstrained(Domain<T> domain, java.util.function.Predicate<T> constraint)` An experimental domain constructed from all values in a given domain meeting a given constraint.
`static <T> Domain<T[]>`	`Product(Domain<? extends T>[] fields, T... dummy)` A domain construct from the cartesian product of a given set of fields.
`static <T> Domain<T>`	`Sample(Domain<T> domain, int n)` Constraint a domain which contains exactly `n` elements of a domain chosen uniformly at random according to Knuth's algorithm S.
`static <T> Domain<T>`	`Union(Domain<? extends T>... subdomains)` A domain constructed from the union of one or more other domain.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final Domain EMPTY
```
    A simple constant representing the empty domain.
- Constructor Detail
  - Domains
```
public Domains()
```
- Method Detail
  - apply
```
public static <T> void apply(Domain<T> domain,
                             long n,
                             java.util.function.Consumer<T> consumer)
```
    Apply a given lambda consumer to exactly n elements of a domain chosen uniformly at random according to Knuth's algorithm S.
    
    Parameters:
    
    domain -
    
    n -
    
    consumer -
  - Sample
```
public static <T> Domain<T> Sample(Domain<T> domain,
                                   int n)
```
    Constraint a domain which contains exactly n elements of a domain chosen uniformly at random according to Knuth's algorithm S.
    
    Parameters:
    
    domain -
    
    n -
    
    consumer -
  - apply
```
public static <T> void apply(Domain<T> domain,
                             java.util.function.Predicate<T> condition,
                             java.util.function.Consumer<T> consumer)
```
    Apply a given lambda consumer to all elements matching a given condition of a domain.
    
    Parameters:
    
    domain -
    
    n -
    
    consumer -
  - Bool
```
public static Domain<Boolean> Bool()
```
    A simple domain for boolean values.
  - Int
```
public static Domain<Integer> Int(int lower,
                                  int upper)
```
    A domain for integers based on a range which includes all values between a given lower bound and a given upper bound (inclusive).
    
    Parameters:
    
    lower - The lower bound of integers to generate
    
    upper - The upper bound of integers to generate
  - List
```
public static <T> Domain<List<T>> List(int min,
                                       int max,
                                       Domain<T> generator)
```
    Return a domain which generates lists whose length is between a given minimum and maximum value.
  - append
```
public static <T> Domain<List<T>> append(Domain<List<T>> domain,
                                         T item)
```
    Map every element in a given domain of lists to a corresponding domain of lists where each element has a given item appended onto the end. For example, when appending 1 to the domain of integer lists gives the following mappings.
```
  [] => [1]
  [0] => [0,1]
  [0,1] => [0,1,1]
 
```
    Parameters:
    
    domain -
    
    item -
    
    Returns:
  - Union
```
public static <T> Domain<T> Union(Domain<? extends T>... subdomains)
```
    A domain constructed from the union of one or more other domain. The size of this domain is thus sum of the size of all included domains.
    
    Type Parameters:
    
    T -
  - Product
```
public static <T> Domain<T[]> Product(Domain<? extends T>[] fields,
                                      T... dummy)
```
    A domain construct from the cartesian product of a given set of fields. The size of the domain is the product of all fields.
    
    Parameters:
    
    fields - The subdomains for each field of the product.
    
    dummy - This can be left empty (it is used to aid creating generated areas).
    
    Returns:
  - Finite
```
public static <T> Domain<T> Finite(T... items)
```
    A domain constructed from a finite set of values. The size of the domain is thus exactly the number of elements in the set.
    
    Type Parameters:
    
    T -
  - Constrained
```
public static <T> Domain<T> Constrained(Domain<T> domain,
                                        java.util.function.Predicate<T> constraint)
```
    A domain constructed from all values in a given domain meeting a given constraint. This necessarily involves enumerating all elements of the original domain in order to determine how many match predicate. Having done that, only a single array of indices is retained which ensures constant time lookups for all matching elements.
    
    Parameters:
    
    domain -
    
    constraint -
    
    Returns:
  - ParallelConstrained
```
public static <T> Domain<T> ParallelConstrained(Domain<T> domain,
                                                java.util.function.Predicate<T> constraint)
```
    An experimental domain constructed from all values in a given domain meeting a given constraint. This necessarily involves enumerating all elements of the original domain in order to determine how many match predicate. Having done that, only a single array of indices is retained which ensures constant time lookups for all matching elements. The key distinction of this domain is that it is constructed using parallel streams.
    
    Parameters:
    
    domain -
    
    constraint -
    
    Returns:
  - main
```
public static void main(String[] args)
```

Class Domains

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Constructor Detail

Domains

Method Detail

apply

Sample

apply

Bool

Int

List

append

Union

Product

Finite

Constrained

ParallelConstrained

main