# API Reference

Complete API reference for all public functions in `pyperfectforesight`.

---

## Utilities

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.v
```

---

## Model processing

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.process_model
   pyperfectforesight.lead_lag_incidence
   pyperfectforesight.is_static
   pyperfectforesight.eliminate_static
   pyperfectforesight.local_blocks
```

---

## Steady state

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.SteadyState
   pyperfectforesight.compile_steady_state_funcs
   pyperfectforesight.solve_steady_state
   pyperfectforesight.compute_steady_state_numerical
```

---

## High-level solvers

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.solve_perfect_foresight
   pyperfectforesight.solve_perfect_foresight_homotopy
   pyperfectforesight.solve_perfect_foresight_expectation_errors
```

---

## Initial guess

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.make_initial_guess
```

---

## Auxiliary variables

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.solve_auxiliary_nested
   pyperfectforesight.compute_auxiliary_variables
```

---

## Low-level solver components

```{eval-rst}
.. autosummary::
   :toctree: generated/
   :nosignatures:

   pyperfectforesight.residual
   pyperfectforesight.sparse_jacobian
   pyperfectforesight.append_terminal_conditions
```