API Reference

U(obj::Objective, y)

Evaluates the net flow utility function objective at y.

Ubar(obj::Objective, ν)

Evaluates the 'conjugate' of the net flow utility function objective at ν. Specifically,

\[ \bar U(\nu) = \sup_y \left(U(y) - \nu^T y \right).\]

grad_U(obj::Objective, y)

Returns the gradient of the net flow utility function objective at y.

grad!(g, obj::Objective, ν)

Computes the gradient of Ubar(obj, ν) at ν.

lower_limit(obj)

Componentwise lower bound on argument ν for objective Ubar. Returns a vector with length length(ν) (number of nodes).

upper_limit(obj)

Componentwise upper bound on argument ν for objective Ubar. Returns a vector with length length(ν) (number of nodes).