object

# `either`

Types and predicates for extended type-checking of expected term references and for handling lists of expected term references.

Author: Paulo Moura
Version: 0.5
Date: 2019/1/24
Compilation flags:
`static, context_switching_calls`
Provides:
type::type/1
type::check/2
arbitrary::arbitrary/1
arbitrary::arbitrary/2

## Public interface

### `expecteds/2`

Returns the terms stored in the references that hold an expected term.

Compilation flags:
`static`
Template:
`expecteds(References,Expecteds)`
Mode and number of proofs:
`expecteds(+list(expected),-list)` - `one`

### `unexpecteds/2`

Returns the terms stored in the references that hold an expected term.

Compilation flags:
`static`
Template:
`unexpecteds(References,Unexpecteds)`
Mode and number of proofs:
`unexpecteds(+list(expected),-list)` - `one`

### `partition/3`

Retrieves and partitions the terms hold by the references.

Compilation flags:
`static`
Template:
`partition(References,Expecteds,Unexpecteds)`
Mode and number of proofs:
`partition(+list(expected),-list,-list)` - `one`

## Protected interface

(see related entities)

## Private predicates

(see related entities)

## Operators

(none)

## Remarks

- Type either(ExpectedType, UnexpectedType): Allows type-checking expected references where the expected and unexpected terms must be of the given types.

- QuickCheck support: Defines clauses for the type::arbitrary/1-2 predicates to allow generating random values for the either(ExpectedType, UnexpectedType) type.

See also

expected, expected(Reference), type, arbitrary