-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathparameters.jl
More file actions
785 lines (738 loc) · 26.8 KB
/
parameters.jl
File metadata and controls
785 lines (738 loc) · 26.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
# Copyright (c) 2020: Akshay Sharma and contributors
#
# Use of this source code is governed by an MIT-style license that can be found
# in the LICENSE.md file or at https://opensource.org/licenses/MIT.
# block other methods
MOI.supports(::POI.Optimizer, ::ForwardObjectiveFunction) = false
function MOI.set(::POI.Optimizer, ::ForwardObjectiveFunction, _)
return error(
"Forward objective function is not supported when " *
"`JuMP.Parameter`s (or `MOI.Parameter`s) are present in the model.",
)
end
MOI.supports(::POI.Optimizer, ::ForwardConstraintFunction) = false
function MOI.set(
::POI.Optimizer,
::ForwardConstraintFunction,
::MOI.ConstraintIndex,
_,
)
return error(
"Forward constraint function is not supported when " *
"`JuMP.Parameter`s (or `MOI.Parameter`s) are present in the model.",
)
end
MOI.supports(::POI.Optimizer, ::ReverseObjectiveFunction) = false
function MOI.get(::POI.Optimizer, ::ReverseObjectiveFunction)
return error(
"Reverse objective function is not supported when " *
"`JuMP.Parameter`s (or `MOI.Parameter`s) are present in the model.",
)
end
MOI.supports(::POI.Optimizer, ::ReverseConstraintFunction) = false
function MOI.get(
::POI.Optimizer,
::ReverseConstraintFunction,
::MOI.ConstraintIndex,
)
return error(
"Reverse constraint function is not supported when " *
"`JuMP.Parameter`s (or `MOI.Parameter`s) are present in the model.",
)
end
# functions to be used with ParametricOptInterface.jl
mutable struct SensitivityData{T}
parameter_input_forward::Dict{MOI.VariableIndex,T}
parameter_output_backward::Dict{MOI.VariableIndex,T}
end
function SensitivityData{T}() where {T}
return SensitivityData{T}(
Dict{MOI.VariableIndex,T}(),
Dict{MOI.VariableIndex,T}(),
)
end
const _SENSITIVITY_DATA = :_sensitivity_data
function _get_sensitivity_data(
model::POI.Optimizer{T},
)::SensitivityData{T} where {T}
_initialize_sensitivity_data!(model)
return model.ext[_SENSITIVITY_DATA]::SensitivityData{T}
end
function _initialize_sensitivity_data!(model::POI.Optimizer{T}) where {T}
if !haskey(model.ext, _SENSITIVITY_DATA)
model.ext[_SENSITIVITY_DATA] = SensitivityData{T}()
end
return
end
# forward mode
function _constraint_set_forward!(
model::POI.Optimizer{T},
affine_constraint_cache_dict,
::Type{P},
) where {T,P<:POI.ParametricAffineFunction}
sensitivity_data = _get_sensitivity_data(model)
for (inner_ci, pf) in affine_constraint_cache_dict
cte = zero(T)
terms = MOI.ScalarAffineTerm{T}[]
sizehint!(terms, 0)
for term in POI.affine_parameter_terms(pf)
p = term.variable
sensitivity = get(sensitivity_data.parameter_input_forward, p, 0.0)
cte += sensitivity * term.coefficient
end
if !iszero(cte)
MOI.set(
model.optimizer,
ForwardConstraintFunction(),
inner_ci,
MOI.ScalarAffineFunction{T}(terms, cte),
)
end
end
return
end
function _constraint_set_forward!(
model::POI.Optimizer{T},
vector_affine_constraint_cache_dict,
::Type{P},
) where {T,P<:POI.ParametricVectorAffineFunction}
sensitivity_data = _get_sensitivity_data(model)
for (inner_ci, pf) in vector_affine_constraint_cache_dict
cte = zeros(T, length(pf.c))
terms = MOI.VectorAffineTerm{T}[]
sizehint!(terms, 0)
for term in POI.vector_affine_parameter_terms(pf)
p = term.scalar_term.variable
sensitivity = get(sensitivity_data.parameter_input_forward, p, 0.0)
cte[term.output_index] += sensitivity * term.scalar_term.coefficient
end
if !iszero(cte)
MOI.set(
model.optimizer,
ForwardConstraintFunction(),
inner_ci,
MOI.VectorAffineFunction{T}(terms, cte),
)
end
end
return
end
function _constraint_set_forward!(
model::POI.Optimizer{T},
quadratic_constraint_cache_dict,
::Type{P},
) where {T,P<:POI.ParametricQuadraticFunction}
sensitivity_data = _get_sensitivity_data(model)
for (inner_ci, pf) in quadratic_constraint_cache_dict
cte = zero(T)
terms = MOI.ScalarAffineTerm{T}[]
for term in POI.affine_parameter_terms(pf)
p = term.variable
sensitivity = get(sensitivity_data.parameter_input_forward, p, 0.0)
cte += sensitivity * term.coefficient
end
for term in POI.quadratic_parameter_parameter_terms(pf)
p_1 = term.variable_1
p_2 = term.variable_2
sensitivity_1 =
get(sensitivity_data.parameter_input_forward, p_1, 0.0)
sensitivity_2 =
get(sensitivity_data.parameter_input_forward, p_2, 0.0)
cte +=
sensitivity_1 *
term.coefficient *
MOI.get(model, MOI.VariablePrimal(), p_2) /
ifelse(term.variable_1 === term.variable_2, 2, 1)
cte +=
sensitivity_2 *
term.coefficient *
MOI.get(model, MOI.VariablePrimal(), p_1) /
ifelse(term.variable_1 === term.variable_2, 2, 1)
end
sizehint!(terms, length(POI.quadratic_parameter_variable_terms(pf)))
for term in POI.quadratic_parameter_variable_terms(pf)
p = term.variable_1
sensitivity = get(sensitivity_data.parameter_input_forward, p, NaN)
if !isnan(sensitivity)
push!(
terms,
MOI.ScalarAffineTerm{T}(
sensitivity * term.coefficient,
term.variable_2,
),
)
end
end
if !iszero(cte) || !isempty(terms)
MOI.set(
model.optimizer,
ForwardConstraintFunction(),
inner_ci,
MOI.ScalarAffineFunction{T}(terms, cte),
)
end
end
return
end
function _affine_objective_set_forward!(model::POI.Optimizer{T}) where {T}
cte = zero(T)
terms = MOI.ScalarAffineTerm{T}[]
pf = model.affine_objective_cache
sizehint!(terms, 0)
sensitivity_data = _get_sensitivity_data(model)
for term in POI.affine_parameter_terms(pf)
p = term.variable
sensitivity = get(sensitivity_data.parameter_input_forward, p, 0.0)
cte += sensitivity * term.coefficient
end
if !iszero(cte)
MOI.set(
model.optimizer,
ForwardObjectiveFunction(),
MOI.ScalarAffineFunction{T}(terms, cte),
)
end
return
end
function _quadratic_objective_set_forward!(model::POI.Optimizer{T}) where {T}
cte = zero(T)
pf = MOI.get(
model,
POI.ParametricObjectiveFunction{POI.ParametricQuadraticFunction{T}}(),
)
sensitivity_data = _get_sensitivity_data(model)
for term in POI.affine_parameter_terms(pf)
p = term.variable
sensitivity = get(sensitivity_data.parameter_input_forward, p, 0.0)
cte += sensitivity * term.coefficient
end
for term in POI.quadratic_parameter_parameter_terms(pf)
p_1 = term.variable_1
p_2 = term.variable_2
sensitivity_1 = get(sensitivity_data.parameter_input_forward, p_1, 0.0)
sensitivity_2 = get(sensitivity_data.parameter_input_forward, p_2, 0.0)
cte +=
sensitivity_1 *
term.coefficient *
MOI.get(model, MOI.VariablePrimal(), p_2) /
ifelse(term.variable_1 === term.variable_2, 2, 1)
cte += sensitivity_2 * term.coefficient
MOI.get(model, MOI.VariablePrimal(), p_1) /
ifelse(term.variable_1 === term.variable_2, 2, 1)
end
terms = MOI.ScalarAffineTerm{T}[]
sizehint!(terms, length(POI.quadratic_parameter_variable_terms(pf)))
for term in POI.quadratic_parameter_variable_terms(pf)
p = term.variable_1
sensitivity = get(sensitivity_data.parameter_input_forward, p, NaN)
if !isnan(sensitivity)
push!(
terms,
MOI.ScalarAffineTerm{T}(
sensitivity * term.coefficient,
term.variable_2,
),
)
end
end
if !iszero(cte) || !isempty(terms)
MOI.set(
model.optimizer,
ForwardObjectiveFunction(),
MOI.ScalarAffineFunction{T}(terms, cte),
)
end
return
end
function _cubic_objective_set_forward!(model::POI.Optimizer{T}) where {T}
pf = MOI.get(
model,
POI.ParametricObjectiveFunction{POI.ParametricCubicFunction{T}}(),
)
sensitivity_data = _get_sensitivity_data(model)
cte = zero(T)
affine_terms = MOI.ScalarAffineTerm{T}[]
quadratic_terms = MOI.ScalarQuadraticTerm{T}[]
# pvv terms: Δp * coeff → quadratic perturbation
for term in POI._cubic_pvv_terms(pf)
p = term.index_1
v1 = term.index_2
v2 = term.index_3
Δp = get(sensitivity_data.parameter_input_forward, p, zero(T))
if !iszero(Δp)
qcoeff = Δp * term.coefficient
if v1 == v2
qcoeff *= 2 # MOI diagonal convention
end
push!(
quadratic_terms,
MOI.ScalarQuadraticTerm{T}(qcoeff, v1, v2),
)
end
end
# ppv terms: chain rule on two params → affine perturbation
for term in POI._cubic_ppv_terms(pf)
p1 = term.index_1
p2 = term.index_2
v = term.index_3
Δp1 = get(sensitivity_data.parameter_input_forward, p1, zero(T))
Δp2 = get(sensitivity_data.parameter_input_forward, p2, zero(T))
p1_val = MOI.get(model, MOI.VariablePrimal(), p1)
p2_val = MOI.get(model, MOI.VariablePrimal(), p2)
acoeff =
Δp1 * term.coefficient * p2_val + Δp2 * term.coefficient * p1_val
if !iszero(acoeff)
push!(affine_terms, MOI.ScalarAffineTerm{T}(acoeff, v))
end
end
# ppp terms: chain rule on three params → constant perturbation
for term in POI._cubic_ppp_terms(pf)
p1 = term.index_1
p2 = term.index_2
p3 = term.index_3
Δp1 = get(sensitivity_data.parameter_input_forward, p1, zero(T))
Δp2 = get(sensitivity_data.parameter_input_forward, p2, zero(T))
Δp3 = get(sensitivity_data.parameter_input_forward, p3, zero(T))
p1_val = MOI.get(model, MOI.VariablePrimal(), p1)
p2_val = MOI.get(model, MOI.VariablePrimal(), p2)
p3_val = MOI.get(model, MOI.VariablePrimal(), p3)
cte += term.coefficient * (
Δp1 * p2_val * p3_val +
p1_val * Δp2 * p3_val +
p1_val * p2_val * Δp3
)
end
# Degree-2: p terms (affine parameter → constant perturbation)
for term in pf.p
p = term.variable
Δp = get(sensitivity_data.parameter_input_forward, p, zero(T))
cte += Δp * term.coefficient
end
# Degree-2: pp terms (parameter-parameter → constant perturbation)
for term in pf.pp
p_1 = term.variable_1
p_2 = term.variable_2
Δp1 = get(sensitivity_data.parameter_input_forward, p_1, zero(T))
Δp2 = get(sensitivity_data.parameter_input_forward, p_2, zero(T))
p1_val = MOI.get(model, MOI.VariablePrimal(), p_1)
p2_val = MOI.get(model, MOI.VariablePrimal(), p_2)
cte +=
Δp1 *
term.coefficient *
p2_val /
ifelse(p_1 === p_2, T(2), T(1))
cte +=
Δp2 *
term.coefficient *
p1_val /
ifelse(p_1 === p_2, T(2), T(1))
end
# Degree-2: pv terms (parameter-variable → affine perturbation)
for term in pf.pv
p = term.variable_1
Δp = get(sensitivity_data.parameter_input_forward, p, zero(T))
if !iszero(Δp)
push!(
affine_terms,
MOI.ScalarAffineTerm{T}(
Δp * term.coefficient,
term.variable_2,
),
)
end
end
# Send perturbation to inner model
if !isempty(quadratic_terms) || !isempty(affine_terms) || !iszero(cte)
MOI.set(
model.optimizer,
ForwardObjectiveFunction(),
MOI.ScalarQuadraticFunction{T}(quadratic_terms, affine_terms, cte),
)
end
return
end
function _cubic_objective_get_reverse!(model::POI.Optimizer{T}) where {T}
pf = MOI.get(
model,
POI.ParametricObjectiveFunction{POI.ParametricCubicFunction{T}}(),
)
pvv_terms = POI._cubic_pvv_terms(pf)
ppv_terms = POI._cubic_ppv_terms(pf)
ppp_terms = POI._cubic_ppp_terms(pf)
p_terms = pf.p
pp_terms = pf.pp
pv_terms = pf.pv
if isempty(pvv_terms) && isempty(ppv_terms) && isempty(ppp_terms) &&
isempty(p_terms) && isempty(pp_terms) && isempty(pv_terms)
return
end
sensitivity_data = _get_sensitivity_data(model)
grad_pf = MOI.get(model.optimizer, ReverseObjectiveFunction())
d_cte = MOI.constant(grad_pf)
# pvv terms: ∇p += 2 * coeff * dQ[v1, v2]
for term in pvv_terms
p = term.index_1
v1 = term.index_2
v2 = term.index_3
dQ_ij = quad_sym_half(grad_pf, v1, v2)
value = get!(sensitivity_data.parameter_output_backward, p, zero(T))
sensitivity_data.parameter_output_backward[p] =
value + T(2) * term.coefficient * dQ_ij
end
# ppv terms: chain rule on two params
for term in ppv_terms
p1 = term.index_1
p2 = term.index_2
v = term.index_3
dq_v = JuMP.coefficient(grad_pf, v)
p1_val = MOI.get(model, MOI.VariablePrimal(), p1)
p2_val = MOI.get(model, MOI.VariablePrimal(), p2)
val1 = get!(sensitivity_data.parameter_output_backward, p1, zero(T))
val2 = get!(sensitivity_data.parameter_output_backward, p2, zero(T))
sensitivity_data.parameter_output_backward[p1] =
val1 + term.coefficient * p2_val * dq_v
sensitivity_data.parameter_output_backward[p2] =
val2 + term.coefficient * p1_val * dq_v
end
# ppp terms: chain rule on three params
for term in ppp_terms
p1 = term.index_1
p2 = term.index_2
p3 = term.index_3
p1_val = MOI.get(model, MOI.VariablePrimal(), p1)
p2_val = MOI.get(model, MOI.VariablePrimal(), p2)
p3_val = MOI.get(model, MOI.VariablePrimal(), p3)
val1 = get!(sensitivity_data.parameter_output_backward, p1, zero(T))
val2 = get!(sensitivity_data.parameter_output_backward, p2, zero(T))
val3 = get!(sensitivity_data.parameter_output_backward, p3, zero(T))
sensitivity_data.parameter_output_backward[p1] =
val1 + term.coefficient * p2_val * p3_val * d_cte
sensitivity_data.parameter_output_backward[p2] =
val2 + term.coefficient * p1_val * p3_val * d_cte
sensitivity_data.parameter_output_backward[p3] =
val3 + term.coefficient * p1_val * p2_val * d_cte
end
# Degree-2: p terms
for term in p_terms
p = term.variable
value = get!(sensitivity_data.parameter_output_backward, p, zero(T))
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * d_cte
end
# Degree-2: pp terms
for term in pp_terms
p_1 = term.variable_1
p_2 = term.variable_2
value_1 = get!(sensitivity_data.parameter_output_backward, p_1, zero(T))
value_2 = get!(sensitivity_data.parameter_output_backward, p_2, zero(T))
sensitivity_data.parameter_output_backward[p_1] =
value_1 +
term.coefficient *
d_cte *
MOI.get(model, MOI.VariablePrimal(), p_2) /
ifelse(p_1 === p_2, T(2), T(1))
sensitivity_data.parameter_output_backward[p_2] =
value_2 +
term.coefficient *
d_cte *
MOI.get(model, MOI.VariablePrimal(), p_1) /
ifelse(p_1 === p_2, T(2), T(1))
end
# Degree-2: pv terms
for term in pv_terms
p = term.variable_1
v = term.variable_2
value = get!(sensitivity_data.parameter_output_backward, p, zero(T))
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * JuMP.coefficient(grad_pf, v)
end
return
end
function empty_input_sensitivities!(model::POI.Optimizer{T}) where {T}
empty_input_sensitivities!(model.optimizer)
model.ext[_SENSITIVITY_DATA] = SensitivityData{T}()
return
end
function forward_differentiate!(model::POI.Optimizer{T}) where {T}
empty_input_sensitivities!(model.optimizer)
ctr_types = MOI.get(model, POI.ListOfParametricConstraintTypesPresent())
for (F, S, P) in ctr_types
dict = MOI.get(
model,
POI.DictOfParametricConstraintIndicesAndFunctions{F,S,P}(),
)
_constraint_set_forward!(model, dict, P)
end
obj_type = MOI.get(model, POI.ParametricObjectiveType())
if obj_type <: POI.ParametricAffineFunction
_affine_objective_set_forward!(model)
elseif obj_type <: POI.ParametricQuadraticFunction
_quadratic_objective_set_forward!(model)
elseif obj_type <: POI.ParametricCubicFunction
_cubic_objective_set_forward!(model)
end
forward_differentiate!(model.optimizer)
return
end
function MOI.set(
model::POI.Optimizer,
::ForwardConstraintSet,
ci::MOI.ConstraintIndex{MOI.VariableIndex,MOI.Parameter{T}},
set::MOI.Parameter,
) where {T}
variable = MOI.VariableIndex(ci.value)
if _is_variable(model, variable)
error("Trying to set a forward parameter sensitivity for a variable")
end
sensitivity_data = _get_sensitivity_data(model)
sensitivity_data.parameter_input_forward[variable] = set.value
return
end
function MOI.get(
model::POI.Optimizer,
attr::ForwardVariablePrimal,
variable::MOI.VariableIndex,
)
if _is_parameter(model, variable)
error("Trying to get a forward variable sensitivity for a parameter")
end
return MOI.get(model.optimizer, attr, variable)
end
# reverse mode
function _constraint_get_reverse!(
model::POI.Optimizer{T},
affine_constraint_cache_dict,
::Type{P},
) where {T,P<:POI.ParametricAffineFunction}
sensitivity_data = _get_sensitivity_data(model)
for (inner_ci, pf) in affine_constraint_cache_dict
terms = POI.affine_parameter_terms(pf)
if isempty(terms)
continue
end
grad_pf_cte = MOI.constant(
MOI.get(model.optimizer, ReverseConstraintFunction(), inner_ci),
)
for term in terms
p = term.variable
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * grad_pf_cte
end
end
return
end
function _constraint_get_reverse!(
model::POI.Optimizer{T},
vector_affine_constraint_cache_dict,
::Type{P},
) where {T,P<:POI.ParametricVectorAffineFunction}
sensitivity_data = _get_sensitivity_data(model)
for (inner_ci, pf) in vector_affine_constraint_cache_dict
terms = POI.vector_affine_parameter_terms(pf)
if isempty(terms)
continue
end
grad_pf_cte = MOI.constant(
MOI.get(model.optimizer, ReverseConstraintFunction(), inner_ci),
)
for term in terms
p = term.scalar_term.variable
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value +
term.scalar_term.coefficient * grad_pf_cte[term.output_index]
end
end
return
end
function _constraint_get_reverse!(
model::POI.Optimizer{T},
quadratic_constraint_cache_dict,
::Type{P},
) where {T,P<:POI.ParametricQuadraticFunction}
sensitivity_data = _get_sensitivity_data(model)
for (inner_ci, pf) in quadratic_constraint_cache_dict
p_terms = POI.affine_parameter_terms(pf)
pp_terms = POI.quadratic_parameter_parameter_terms(pf)
pv_terms = POI.quadratic_parameter_variable_terms(pf)
if isempty(p_terms) && isempty(pp_terms) && isempty(pv_terms)
continue
end
grad_pf =
MOI.get(model.optimizer, ReverseConstraintFunction(), inner_ci)
grad_pf_cte = MOI.constant(grad_pf)
for term in p_terms
p = term.variable
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * grad_pf_cte
end
for term in pp_terms
p_1 = term.variable_1
p_2 = term.variable_2
value_1 = get!(sensitivity_data.parameter_output_backward, p_1, 0.0)
value_2 = get!(sensitivity_data.parameter_output_backward, p_2, 0.0)
# TODO: why there is no factor of 2 here????
# ANS: probably because it was SET
sensitivity_data.parameter_output_backward[p_1] =
value_1 +
term.coefficient *
grad_pf_cte *
MOI.get(model, MOI.VariablePrimal(), p_2) /
ifelse(term.variable_1 === term.variable_2, 1, 1)
sensitivity_data.parameter_output_backward[p_2] =
value_2 +
term.coefficient *
grad_pf_cte *
MOI.get(model, MOI.VariablePrimal(), p_1) /
ifelse(term.variable_1 === term.variable_2, 1, 1)
end
for term in pv_terms
p = term.variable_1
v = term.variable_2 # check if inner or outer (should be inner)
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * JuMP.coefficient(grad_pf, v) # * fixed value of the parameter ?
end
end
return
end
function _affine_objective_get_reverse!(model::POI.Optimizer{T}) where {T}
pf = MOI.get(
model,
POI.ParametricObjectiveFunction{POI.ParametricAffineFunction{T}}(),
)
terms = POI.affine_parameter_terms(pf)
if isempty(terms)
return
end
sensitivity_data = _get_sensitivity_data(model)
grad_pf = MOI.get(model.optimizer, ReverseObjectiveFunction())
grad_pf_cte = MOI.constant(grad_pf)
for term in terms
p = term.variable
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * grad_pf_cte
end
return
end
function _quadratic_objective_get_reverse!(model::POI.Optimizer{T}) where {T}
pf = MOI.get(
model,
POI.ParametricObjectiveFunction{POI.ParametricQuadraticFunction{T}}(),
)
p_terms = POI.affine_parameter_terms(pf)
pp_terms = POI.quadratic_parameter_parameter_terms(pf)
pv_terms = POI.quadratic_parameter_variable_terms(pf)
if isempty(p_terms) && isempty(pp_terms) && isempty(pv_terms)
return
end
sensitivity_data = _get_sensitivity_data(model)
grad_pf = MOI.get(model.optimizer, ReverseObjectiveFunction())
grad_pf_cte = MOI.constant(grad_pf)
for term in p_terms
p = term.variable
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * grad_pf_cte
end
for term in pp_terms
p_1 = term.variable_1
p_2 = term.variable_2
value_1 = get!(sensitivity_data.parameter_output_backward, p_1, 0.0)
value_2 = get!(sensitivity_data.parameter_output_backward, p_2, 0.0)
sensitivity_data.parameter_output_backward[p_1] =
value_1 +
term.coefficient *
grad_pf_cte *
MOI.get(model, MOI.VariablePrimal(), p_2) /
ifelse(term.variable_1 === term.variable_2, 2, 1)
sensitivity_data.parameter_output_backward[p_2] =
value_2 +
term.coefficient *
grad_pf_cte *
MOI.get(model, MOI.VariablePrimal(), p_1) /
ifelse(term.variable_1 === term.variable_2, 2, 1)
end
for term in pv_terms
p = term.variable_1
v = term.variable_2 # check if inner or outer (should be inner)
value = get!(sensitivity_data.parameter_output_backward, p, 0.0)
sensitivity_data.parameter_output_backward[p] =
value + term.coefficient * JuMP.coefficient(grad_pf, v) # * fixed value of the parameter ?
end
return
end
function reverse_differentiate!(model::POI.Optimizer)
reverse_differentiate!(model.optimizer)
sensitivity_data = _get_sensitivity_data(model)
empty!(sensitivity_data.parameter_output_backward)
sizehint!(
sensitivity_data.parameter_output_backward,
length(model.parameters),
)
ctr_types = MOI.get(model, POI.ListOfParametricConstraintTypesPresent())
for (F, S, P) in ctr_types
dict = MOI.get(
model,
POI.DictOfParametricConstraintIndicesAndFunctions{F,S,P}(),
)
_constraint_get_reverse!(model, dict, P)
end
obj_type = MOI.get(model, POI.ParametricObjectiveType())
if obj_type <: POI.ParametricAffineFunction
_affine_objective_get_reverse!(model)
elseif obj_type <: POI.ParametricQuadraticFunction
_quadratic_objective_get_reverse!(model)
elseif obj_type <: POI.ParametricCubicFunction
_cubic_objective_get_reverse!(model)
end
return
end
function _is_parameter(
model::POI.Optimizer{T},
variable::MOI.VariableIndex,
) where {T}
return MOI.is_valid(
model,
MOI.ConstraintIndex{MOI.VariableIndex,MOI.Parameter{T}}(variable.value),
)
end
function _is_variable(
model::POI.Optimizer{T},
variable::MOI.VariableIndex,
) where {T}
return MOI.is_valid(model, variable) &&
!MOI.is_valid(
model,
MOI.ConstraintIndex{MOI.VariableIndex,MOI.Parameter{T}}(variable.value),
)
end
function MOI.set(
model::POI.Optimizer,
attr::ReverseVariablePrimal,
variable::MOI.VariableIndex,
value::Number,
)
if _is_parameter(model, variable)
error("Trying to set a backward variable sensitivity for a parameter")
end
MOI.set(model.optimizer, attr, variable, value)
return
end
function MOI.get(
model::POI.Optimizer,
::ReverseConstraintSet,
ci::MOI.ConstraintIndex{MOI.VariableIndex,MOI.Parameter{T}},
) where {T}
variable = MOI.VariableIndex(ci.value)
if _is_variable(model, variable)
error("Trying to get a backward parameter sensitivity for a variable")
end
sensitivity_data = _get_sensitivity_data(model)
return MOI.Parameter{T}(
get(sensitivity_data.parameter_output_backward, variable, 0.0),
)
end