# ask

[![Package Version](https://img.shields.io/hexpm/v/ask)](https://hex.pm/packages/ask)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/ask/)
![CI](https://github.com/furrycatherder/gleam-ask/actions/workflows/tests.yml/badge.svg?branch=main)

`ask` is a Gleam library tailored for simplifying the management of equivalences
and predicates. Equivalences allow for the comparison of two values to
determine if they're equivalent, while predicates assess if a given value meets
specific conditions.

## Overview

`ask` provides developers with a set of functions to create, combine, and
transform equivalences and predicates. Whether you're performing basic value
comparisons or intricate logical operations, `ask` furnishes the necessary tools
to handle a variety of scenarios effectively.

## Installation

```sh
gleam add ask
```

## Usage

### Equivalences

```gleam
import ask/equivalence

// Defining custom equivalences
let eq1 = fn(x, y) -> Bool { x == y }
let eq2 = fn(x, y) -> Bool { x % 2 == y % 2 }

// Combining equivalences using logical operations
let combined_eq = equivalence.and(eq1, eq2)

// Using equivalence to compare values
let result = combined_eq(4, 8) // Returns True
```

Equivalences are expected to follow these friendly rules:

- **Reflexivity**: Every value is equivalent to itself. It's like saying, "Hey,
  you're always equal to yourself!"
- **Symmetry**: If one value is equivalent to another, then it's a two-way
  street! If X is like Y, then Y is like X. It's all about fairness!
- **Transitivity**: Imagine a chain of equivalence! If X is equivalent to Y,
  and Y is equivalent to Z, then it's like saying X is also buddies with Z.
  Friendship circles all around!

These rules help keep our equivalences reliable and predictable, making sure
they play nice with each other.

### Predicates

```gleam
import ask/predicate

// Defining custom predicates
let is_positive = fn(x) -> Bool { x > 0 }
let is_even = fn(x) -> Bool { x % 2 == 0 }

// Combining predicates using logical operations
let combined_pred = predicate.and(is_positive, is_even)

// Using predicate to evaluate values
let result = combined_pred(6) // Returns True
```

## Conclusion

`ask` equips Gleam developers with a robust toolkit for managing equivalences and
predicates efficiently. Whether you're implementing algorithms, data validation
systems, or decision-making processes, `ask` facilitates streamlined code
development, allowing you to focus on problem-solving.

Further documentation can be found at <https://hexdocs.pm/ask>.

## Development

```sh
gleam run   # Run the project
gleam test  # Run the tests
gleam shell # Run an Erlang shell
```