Add add_similar_to_expression! for arrays of Numbers (#798)

GenXProject · Dec 4, 2024 · 165836d · 165836d
1 parent 4eb44e8
commit 165836d
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 number of concurrent Gurobi uses is limited (#783).
 - Additional long-duration storage constraints to bound state of charge in 
 non-representative periods (#781).
+- New version of `add_similar_to_expression!` to support arrays of `Number`s. (#798)
 
 ### Changed
 - The `charge.csv` and `storage.csv` files now include only resources with 

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "GenX"
 uuid = "5d317b1e-30ec-4ed6-a8ce-8d2d88d7cfac"
 authors = ["Bonaldo, Luca", "Chakrabarti, Sambuddha", "Cheng, Fangwei", "Ding, Yifu", "Jenkins, Jesse D.", "Luo, Qian", "Macdonald, Ruaridh", "Mallapragada, Dharik", "Manocha, Aneesha", "Mantegna, Gabe ", "Morris, Jack", "Patankar, Neha", "Pecci, Filippo", "Schwartz, Aaron", "Schwartz, Jacob", "Schivley, Greg", "Sepulveda, Nestor", "Xu, Qingyu", "Zhou, Justin"]
-version = "0.4.1-dev.16"
+version = "0.4.1-dev.17"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

diff --git a/src/model/core/operational_reserves.jl b/src/model/core/operational_reserves.jl
@@ -270,7 +270,7 @@ function operational_reserves_core!(EP::Model, inputs::Dict, setup::Dict)
     # N-1 contingency requirement is considered only if Unit Commitment is being modeled
     if UCommit >= 1 &&
        (inputs["pDynamic_Contingency"] >= 1 || inputs["pStatic_Contingency"] > 0)
-        add_to_expression!(EP[:eRsvReq], EP[:eContingencyReq])
+        add_similar_to_expression!(EP[:eRsvReq], EP[:eContingencyReq])
     end
 
     ## Objective Function Expressions ##

diff --git a/src/model/expression_manipulation.jl b/src/model/expression_manipulation.jl
@@ -138,6 +138,15 @@ function add_similar_to_expression!(expr1::AbstractArray{GenericAffExpr{C, T}, d
     return nothing
 end
 
+# If the expressions are vectors of numbers, use the += operator
+function add_similar_to_expression!(arr1::AbstractArray{T, dims},
+        arr2::AbstractArray{T, dims}) where {T <: Number, dims}
+    for i in eachindex(arr1)
+        arr1[i] += arr2[i]
+    end
+    return nothing
+end
+
 ###### ###### ###### ###### ###### ######
 # Element-wise addition of one term into an expression
 # Both arrays must have the same dimensions

diff --git a/test/expression_manipulation_test.jl b/test/expression_manipulation_test.jl
@@ -92,6 +92,12 @@ let
     GenX.add_similar_to_expression!(EP[:large_expr], EP[:large_const_expr])
     @test all(EP[:large_expr][:] .== 18.0)
 
+    # Test add_similar_to_expression! with AbstractArray{Number}
+    @expression(EP, eArr1[i = 1:100, j = 1:50], i * 10.0+j * 10.0)
+    @expression(EP, eArr2[i = 1:100, j = 1:50], -(i * 10.0 + j * 10.0))
+    GenX.add_similar_to_expression!(EP[:eArr1], EP[:eArr2])
+    @test all(EP[:eArr1][:] .== 0.0)
+
     # Test add_similar_to_expression! returns an error if the dimensions don't match
     GenX.create_empty_expression!(EP, :small_expr, (2, 3))
     @test_throws ErrorException GenX.add_similar_to_expression!(EP[:large_expr],