Zebra4j

https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/
Admin
Zebra4j is a Java library for generating and solving Zebra puzzles, a type of logic grid puzzle that...
Tokens:46,548
Snippets:702
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### get()

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Returns a puzzle, implementing the Supplier interface.

```APIDOC
## get()

### Description
Returns a puzzle, fulfilling the `Supplier` interface contract.

### Returns
A generated puzzle.
```

--------------------------------

### Initialize PuzzleBuilder

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleBuilder.html

Constructs a new PuzzleBuilder instance. Use this to start building a new puzzle.

```java
publicPuzzleBuilder()
```

--------------------------------

### get() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionGenerator.html

Provides a PuzzleSolution, fulfilling the Supplier interface contract. This method is functionally identical to the generate() method.

```java
public
PuzzleSolution
get()
```

--------------------------------

### get() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/LazyInstance.html

Retrieves the lazily initialized instance. If the instance has not been created yet, it will be created using the provided Supplier. This method is thread-safe.

```APIDOC
## get() Method

### Description
Retrieves the lazily initialized instance. If the instance has not been created yet, it will be created using the provided Supplier. This method is thread-safe.

### Signature
```java
public T get()
```

### Returns
* **T** - The lazily initialized instance.
```

--------------------------------

### PuzzleSolutionBuilder Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Initializes a new instance of the PuzzleSolutionBuilder class. This is the starting point for building a PuzzleSolution.

```java
public
PuzzleSolutionBuilder()
```

--------------------------------

### get() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Returns a generated puzzle, implementing the Supplier interface. This method is part of the AbstractPuzzleGenerator.

```java
public P get()
```

--------------------------------

### Get Attribute Sets

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolution.html

Retrieves all attribute sets referenced in the solution, grouped by their AttributeType.

```java
public java.util.Map<AttributeType,java.util.Set<Attribute>> getAttributeSets()
```

--------------------------------

### getAttributeSets

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolution.html

Get the sets of attributes referenced in the solution, grouped by type.

```APIDOC
## getAttributeSets

### Description
The sets of attributes referenced in the solution, grouped by type.

### Method
public

### Endpoint
N/A (Java Method)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **Map<AttributeType, Set<Attribute>>** - The sets of attributes referenced in the solution, grouped by type.

#### Response Example
N/A
```

--------------------------------

### Get People

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolution.html

Retrieves the set of SolutionPerson objects, each with all their specified attributes.

```java
public java.util.Set<SolutionPerson> getPeople()
```

--------------------------------

### generate() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionGenerator.html

Generates a new puzzle solution. This method is equivalent to the get() method inherited from the Supplier interface.

```java
public
PuzzleSolution
generate()
```

--------------------------------

### BasicAttributeType Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicAttributeType.html

Creates a new basic attribute type with a set of labels, a question pattern, and a type name. Labels should start with a verb and describe attributes.

```java
publicBasicAttributeType(java.util.Set<java.lang.String>labels,
                          java.lang.StringquestionPattern,
                          java.lang.StringtypeName)
```

--------------------------------

### Clothes Enum Methods

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Clothes.html

Provides methods to interact with the Clothes enum, including getting descriptions and array representations.

```APIDOC
## Method Summary

Modifier and Type | Method and Description
---|---
`java.lang.String` | `description(java.util.Locale locale)` As in the sentence "Ivan is {description}"
`AttributeType` | `type()`
`static Clothes[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static Clothes` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
```

--------------------------------

### Get Choco Solver Settings

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolver.html

Retrieves the current settings for the underlying Choco SAT solver. These settings can be modified to tune the solver's behavior.

```java
public	org.chocosolver.solver.Settings	getChocoSettings()
```

--------------------------------

### Solve Puzzle and Get All Solutions as Stream

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Provides a stream of all valid solutions for the puzzle. This is an alternative to `solve()` for processing solutions iteratively.

```java
public java.util.stream.Stream<Attribute> solveToStream()
```

--------------------------------

### Solve Puzzle and Get All Solutions as Set

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Executes the solver to find all valid solutions for the puzzle. Returns an empty set if no solutions exist or if the puzzle rules are contradictory.

```java
public java.util.Set<Attribute> solve()
```

--------------------------------

### getPosition

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AtHouse.html

Gets the number of the position of the house from left to right, starting at 1.

```APIDOC
## getPosition

### Description
Gets the number of the position of the house from left to right, starting at 1.

### Method
`public int getPosition()`

### Returns
* **int** - The position of the house.
```

--------------------------------

### Cli Main Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/cli/Cli.html

The entry point for the zebra4j command-line interface. It accepts an array of strings as arguments.

```java
public static	void	main(java.lang.String[]	args)
```

--------------------------------

### LazyInstance get Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/LazyInstance.html

Retrieves the lazily initialized instance. This method is thread-safe and ensures that the initialize method is called only once. It implements the get method from both Supplier and ConcurrentInitializer interfaces.

```java
public
T get()
```

--------------------------------

### QuestionPuzzleSolver constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/QuestionPuzzle.html

Initializes a new solver with default configuration for a given QuestionPuzzle.

```APIDOC
## QuestionPuzzleSolver constructor

### Description
Initializes a new solver with default configuration.

### Constructor Signature
`QuestionPuzzleSolver(QuestionPuzzle qPuzzle)`

### Parameters
* **qPuzzle** (QuestionPuzzle) - The puzzle to be solved.
```

--------------------------------

### getChocoSettings() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Optional: Retrieves the configuration settings for the underlying SAT solver (Choco).

```java
public org.chocosolver.solver.Settings getChocoSettings()
```

--------------------------------

### Get 'About' Attribute Type

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Retrieves the type of attribute that the question is about.

```java
public
AttributeTypegetAbout()
```

--------------------------------

### getChocoSettings()

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Retrieves the configuration settings for the underlying SAT solver.

```APIDOC
## getChocoSettings()

### Description
Optional: Retrieves the configuration settings for the underlying SAT solver (Choco).

### Returns
The Choco solver settings.
```

--------------------------------

### SolutionGenerator Constructors

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionGenerator.html

Provides information on how to instantiate the SolutionGenerator class with different configurations.

```APIDOC
## SolutionGenerator()

### Description
Creates a generator with default configuration and largest possible puzzle size.

### Constructor
```java
public SolutionGenerator()
```
```

```APIDOC
## SolutionGenerator(int numPeople)

### Description
Creates a generator with default configuration.

### Parameters
* **numPeople** (int) - The number of people in the generated puzzles.

### Constructor
```java
public SolutionGenerator(int numPeople)
```
```

```APIDOC
## SolutionGenerator(Set<AttributeType> attributeTypes, int numPeople, Randomness rnd)

### Description
Creates a generator with specified attribute types, number of people, and randomness configuration.

### Parameters
* **attributeTypes** (Set<AttributeType>) - The set of attribute types to consider for puzzle generation.
* **numPeople** (int) - The number of people in the generated puzzles.
* **rnd** (Randomness) - The randomness configuration for generation.

### Constructor
```java
public SolutionGenerator(java.util.Set<AttributeType> attributeTypes, int numPeople, Randomness rnd)
```
```

--------------------------------

### Initialize QuestionPuzzleSolver

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Constructs a new solver instance for a given QuestionPuzzle. This is the primary way to begin solving a puzzle.

```java
public QuestionPuzzleSolver(QuestionPuzzle qPuzzle)
```

--------------------------------

### Get Number of People

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicPuzzle.html

Returns the total number of people involved in the puzzle.

```java
public int numPeople()
```

--------------------------------

### SolutionPerson Constructor with Attribute List

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionPerson.html

Initializes a SolutionPerson with a list of attributes. Use when attributes are already collected in a List.

```java
publicSolutionPerson(java.util.List<Attribute>attributeList)
```

--------------------------------

### Get 'Towards' Attribute

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Retrieves the specific attribute of a person that the question is directed towards.

```java
public
AttributegetTowards()
```

--------------------------------

### QuestionPuzzleSolver Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Initializes a new QuestionPuzzleSolver with a given QuestionPuzzle.

```APIDOC
## QuestionPuzzleSolver(QuestionPuzzle qPuzzle)

### Description
Initialize a new solver with default configuration.

### Parameters
* **qPuzzle** (QuestionPuzzle) - Required - the puzzle to be solved
```

--------------------------------

### initialize() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/LazyInstance.html

Protected method that is called by the LazyInitializer framework to perform the actual instance creation. This method should be implemented by subclasses or provided via the Supplier in the constructor.

```APIDOC
## initialize() Method

### Description
Protected method that is called by the LazyInitializer framework to perform the actual instance creation. This method should be implemented by subclasses or provided via the Supplier in the constructor.

### Signature
```java
protected T initialize()
```

### Returns
* **T** - The created instance.
```

--------------------------------

### build()

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Builds and returns the completed PuzzleSolution.

```APIDOC
## build()

### Description
Builds and returns the completed PuzzleSolution.

### Method
`build`

### Returns
- PuzzleSolution - The completed solution.
```

--------------------------------

### Initialize ZebraModel with ChocoSolver Settings

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/ZebraModel.html

Initializes a new Zebra ChocoSolver model. The model uses DefaultSettings if null is provided for chocoSettings.

```java
publicZebraModel(org.chocosolver.solver.SettingschocoSettings)
```

--------------------------------

### Get Puzzle Facts

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicPuzzle.html

Retrieves the collection of facts that must be satisfied by any valid solution to the puzzle.

```java
public java.util.Collection<Fact> getFacts()
```

--------------------------------

### SolutionPerson Methods

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionPerson.html

Methods for interacting with SolutionPerson objects.

```APIDOC
## asList

### Description
Returns a copy of the attributes as a list.

### Returns
- List<Attribute> - a copy of the attributes as a list
```

```APIDOC
## attributeTypes

### Description
Returns an unmodifiable view of the types of the attributes.

### Returns
- Set<AttributeType> - a unmodifiable view of the types of the attributes
```

```APIDOC
## withAttribute

### Description
Returns a copy of this person with the given attribute added.

### Parameters
#### attribute
- **attribute** (Attribute) - Required

### Returns
- SolutionPerson - a copy of this person with the given attribute added
```

```APIDOC
## findAttribute

### Description
Finds one attribute of the person given type.

### Parameters
#### type
- **type** (AttributeType) - Required

### Returns
- Attribute - the attribute if it exists, null otherwise
```

```APIDOC
## hasAttribute

### Description
Checks if the person has the given attribute.

### Parameters
#### attr
- **attr** (Attribute) - Required

### Returns
- boolean - if the person has the given attribute
```

```APIDOC
## describe

### Description
Describe the person-in-solution in natural language.

### Parameters
#### locale
- **locale** (Locale) - the locale of the natural language

### Returns
- String[] - an array of attribute descriptions
```

```APIDOC
## toString

### Description
Returns a string representation of the SolutionPerson object.

### Overrides
- `toString` in class `java.lang.Object`
```

```APIDOC
## equals

### Description
Compares this SolutionPerson object to another object for equality.

### Overrides
- `equals` in class `java.lang.Object`
```

```APIDOC
## hashCode

### Description
Returns a hash code value for the SolutionPerson object.

### Overrides
- `hashCode` in class `java.lang.Object`
```

--------------------------------

### AtHouse Method: getPosition

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AtHouse.html

Returns the position of the house. The position is a number from left to right, starting at 1.

```java
public
int
getPosition()
```

--------------------------------

### Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Initializes a new instance of the AbstractPuzzleGenerator class.

```APIDOC
## AbstractPuzzleGenerator Constructor

### Description
Initializes a new instance of the AbstractPuzzleGenerator class with the specified randomness, puzzle solution, and fact types.

### Parameters
* **rnd** (Randomness) - Required - The source of randomness for puzzle generation.
* **solution** (PuzzleSolution) - Required - The base puzzle solution.
* **factTypes** (java.util.Set<Fact.Type>) - Required - The set of fact types to consider.
```

--------------------------------

### BasicPuzzle Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/Attribute.html

Initializes a BasicPuzzle with attribute sets and facts.

```APIDOC
## BasicPuzzle

### Description
Initializes a BasicPuzzle with attribute sets and facts.

### Method
`BasicPuzzle(java.util.Map<AttributeType,java.util.Set<Attribute>> attributeSets, java.util.Collection<Fact> facts)`

### Parameters
#### Path Parameters
- **attributeSets** (java.util.Map<AttributeType,java.util.Set<Attribute>>) - Required - A map of attribute types to sets of attributes.
- **facts** (java.util.Collection<Fact>) - Required - A collection of facts for the puzzle.
```

--------------------------------

### Criminal Enum Methods

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/Criminal.html

Provides information on how to retrieve Criminal enum constants by name or get all available constants.

```APIDOC
## Criminal Enum Operations

### Description
These methods allow for the retrieval of `Criminal` enum constants. You can obtain a specific constant by its name or get an array of all constants.

### Methods

#### `static Criminal valueOf(java.lang.String name)`
Returns the enum constant of this type with the specified name.

#### `static Criminal[] values()`
Returns an array containing the constants of this enum type, in the order they are declared.
```

--------------------------------

### Criminal Enum Methods

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Criminal.html

Provides methods to get all enum constants, a specific constant by name, its description, and its type.

```APIDOC
## Method Summary

All Methods | Static Methods | Instance Methods | Concrete Methods
---|---|---|---
Modifier and Type | Method and Description
---|---
`java.lang.String` | `description(java.util.Locale locale)` - As in the sentence "Ivan is {description}"
`AttributeType` | `type()`
`static Criminal[]` | `values()` - Returns an array containing the constants of this enum type, in the order they are declared.
`static Criminal` | `valueOf(java.lang.String name)` - Returns the enum constant of this type with the specified name.
```

--------------------------------

### SolutionPerson Constructor (varargs)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/Attribute.html

Defines a person from a variable number of attributes.

```APIDOC
## SolutionPerson

### Description
Defines a person from their attributes.

### Method
`SolutionPerson(Attribute... attributeList)`

### Parameters
#### Path Parameters
- **attributeList** (Attribute...) - Required - A variable number of attributes defining the person.
```

--------------------------------

### Get Attribute Sets

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicPuzzle.html

Retrieves the map of attribute types and their corresponding subsets of values used within this puzzle.

```java
public java.util.Map<AttributeType,java.util.Set<Attribute>> getAttributeSets()
```

--------------------------------

### describe

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolution.html

Describe the solution in natural language using a specified locale.

```APIDOC
## describe

### Description
Describe the solution in natural language.

### Method
public

### Endpoint
N/A (Java Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
- **String[][]** - an array of persons; each person described as an array of attribute descriptions

#### Response Example
N/A
```

--------------------------------

### appliesTo(BasicPuzzle)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/fact/Fact.html

Checks if the fact is relevant to the given puzzle, for example, if the fact is a relationship between attributes and the puzzle contains all of them.

```APIDOC
## appliesTo(BasicPuzzle)

### Description
Checks if the fact is relevant to the given puzzle, for example, if the fact is a relationship between attributes and the puzzle contains all of them.

### Method
`boolean appliesTo(BasicPuzzle puzzle)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```java
boolean isRelevant = fact.appliesTo(puzzle);
```

### Response
#### Success Response (boolean)
- `true` if the fact is relevant to the puzzle
- `false` otherwise

#### Response Example
```json
{
  "example": true
}
```
```

--------------------------------

### SolutionPerson Constructor with Attribute Array

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionPerson.html

Initializes a SolutionPerson with a variable number of attributes. Use when attributes are readily available as individual arguments.

```java
publicSolutionPerson(Attribute...attributeList)
```

--------------------------------

### Get Underlying ChocoSolver Model

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/ZebraModel.html

Retrieves the underlying ChocoSolver Model instance. This is necessary because Solution.Solution requires a Model object.

```java
publicorg.chocosolver.solver.ModelgetChocoModel()
```

--------------------------------

### setChocoSettings() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Optional: Sets the configuration settings for the underlying SAT solver (Choco).

```java
public void setChocoSettings(org.chocosolver.solver.Settings chocoSettings)
```

--------------------------------

### Get Variable for Unique Attribute

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/ZebraModel.html

Finds the variable associated with a given unique attribute. Returns null if no such variable was created.

```java
publicorg.chocosolver.solver.variables.IntVargetVariableFor(AttributeuniqueAttribute)
```

--------------------------------

### SolutionPerson Constructor (List)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/Attribute.html

Defines a person from a list of attributes.

```APIDOC
## SolutionPerson

### Description
Defines a person from their attributes.

### Method
`SolutionPerson(java.util.List<Attribute> attributeList)`

### Parameters
#### Path Parameters
- **attributeList** (java.util.List<Attribute>) - Required - A list of attributes defining the person.
```

--------------------------------

### PuzzleSolver Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolver.html

Initializes a new PuzzleSolver with a given BasicPuzzle.

```APIDOC
## PuzzleSolver Constructor

### Description
Initialize a new solver with default configuration.

### Parameters
#### Path Parameters
- **puzzle** (BasicPuzzle) - Required - the puzzle to be solved
```

--------------------------------

### Iterating over Criminal enum constants

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Criminal.html

Example of how to iterate over all constants of the Criminal enum using the values() method and print each one.

```java
for (Criminal c : Criminal.values())
    System.out.println(c);
```

--------------------------------

### generate() Parallel Stream Tip

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

A tip on how to generate multiple puzzles quickly using a parallel stream with the generate() method.

```java
Stream.generate.parallel
```

--------------------------------

### Get Attributes as List

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionPerson.html

Returns a mutable copy of the person's attributes as a List. Useful for iterating or modifying the attribute collection.

```java
publicjava.util.List<Attribute>asList()
```

--------------------------------

### Cli Class

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/cli/Cli.html

The Cli class provides the main entry point for the zebra4j command-line tool. It contains the main method to process command-line arguments.

```APIDOC
## Cli Class

### Description
The Cli class serves as the command-line interface for the zebra4j library. It contains the `main` method, which is the entry point for executing the tool from the command line.

### Methods

#### `main(String[] args)`

##### Description
This is the static main method that serves as the entry point for the command-line application. It accepts an array of strings as arguments, which are typically the command-line arguments passed to the program.

##### Signature
`public static void main(java.lang.String[] args)`

##### Parameters
- **args** (String[]) - Required - An array of strings representing the command-line arguments.
```

--------------------------------

### ZebraModel Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/ZebraModel.html

Initializes a new Zebra ChocoSolver model. If chocoSettings is null, DefaultSettings will be used.

```APIDOC
## ZebraModel Constructor

### Description
Initializes a new Zebra ChocoSolver model.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Signature
```java
public ZebraModel(org.chocosolver.solver.Settings chocoSettings)
```

### Parameters
- **chocoSettings** (org.chocosolver.solver.Settings) - Optional: the model uses `DefaultSettings` if null.
```

--------------------------------

### Get Attribute Types

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionPerson.html

Returns an unmodifiable view of the unique types of attributes associated with the person. Useful for checking available attribute categories.

```java
publicjava.util.Set<AttributeType>attributeTypes()
```

--------------------------------

### PuzzleSolutionBuilder Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Initializes a new instance of the PuzzleSolutionBuilder class.

```APIDOC
## PuzzleSolutionBuilder()

### Description
Initializes a new instance of the PuzzleSolutionBuilder class.

### Constructor
`PuzzleSolutionBuilder()`
```

--------------------------------

### setChocoSettings()

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AbstractPuzzleGenerator.html

Sets the configuration settings for the underlying SAT solver.

```APIDOC
## setChocoSettings(org.chocosolver.solver.Settings chocoSettings)

### Description
Optional: Sets the configuration settings for the underlying SAT solver (Choco).

### Parameters
* **chocoSettings** (org.chocosolver.solver.Settings) - Required - The Choco solver settings to apply.
```

--------------------------------

### CommutativeFact appliesTo Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/fact/CommutativeFact.html

Checks if the fact is relevant to the given puzzle, for example, if the fact is an attribute relationship and the puzzle contains all required attributes.

```java
public boolean appliesTo(BasicPuzzle puzzle)
```

--------------------------------

### Question Class Overview

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Provides details about the Question class, its fields, constructors, and methods.

```APIDOC
## Class: Question

A question about an attribute of a person. The question is towards the person, identified by the attribute in `getTowards()` and is about the attribute of type `getAbout()`.

### Field Summary
- `static Question NAME_OF_CRIMINAL`: Sample question: Who is the criminal?

### Constructor Summary
- `Question(Attribute towards, AttributeType about)`: Constructs a new Question.

### Method Summary
- `Optional<Attribute> answer(PuzzleSolution solution)`: Answers this question about the given solution, if applicable.
- `boolean appliesTo(BasicPuzzle puzzle)`: Checks if the question is relevant to the given puzzle.
- `boolean appliesTo(PuzzleSolution solution)`: Checks if the question is relevant to the given solution.
- `String describe(Locale locale)`: Converts the question to a natural language sentence.
- `boolean equals(Object o)`: Compares this Question object to another object for equality.
- `static Question generate(Map<AttributeType,Set<Attribute>> attributeSets, Randomness rnd)`: Generates a random question using the given sets of attributes.
- `static Question generate(PuzzleSolution solution)`: Generates a random question about the people in the given solution.
- `AttributeType getAbout()`: Gets the attribute type the question is about.
- `Attribute getTowards()`: Gets the attribute of the person the question is directed towards.
- `int hashCode()`: Returns the hash code for this Question object.
- `String toString()`: Returns a string representation of the Question object.
```

--------------------------------

### Attribute Interface Definition

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Attribute.html

Defines the structure for attributes, including methods to get a localized description and the attribute type. This interface is implemented by concrete attribute classes.

```java
public interface Attribute
```

--------------------------------

### SolutionPerson Constructors

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionPerson.html

Constructors for creating a SolutionPerson object.

```APIDOC
## SolutionPerson Constructor

### Description
Defines a person from their attributes.

### Parameters
#### attributeList
- **attributeList** (Attribute...) - Required - all attributes of the person
```

```APIDOC
## SolutionPerson Constructor

### Description
Defines a person from their attributes.

### Parameters
#### attributeList
- **attributeList** (List<Attribute>) - Required - all attributes of the person
```

--------------------------------

### To String Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicPuzzle.html

Returns a string representation of the BasicPuzzle instance.

```java
public java.lang.String toString()
```

--------------------------------

### BasicAttributeType questionSentencePart Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicAttributeType.html

Returns the pattern for questions about this attribute type. This pattern is used with String.format and has a single placeholder for the attribute.

```java
publicjava.lang.StringquestionSentencePart(java.util.Localelocale)
```

--------------------------------

### Create Unique Variable for Attribute

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/ZebraModel.html

Creates a variable for an attribute that can be held by only one person. The variable's value is the index of the person holding the attribute, starting from 0.

```java
publicorg.chocosolver.solver.variables.IntVarcreateUniqueVariable(Attributeattr,
                                                                    intnumPeople)
```

--------------------------------

### SolutionGenerator Constructor (Default)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionGenerator.html

Creates a SolutionGenerator with default configuration and the largest possible puzzle size. No specific imports are required for this constructor.

```java
public
SolutionGenerator()
```

--------------------------------

### ZebraModel Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/index-all.html

Initializes a new Zebra ChocoSolver model with the specified settings.

```APIDOC
## ZebraModel(Settings)

### Description
Initializes a new Zebra ChocoSolver model.

### Constructor
- **settings** (Settings) - The settings to configure the model.
```

--------------------------------

### Solve Puzzle and Get a Single Solution

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Retrieves a single solution to the puzzle. This method is particularly useful for puzzles guaranteed to have exactly one solution, such as those generated by `QuestionPuzzleGenerator`. Throws `NoSuchElementException` if no solutions are found.

```java
public Attribute solveSingle()
```

--------------------------------

### SolutionGenerator Constructor (with numPeople)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionGenerator.html

Creates a SolutionGenerator with default configuration, specifying the number of people for the generated puzzles. The numPeople parameter determines the scale of the puzzle.

```java
public
SolutionGenerator(int
numPeople)
```

--------------------------------

### SolutionGenerator Constructor with Randomness

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/class-use/Randomness.html

Illustrates the constructor for `SolutionGenerator` that utilizes a `Randomness` object.

```APIDOC
## SolutionGenerator Constructor

### Description
Constructor for SolutionGenerator that initializes it with a Randomness object.

### Method Signature
`SolutionGenerator(java.util.Set<AttributeType> attributeTypes, int numPeople, Randomness rnd)`

### Parameters
- **attributeTypes** (java.util.Set<AttributeType>) - The types of attributes to consider.
- **numPeople** (int) - The number of people involved in the puzzle.
- **rnd** (Randomness) - The randomness provider for solution generation.
```

--------------------------------

### SolutionGenerator Constructor (full configuration)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/SolutionGenerator.html

Creates a SolutionGenerator with a custom set of AttributeTypes, a specified number of people, and a provided Randomness instance for controlled puzzle generation.

```java
public
SolutionGenerator(java.util.Set<AttributeType>
attributeTypes,
int
numPeople,
Randomness
rnd)
```

--------------------------------

### setChocoSettings(Settings chocoSettings)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolver.html

Sets the settings for the underlying SAT solver.

```APIDOC
## setChocoSettings(Settings chocoSettings)

### Description
The settings for the underlying SAT solver.

### Parameters
#### Path Parameters
- **chocoSettings** (org.chocosolver.solver.Settings) - Required - The settings for the underlying SAT solver.
```

--------------------------------

### Define Pet Attribute with BasicAttributeType

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Attributes.html

Shows how to define attributes using BasicAttributeType. This is a straightforward way to create custom attributes.

```java
static final AttributeType PET
```

--------------------------------

### Initialize PuzzleSolver

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolver.html

Initializes a new solver with a given BasicPuzzle. This is the primary constructor for the PuzzleSolver class.

```java
public	PuzzleSolver(BasicPuzzle	puzzle)
```

--------------------------------

### build Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleBuilder.html

Builds and returns the constructed puzzle after validation.

```APIDOC
## build()

### Description
Builds and returns the constructed puzzle after validation.

### Method
```java
public BasicPuzzle build()
```

### Returns
- **BasicPuzzle** - The constructed puzzle.
```

--------------------------------

### add(SolutionPerson person)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Adds a new person to the solution. Returns the builder instance for chaining.

```APIDOC
## add(SolutionPerson person)

### Description
Adds a new person to the solution.

### Method
`add`

### Parameters
#### Path Parameters
- **person** (SolutionPerson) - Required - The person to add.

### Returns
- PuzzleSolutionBuilder - The builder instance.
```

--------------------------------

### Configure SAT Solver Settings

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Allows customization of the underlying SAT solver's behavior by providing specific settings. Use this to tune performance or constraints.

```java
public void setChocoSettings(org.chocosolver.solver.Settings chocoSettings)
```

--------------------------------

### QuestionPuzzle Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzle.html

Creates a new instance of QuestionPuzzle by attaching a question to a basic puzzle.

```APIDOC
## QuestionPuzzle Constructor

### Description
Creates a new instance by attaching a question to a basic puzzle.

### Signature
```java
public QuestionPuzzle(Question question, BasicPuzzle puzzle)
```

### Parameters
* **question** (Question) - The question to be associated with the puzzle.
* **puzzle** (BasicPuzzle) - The basic puzzle defining the constraints.
```

--------------------------------

### PuzzleBuilder Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleBuilder.html

Initializes a new instance of the PuzzleBuilder class.

```APIDOC
## PuzzleBuilder()

### Description
Initializes a new instance of the PuzzleBuilder class.

### Constructor
```java
public PuzzleBuilder()
```
```

--------------------------------

### JDKRandom Constructor with Seed

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/JDKRandom.html

Initializes a new instance of the JDKRandom class with a specified seed value.

```java
public JDKRandom(long seed)
```

--------------------------------

### getAbout Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Retrieves the `AttributeType` that specifies what the question is about.

```APIDOC
## Method: getAbout

```java
public AttributeType getAbout()
```

Returns:
- The `AttributeType` that the question is about.
```

--------------------------------

### Question Generation with Randomness

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/class-use/Randomness.html

Demonstrates how to generate a random question using the `Randomness` object.

```APIDOC
## Question.generate

### Description
Generates a random question using the provided sets of attributes and a Randomness object.

### Method Signature
`static Question generate(java.util.Map<AttributeType,java.util.Set<Attribute>> attributeSets, Randomness rnd)`

### Parameters
- **attributeSets** (java.util.Map<AttributeType,java.util.Set<Attribute>>) - The sets of attributes to use for question generation.
- **rnd** (Randomness) - An instance of Randomness to ensure random question generation.
```

--------------------------------

### Add Person with Attributes

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Adds a new person to the solution with the specified attributes. Attributes can be empty.

```java
public
PuzzleSolutionBuilder
add(Attribute... attributes)
```

--------------------------------

### LazyInstance Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/LazyInstance.html

Initializes a new LazyInstance with a given Supplier. The Supplier provides the logic for creating the instance when it's first needed.

```APIDOC
## LazyInstance Constructor

### Description
Initializes a new LazyInstance with a given Supplier. The Supplier provides the logic for creating the instance when it's first needed.

### Signature
```java
public LazyInstance(java.util.function.Supplier<T> supplier)
```

### Parameters
* **supplier** (java.util.function.Supplier<T>) - The supplier function used to create the instance.
```

--------------------------------

### Build PuzzleSolution

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Completes the building process and returns the final PuzzleSolution object.

```java
public
PuzzleSolution
build()
```

--------------------------------

### QuestionPuzzle Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzle.html

Creates a new instance by attaching a question to a basic puzzle. Use when initializing a new question puzzle.

```java
public QuestionPuzzle(Question question,
                      BasicPuzzle puzzle)
```

--------------------------------

### describe Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Converts the question into a human-readable natural language sentence, localized according to the provided locale.

```APIDOC
## Method: describe

```java
public String describe(java.util.Locale locale)
```

Converts the question to a natural language sentence.

Parameters:
- `locale` (Locale): The locale to use for language conversion.

Returns:
- A natural language string representing the question.
```

--------------------------------

### CommutativeFact Factory Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/fact/class-use/CommutativeFact.html

Demonstrates how to create a CommutativeFact instance using the static create method.

```APIDOC
## CommutativeFact.Source.create(Attribute left, Attribute right)

### Description
Creates a new CommutativeFact instance with the specified left and right attributes.

### Method
static factory method

### Parameters
#### Path Parameters
- **left** (Attribute) - Required - The left attribute for the fact.
- **right** (Attribute) - Required - The right attribute for the fact.

### Response
#### Success Response (CommutativeFact)
- Returns an instance of CommutativeFact.

### Response Example
```json
{
  "example": "CommutativeFact instance"
}
```
```

--------------------------------

### JDKRandom Constructor with Existing Random Object

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/JDKRandom.html

Initializes a new instance of the JDKRandom class using an existing java.util.Random object.

```java
public JDKRandom(java.util.Random rnd)
```

--------------------------------

### Question Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Constructs a new `Question` object, specifying the attribute towards which the question is directed and the attribute type it is about.

```APIDOC
## Constructor: Question

```java
public Question(Attribute towards, AttributeType about)
```

Parameters:
- `towards` (Attribute): The attribute identifying the person the question is directed towards.
- `about` (AttributeType): The type of attribute the question is about.
```

--------------------------------

### Fact Constructor Usage

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/fact/class-use/Fact.html

Constructor for BasicPuzzle that accepts a collection of Fact objects.

```APIDOC
## BasicPuzzle Constructor

### Description
Initializes a BasicPuzzle with attribute sets and a collection of facts.

### Constructor Parameters
- `java.util.Map<AttributeType,java.util.Set<Attribute>> attributeSets`
- `java.util.Collection<Fact> facts`
```

--------------------------------

### JDKRandom Methods

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/JDKRandom.html

Provides methods for generating random integers within a bound and shuffling lists.

```APIDOC
## shuffle(java.util.List<?> list)

### Description
Shuffles the provided list in place.

### Method
`public void shuffle(java.util.List<?> list)`

### Parameters
* **list** (java.util.List<?>) - The list to be shuffled.
```

```APIDOC
## nextInt(int bound)

### Description
Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified bound (exclusive).

### Method
`public int nextInt(int bound)`

### Parameters
* **bound** (int) - The upper bound (exclusive) of the random number to be generated.
```

--------------------------------

### toSolutionSet Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AllDifferentType.html

Returns a list containing the first 'numPeople' elements from the provided array of attribute values. This is a protected static utility method.

```java
protected static
java.util.List<Attribute> toSolutionSet(Attribute[] allValues,
                                                 int numPeople)
```

--------------------------------

### postTo Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/fact/Different.html

Applies the constraints of this fact to the given Zebra model.

```APIDOC
## postTo(ZebraModel model)

### Description
Adds the constraints represented by this fact to the Zebra model.

### Parameters
* **model** (ZebraModel) - The model to which the fact's constraints will be applied.
```

--------------------------------

### Set Choco Solver Settings

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolver.html

Sets the configuration settings for the underlying Choco SAT solver. This allows customization of the solving process.

```java
public	void	setChocoSettings(org.chocosolver.solver.Settings	chocoSettings)
```

--------------------------------

### JDKRandom Constructors

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/JDKRandom.html

The JDKRandom class can be instantiated in three ways: with no arguments (default constructor), with a seed value, or with an existing java.util.Random instance.

```APIDOC
## JDKRandom()

### Description
Default constructor for JDKRandom.

### Constructor
`public JDKRandom()`
```

```APIDOC
## JDKRandom(long seed)

### Description
Constructs a JDKRandom instance with the specified seed.

### Constructor
`public JDKRandom(long seed)`
```

```APIDOC
## JDKRandom(java.util.Random rnd)

### Description
Constructs a JDKRandom instance using an existing java.util.Random object.

### Constructor
`public JDKRandom(java.util.Random rnd)`
```

--------------------------------

### addSet Method (String, String...)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleBuilder.html

Creates a new BasicAttributeType with the given parameters and adds it to the puzzle under construction.

```APIDOC
## addSet(String typeName, String... attributeLabels)

### Description
Creates a new `BasicAttributeType` with the given parameters and adds it to the puzzle under construction.

### Method
```java
public BasicAttributeType addSet(java.lang.String typeName, java.lang.String... attributeLabels)
```

### Parameters
#### Path Parameters
- **typeName** (String) - Required - As in `BasicAttributeType.BasicAttributeType(Set, String, String)`.
- **attributeLabels** (String...) - Required - As in `BasicAttributeType.BasicAttributeType(Set, String, String)`.

### Returns
- **BasicAttributeType** - The newly created attribute type.
```

--------------------------------

### solve()

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolver.html

Solves the puzzles eagerly and returns a list of all distinct solutions.

```APIDOC
## solve()

### Description
Solves the puzzles eagerly.

### Returns
- a list of all distinct solution.
```

--------------------------------

### BasicPuzzle Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicPuzzle.html

Initializes a new BasicPuzzle instance with attribute sets and facts. For efficiency, the constructor does not validate input consistency; use PuzzleBuilder if validation is preferred.

```java
public BasicPuzzle(java.util.Map<AttributeType,java.util.Set<Attribute>> attributeSets,
                   java.util.Collection<Fact> facts)
```

--------------------------------

### toSolutionSet Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AllDifferentType.html

Returns a list of the first 'numPeople' elements from the given array of attributes.

```APIDOC
## toSolutionSet(Attribute[] allValues, int numPeople)

### Description
Returns a list of the first "numPeople" elements of the given array. Used to implement `AttributeType.getAttributes(int)` in `AllDifferentType` implementations with a fixed set of attributes.

### Method
`protected static List<Attribute> toSolutionSet(Attribute[] allValues, int numPeople)`

### Parameters
* **allValues** (Attribute[]) - The array containing all possible attribute values.
* **numPeople** (int) - The number of people for whom to generate the solution set.

### Returns
A list of attributes as in `AttributeType.getAttributes(int)`.
```

--------------------------------

### Describe Solution in Natural Language

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolution.html

Describes the solution in natural language using the specified locale. Returns a 2D array where each inner array describes a person with attribute descriptions.

```java
public java.lang.String[][] describe(java.util.Locale locale)
```

--------------------------------

### JDKRandom Default Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/JDKRandom.html

Creates a new instance of the JDKRandom class using the default constructor.

```java
public JDKRandom()
```

--------------------------------

### Puzzle Generator Constructors with Randomness

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/class-use/Randomness.html

Shows the constructors for `AbstractPuzzleGenerator`, `PuzzleGenerator`, and `QuestionPuzzleGenerator` that accept a `Randomness` object.

```APIDOC
## AbstractPuzzleGenerator Constructor

### Description
Constructor for AbstractPuzzleGenerator that initializes it with a Randomness object.

### Method Signature
`AbstractPuzzleGenerator(Randomness rnd, PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)`

### Parameters
- **rnd** (Randomness) - The randomness provider for puzzle generation.
- **solution** (PuzzleSolution) - The solution to the puzzle.
- **factTypes** (java.util.Set<Fact.Type>) - The types of facts to consider.
```

```APIDOC
## PuzzleGenerator Constructor

### Description
Constructor for PuzzleGenerator that initializes it with a Randomness object.

### Method Signature
`PuzzleGenerator(Randomness rnd, PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)`

### Parameters
- **rnd** (Randomness) - The randomness provider for puzzle generation.
- **solution** (PuzzleSolution) - The solution to the puzzle.
- **factTypes** (java.util.Set<Fact.Type>) - The types of facts to consider.
```

```APIDOC
## QuestionPuzzleGenerator Constructor

### Description
Creates a new generator for puzzles with the given solution assignment, utilizing a Randomness object.

### Method Signature
`QuestionPuzzleGenerator(Question question, PuzzleSolution solution, Randomness rnd, java.util.Set<Fact.Type> factTypes)`

### Parameters
- **question** (Question) - The question for which to generate a puzzle.
- **solution** (PuzzleSolution) - The solution assignment for the puzzle.
- **rnd** (Randomness) - The randomness provider for puzzle generation.
- **factTypes** (java.util.Set<Fact.Type>) - The types of facts to consider.
```

--------------------------------

### BasicPuzzle Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/BasicPuzzle.html

Constructs a BasicPuzzle with specified attribute sets and facts. Note: For efficiency, the constructor does not validate the consistency of attribute sets and facts. Use PuzzleBuilder if validation is preferred.

```APIDOC
## BasicPuzzle Constructor

### Description
Constructs a new BasicPuzzle instance.

### Parameters
* `attributeSets` (Map<AttributeType, Set<Attribute>>) - A map defining the attribute types and their possible values.
* `facts` (Collection<Fact>) - A collection of facts that must be satisfied by any solution.
```

--------------------------------

### Question Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/Attribute.html

Constructs a Question object with specified 'towards' and 'about' attributes.

```APIDOC
## Question

### Description
Constructs a Question object.

### Method
`Question(Attribute towards, AttributeType about)`

### Parameters
#### Path Parameters
- **towards** (Attribute) - Required - The attribute the question is directed towards.
- **about** (AttributeType) - Required - The type of attribute the question is about.
```

--------------------------------

### SolutionPerson Class Usage

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/SolutionPerson.html

Demonstrates the various ways the SolutionPerson class is utilized in the zebra4j library, such as being returned by methods or used as parameters.

```APIDOC
## SolutionPerson Class Use

### Description
This section details how the `SolutionPerson` class is used within the zebra4j library. It covers methods that return `SolutionPerson` objects, methods that return types containing `SolutionPerson` as an argument, and methods that accept `SolutionPerson` as a parameter.

### Uses of SolutionPerson

**Methods returning SolutionPerson:**

- `SolutionPerson.withAttribute(Attribute attribute)`: Returns a `SolutionPerson` object with an added attribute.

**Methods returning types with SolutionPerson arguments:**

- `PuzzleSolution.findPerson(Attribute attr)`: Returns an `Optional<SolutionPerson>` representing a person found based on an attribute.
- `PuzzleSolution.getPeople()`: Returns a `Set<SolutionPerson>` containing all people with their specified attributes.

**Methods with SolutionPerson parameters:**

- `PuzzleSolutionBuilder.add(SolutionPerson person)`: Adds a new `SolutionPerson` to the builder.
```

--------------------------------

### solveSingle

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Solves the puzzle and returns a single solution.

```APIDOC
## solveSingle()

### Description
Returns a single solution to the puzzle, useful for puzzles that were generated by `QuestionPuzzleGenerator` and are guaranteed to have a single solution.

### Returns
* **Attribute** - a single solution to the puzzle

### Throws
* **java.util.NoSuchElementException** - if the puzzle doesn't have any solutions
```

--------------------------------

### Randomness Interface Methods

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/util/Randomness.html

This section details the methods available in the Randomness interface, including `nextInt` and `shuffle`.

```APIDOC
## Randomness Interface

This interface allows implementing the data randomization using different libraries. The built-in implementation is `JDKRandom`, which uses randomization from the JDK. Users of the library may prefer commons-rng, as in this case.

### Methods

*   `int nextInt(int bound)`: Same as `Random.nextInt(int)`.
*   `void shuffle(java.util.List<?> list)`: Shuffles the provided list in place.
```

--------------------------------

### Describe Question

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Converts the question into a human-readable natural language sentence based on the provided locale.

```java
public
java.lang.Stringdescribe(java.util.Localelocale)
```

--------------------------------

### add(Attribute... attributes)

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PuzzleSolutionBuilder.html

Adds a new person with the given attributes to the solution. Returns the builder instance for chaining.

```APIDOC
## add(Attribute... attributes)

### Description
Adds a new person with the given attributes to the solution.

### Method
`add`

### Parameters
#### Path Parameters
- **attributes** (Attribute...) - Optional - The attributes for the person. May be empty.

### Returns
- PuzzleSolutionBuilder - The builder instance.
```

--------------------------------

### solve

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/QuestionPuzzleSolver.html

Solves the puzzle and returns all valid solutions.

```APIDOC
## solve()

### Description
Returns the set of solutions - answers to the question that satisfy a puzzle. The list will be empty if the puzzle contains contradicting rules or facts. Puzzles generated by `QuestionPuzzleGenerator` have a single solution and the collection will have a single element.

### Returns
* **java.util.Set<Attribute>** - the set of solutions
```

--------------------------------

### PersonName description() Method

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/PersonName.html

The description() method returns a string description for the PersonName, used in sentences like 'Ivan is {description}'.

```java
public
java.lang.String description(java.util.Locale locale)
```

--------------------------------

### PuzzleSolution Usage in Constructors

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/PuzzleSolution.html

Illustrates how PuzzleSolution is used as a parameter in various constructors within the zebra4j package.

```APIDOC
## Constructors with Parameters of type PuzzleSolution

### Description
Constructors in zebra4j that accept PuzzleSolution as a parameter.

### Constructor
- `AbstractPuzzleGenerator(Randomness rnd, PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)`
- `PuzzleGenerator(PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)` Generate a new random puzzle using default randomness source
- `PuzzleGenerator(Randomness rnd, PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)`
- `QuestionPuzzleGenerator(Question question, PuzzleSolution solution, Randomness rnd, java.util.Set<Fact.Type> factTypes)` Creates a new generator for puzzles with the given solution assignment
- `QuestionPuzzleGenerator(Question question, PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)` Creates a new generator with a default random generator
```

--------------------------------

### Cli Class Definition

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/cli/Cli.html

Defines the main class for the zebra4j command-line interface. It extends java.lang.Object.

```java
public class Cli
extends java.lang.Object
```

--------------------------------

### Question Usage in Puzzle Creation

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/class-use/Question.html

Demonstrates how the Question object is used when creating QuestionPuzzle and QuestionPuzzleGenerator instances.

```APIDOC
## QuestionPuzzle and QuestionPuzzleGenerator Constructors

### Description
These constructors show how a `Question` object is associated with a puzzle during its creation or when setting up a puzzle generator.

### Constructors
#### QuestionPuzzle(Question question, BasicPuzzle puzzle)
- `question` (Question): The question to associate with the puzzle.
- `puzzle` (BasicPuzzle): The basic puzzle structure.

#### QuestionPuzzleGenerator(Question question, PuzzleSolution solution, Randomness rnd, java.util.Set<Fact.Type> factTypes)
- `question` (Question): The question for which to generate puzzles.
- `solution` (PuzzleSolution): The solution the generated puzzles should adhere to.
- `rnd` (Randomness): Randomness provider.
- `factTypes` (Set<Fact.Type>): Types of facts to include.

#### QuestionPuzzleGenerator(Question question, PuzzleSolution solution, java.util.Set<Fact.Type> factTypes)
- `question` (Question): The question for which to generate puzzles.
- `solution` (PuzzleSolution): The solution the generated puzzles should adhere to.
- `factTypes` (Set<Fact.Type>): Types of facts to include.
```

--------------------------------

### AllDifferentType Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AllDifferentType.html

Initializes a new instance of the AllDifferentType class.

```APIDOC
## AllDifferentType()

### Description
Initializes a new instance of the AllDifferentType class.

### Constructor
`AllDifferentType()`
```

--------------------------------

### Question Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/Question.html

Constructs a new Question instance, specifying the person (towards) and the attribute type (about).

```java
public
Question(Attributetowards,
                AttributeTypeabout)
```

--------------------------------

### AtHouse Constructor

Source: https://www.javadoc.io/doc/io.github.murfffi/zebra4j/0.10/zebra4j/AtHouse.html

Constructor for the AtHouse class, initializing the position.

```java
public
AtHouse(int
position)
```
Tokens:
Raw