# `Tune.Program`
[🔗](https://github.com/mikehostetler/tune/blob/v0.5.0/lib/tune/program.ex#L1)

The contract for a typed Tune program.

A program is either a `Tune.Predictor` or a struct whose module implements
this behaviour. Composition stays in ordinary Elixir functions.

# `parameters`

```elixir
@type parameters() :: %{
  required(String.t()) =&gt; Tune.Predictor.t() | Tune.Parameter.t()
}
```

# `t`

```elixir
@type t() :: Tune.Predictor.t() | struct()
```

# `call`

```elixir
@callback call(program :: struct(), inputs :: map(), Tune.Execution.t()) ::
  {:ok, map(), Tune.Execution.t()} | {:error, term(), Tune.Execution.t()}
```

# `parameters`

```elixir
@callback parameters(program :: struct()) :: parameters()
```

# `put_parameters`

```elixir
@callback put_parameters(program :: struct(), parameters()) :: struct()
```

# `signature`

```elixir
@callback signature(program :: struct()) :: Tune.Signature.t()
```

# `parameters`

```elixir
@spec parameters(t()) :: {:ok, parameters()} | {:error, Exception.t()}
```

Returns the program's declared parameters.

# `replace_parameters`

```elixir
@spec replace_parameters(t(), parameters()) :: {:ok, t()} | {:error, Exception.t()}
```

Replaces named parameters and returns the updated program.

Every name must exist. Each replacement must keep its kind and schema.

# `same_fields?`

```elixir
@spec same_fields?(Tune.Signature.t(), Tune.Signature.t()) :: boolean()
```

Returns true when two signatures have the same field names and schemas.

# `signature`

```elixir
@spec signature(t()) :: {:ok, Tune.Signature.t()} | {:error, Exception.t()}
```

Returns the program's signature.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
