Chasolver

https://docs.rs/chasolver/3.0.0/chasolver/
Admin
Chasolver is a chess helpmate solver and unwinnability detector that determines whether a helpmate...
Tokens:1,628
Snippets:20
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### pub fn winnability(board: &Board, intended_winner: Color) -> Option<Winnability>

Source: https://docs.rs/chasolver/3.0.0/chasolver/fn.winnability.html

Performs a full helpmate search for the intended_winner. Returns Some(Winnability::Winnable) with a sequence if a helpmate exists, Some(Winnability::Unwinnable) if none exists, or None if the result could not be determined.

```APIDOC
## Function: winnability

### Description
Performs a full helpmate search for the specified `intended_winner` on the provided `board`.

### Signature
`pub fn winnability(board: &Board, intended_winner: Color) -> Option<Winnability>`

### Parameters
- **board** (&Board) - The current state of the game board.
- **intended_winner** (Color) - The color for which the helpmate search is performed.

### Returns
- **Option<Winnability>** - Returns `Some(Winnability::Winnable)` if a helpmate sequence is found, `Some(Winnability::Unwinnable)` if no helpmate exists, or `None` if the analysis could not be completed.
```

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

### is_unwinnable_fast

Source: https://docs.rs/chasolver

Provides a fast but incomplete check for unwinnability, which is computationally cheaper than a full winnability search when a mating line is not required.

```APIDOC
## is_unwinnable_fast

### Description
Fast but incomplete check for unwinnability; cheaper than `winnability` when a mating line isn’t needed.
```

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

### pub fn is_unwinnable_fast(board: &Board, intended_winner: Color) -> bool

Source: https://docs.rs/chasolver/3.0.0/chasolver/fn.is_unwinnable_fast.html

Performs a fast check to determine if a position is provably unwinnable for the intended winner. This method is computationally cheaper than a full winnability analysis when a mating line is not required.

```APIDOC
## Function: is_unwinnable_fast

### Description
Performs a fast, incomplete check for unwinnability. This is cheaper than a full winnability check when a mating line is not required.

### Signature
`pub fn is_unwinnable_fast(board: &Board, intended_winner: Color) -> bool`

### Parameters
- **board** (&Board) - The current game board state.
- **intended_winner** (Color) - The player for whom the unwinnability is being checked.

### Returns
- **bool** - Returns `true` if the position is provably unwinnable for the `intended_winner`, otherwise returns `false` if the analysis is inconclusive.
```

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

### Winnability function signature

Source: https://docs.rs/chasolver/3.0.0/chasolver/fn.winnability.html

The function signature for performing a helpmate search on a board.

```rust
pub fn winnability(board: &Board, intended_winner: Color) -> Option<Winnability>
```

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

### is_unwinnable_fast

Source: https://docs.rs/chasolver/3.0.0/chasolver/index.html

Performs a fast but incomplete check for unwinnability. This is more computationally efficient than the full winnability search when a specific mating line is not required.

```APIDOC
## is_unwinnable_fast

### Description
Performs a fast but incomplete check for unwinnability. This is cheaper than the full winnability search when a mating line is not needed.

### Function Signature
`pub fn is_unwinnable_fast(...) -> bool`
```

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

### winnability

Source: https://docs.rs/chasolver

Performs a full helpmate search for the intended winner to determine if a sequence of legal moves ending in checkmate is achievable.

```APIDOC
## winnability

### Description
Full helpmate search for `intended_winner`. Determines whether a helpmate is achievable or proves that none exists.

### Returns
- **Winnability** (Enum) - The result of the analysis.
```

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

### winnability

Source: https://docs.rs/chasolver/3.0.0/chasolver/index.html

Performs a full helpmate search for the intended winner to determine if a sequence of legal moves ending in checkmate is achievable.

```APIDOC
## winnability

### Description
Full helpmate search for the intended winner. Determines whether a helpmate is achievable or proves that none exists.

### Function Signature
`pub fn winnability(...) -> Winnability`
```

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

### Winnability

Source: https://docs.rs/chasolver/3.0.0/chasolver/all.html

An enum representing the possible winnability states.

```APIDOC
## Winnability

### Description
Enum used to categorize the winnability status of a game state.
```

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

### is_unwinnable_fast function signature

Source: https://docs.rs/chasolver/3.0.0/chasolver/fn.is_unwinnable_fast.html

The function signature for checking unwinnability without requiring a full mating line analysis.

```rust
pub fn is_unwinnable_fast(board: &Board, intended_winner: Color) -> bool
```

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

### winnability

Source: https://docs.rs/chasolver/3.0.0/chasolver/all.html

A function to determine the winnability status of a state.

```APIDOC
## winnability

### Description
Evaluates the winnability of a state and returns a Winnability enum variant.

### Signature
`pub fn winnability(...) -> Winnability`
```

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

### is_unwinnable_fast

Source: https://docs.rs/chasolver/3.0.0/chasolver/all.html

A function to quickly determine if a state is unwinnable.

```APIDOC
## is_unwinnable_fast

### Description
Performs a fast check to determine if a given state is unwinnable.

### Signature
`pub fn is_unwinnable_fast(...) -> bool`
```

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

### Define the Winnability enum

Source: https://docs.rs/chasolver/3.0.0/chasolver/enum.Winnability.html

Represents the outcome of a winnability analysis, containing either a sequence of moves for a winnable state or an unwinnable indicator.

```rust
pub enum Winnability {
    Winnable {
        helpmate: Vec<ChessMove>,
    },
    Unwinnable,
}
```
Tokens:
Raw