ProjectedNLP

(类来自 pyomo.contrib.pynumero.interfaces.nlp_projections)

class pyomo.contrib.pynumero.interfaces.nlp_projections.ProjectedNLP(original_nlp, primals_ordering)

基础类：_BaseNLPDelegator

__init__(original_nlp, primals_ordering)

该类接受一个依赖于一组原始变量（原始空间）的NLP，并将其转换为依赖于重新排序的原始变量（投影空间）的NLP。

这将影响与原始变量相关的所有返回项。例如，梯度将按照新的原始变量顺序而不是原始的原始变量顺序排列。

还要注意，这可能包括原始NLP中未包含的额外原始变量，或者可能排除原始NLP中包含的原始变量。

Parameters:

• original_nlp (NLP-like) – 实现NLP接口的原始NLP对象

• primals_ordering (list) – 表示此NLP所需原始变量顺序的字符串列表。该列表可以包含原始NLP中不存在的新变量，从而扩展原始变量的空间。

方法

__init__(original_nlp, primals_ordering)	该类接受一个依赖于一组原始变量（原始空间）的NLP，并将其转换为依赖于重新排序的原始变量集（投影空间）的NLP。
constraint_names()	重写此方法以提供约束的字符串名称
constraints_lb()	返回约束条件的下界向量
constraints_ub()	返回约束条件的上限向量
create_new_vector(vector_type)	创建一个具有适当长度和结构的向量
evaluate_constraints([out])	返回在set_primals中给定的原始变量值处评估的约束值
evaluate_grad_objective([out])	返回在set_primals中给定的原始变量值处评估的目标函数的梯度
evaluate_hessian_lag([out])	返回在给定原始变量集 set_primals 和对偶变量集 set_duals 的值处评估的拉格朗日函数的 Hessian 矩阵
evaluate_jacobian([out])	返回在set_primals中给定的原始变量值处评估的约束的雅可比矩阵
evaluate_objective()	返回在set_primals中给定的原始变量值处评估的目标函数值
get_constraints_scaling()	返回用于约束的所需缩放因子。
get_duals()	获取set_duals中提供的对偶变量值的副本。
get_obj_factor()	获取由set_obj_factor设置的目标函数因子的值。
get_obj_scaling()	返回用于目标函数的所需缩放因子。
get_primals()	获取在set_primals中提供的原始变量值的副本。
get_primals_scaling()	返回用于原语的所需缩放因子。
init_duals()	返回带有约束对偶变量初始值的向量
init_primals()	返回包含原始变量初始值的向量
n_constraints()	返回约束的数量
n_primals()	返回原始变量的数量
nnz_hessian_lag()	返回拉格朗日函数的Hessian矩阵中非零值的数量
nnz_jacobian()	返回等式约束的雅可比矩阵中非零值的数量
primals_lb()	返回原始变量的下界向量
primals_names()	重写此方法以为原始变量提供字符串名称
primals_ub()	返回原始变量的上界向量
report_solver_status(status_code, status_message)	使用在set方法中定义的原始和对偶值向NLP类报告求解器状态
set_duals(duals)	设置用于调用评估方法（hessian_lag）的约束条件的对偶变量的值
set_obj_factor(obj_factor)	设置目标函数因子的值，用于在调用拉格朗日函数的Hessian矩阵评估（evaluate_hessian_lag）时使用。
set_primals(primals)	设置原始变量的值，以便在调用评估方法时使用

成员文档

constraint_names()

重写此方法以提供约束的字符串名称

constraints_lb()

返回约束条件的下界向量

Return type:

类似向量

constraints_ub()

返回约束条件的上限向量

Return type:

类似向量

create_new_vector(vector_type)

创建一个具有适当长度和结构的向量，如所请求的

Parameters:

vector_type ({'primals', 'constraints', 'duals'}) – 字符串标识要创建的适当向量。

Return type:

类似向量

evaluate_constraints(out=None)

返回在set_primals中给定的原始变量值处评估的约束值

Parameters:

out (array_like, optional) – 输出数组。其类型被保留，并且必须具有正确的形状以容纳输出。

Return type:

vector_like

evaluate_grad_objective(out=None)

返回在set_primals中给定的原始变量值处评估的目标函数的梯度

Parameters:

out (vector_like, optional) – 输出向量。其类型被保留，并且必须具有正确的形状以容纳输出。

Return type:

vector_like

evaluate_hessian_lag(out=None)

返回在给定原始变量集和双变量集的值处评估的拉格朗日函数的Hessian矩阵

Parameters:

out (matrix_like (例如, coo_matrix), 可选) – 输出矩阵，其结构已定义为hessian。可选

Return type:

矩阵类

evaluate_jacobian(out=None)

返回在set_primals中给定的原始变量值处评估的约束的雅可比矩阵

Parameters:

out (matrix_like (例如, coo_matrix), 可选) – 输出矩阵，其结构已经定义为雅可比矩阵。

Return type:

矩阵类

evaluate_objective()

返回在 set_primals 中给定的原始变量值处评估的目标函数值

Return type:

float

get_constraints_scaling()

返回用于约束的所需缩放因子。None 表示不进行缩放。 这表示模型可能进行缩放，但评估方法应返回未缩放的值。

Return type:

类似数组或无

get_duals()

获取set_duals中提供的对偶变量值的副本。这些值将用于调用评估方法。

get_obj_factor()

获取由set_obj_factor设置的目标函数因子的值。这是在调用拉格朗日函数的Hessian矩阵评估（evaluate_hessian_lag）时将使用的值。

get_obj_scaling()

返回用于目标函数的所需缩放因子。None 表示不进行缩放。 这表示模型可能进行缩放，但评估方法应返回未缩放的值。

Return type:

float 或 None

get_primals()

获取在set_primals中提供的原始变量的值的副本。这些值将用于调用评估方法。

get_primals_scaling()

返回用于原始数据的期望缩放因子。None 表示不进行缩放。 这表示模型可能进行缩放，但评估方法应返回未缩放的值

Return type:

类似数组或无

init_duals()

返回带有约束对偶变量初始值的向量

init_primals()

返回包含原始变量初始值的向量

n_constraints()

返回约束的数量

n_primals()

返回原始变量的数量

nnz_hessian_lag()

返回拉格朗日函数的Hessian矩阵中非零值的数量

nnz_jacobian()

返回等式约束的雅可比矩阵中非零值的数量

primals_lb()

返回原始变量的下界向量

Return type:

类似向量

primals_names()

重写此方法以为原始变量提供字符串名称

primals_ub()

返回原始变量的上界向量

Return type:

类似向量

report_solver_status(status_code, status_message)

使用在设置方法中定义的原始和对偶值向NLP类报告求解器状态

set_duals(duals)

设置约束的对偶变量的值，以便在调用评估方法（hessian_lag）时使用。

Parameters:

duals (vector_like) – 包含等式约束对偶变量值的向量

set_obj_factor(obj_factor)

设置目标函数因子的值，用于在调用拉格朗日函数的Hessian矩阵评估时使用（evaluate_hessian_lag）

Parameters:

obj_factor (float) – 用于评估拉格朗日函数的Hessian矩阵的目标函数因子值

set_primals(primals)

设置原始变量的值，用于调用评估方法

Parameters:

primals (vector_like) – 包含原始变量值的向量。