warm_start_struct

View page source

Ipopt Warm Start Information

Syntax

CppAD::mixed::warm_start_struct warm_start

Prototype

    struct x_info_struct {
        double x; double z_L; double z_U; double scale_x;
    };
    struct g_info_struct {
        double lambda; double scale_g;
    };
    struct warm_start_struct {
        double mu;
        double scale_f;
        CppAD::vector<x_info_struct> x_info;
        CppAD::vector<g_info_struct> g_info;
    };

mu

This is the warm start value for the barrier penalty parameter.

scale_f

This is the cppad_mixed scaling factor for the ipopt objective function \(f(x)\).

x_info

If the size of this vector is zero, the size of g_info must also be zero. Otherwise, x_info has size equal to the number of primal variables \(x\). The j-th element of this vector contains the following fields:

x

is the warm start value for x[j].

z_L

is the warm start value for z_L[j].

z_U

is the warm start value for z_U[j].

scale_x

is the cppad_mixed scaling factor for x[j].

g_info

If the size of x_info is non-zero, g_info has size equal to the number of \(g(x)\) constraints. The i-th element of this vector contains the following fields:

lambda

is the warm start value for lambda[i].

scale_g

is the cppad_mixed scaling factor for \(g_i(x)\).

Public

This structure is part of the CppAD Mixed user API.