Add clear_cached_params() method to mp.set_manager_opt_model and mp.opt_model.

Author: rdzman

CHANGES.md

@@ -5,6 +5,10 @@ Change history for MP-Opt-Model
 since version 5.0
 -----------------
 
+#### 12/11/25
+   - Add `clear_cached_params()` method to `mp.set_manager_opt_model` and
+     `mp.opt_model`, to clear aggregated parameters cached by the `params()`
+     method.
 
 #### 12/10/25
    - Add support for the Gurobi's new PDHG LP solver in `qps_gurobi()`.

docs/src/MP-Opt-Model-manual/MP-Opt-Model-manual.tex

@@ -3453,6 +3453,13 @@ \subsection{Miscellaneous Methods}
 
 \subsubsection{Public Methods}
 
+\subsubsection*{\code{clear\_cached\_params}}
+\label{sec:clear_cached_params}
+\begin{Code}
+mm.clear_cached_params()
+\end{Code}
+The \code{clear\_cached\_params} method clears any parameters that were cached by the \code{params()} method of each of the set type objects in the \code{var}, \code{lin}, \code{qcn}, and \code{qdc} properties.
+
 \subsubsection*{\code{copy}}
 \label{sec:copy}
 \begin{Code}
@@ -3780,6 +3787,12 @@ \subsubsection{MP Set Manager Math Model Methods}
 
 See the online \href{https://matpower.org/doc/mpom/}{\mpom{} Reference Manual} for the implementing subclass for details.
 
+\subsubsection*{\code{clear\_cached\_params}}
+\begin{Code}
+sm.clear_cached_params()
+\end{Code}
+The \code{clear\_cached\_params} method clears any parameters that were cached by the \code{params()} method.
+
 \subsubsection*{\code{params}}
 \begin{Code}
 [...] = sm.params()
@@ -3872,6 +3885,7 @@ \subsubsection{Methods}
 name & description \\
 \midrule
 \code{get\_set\_types}	& return list of property names of set types managed by this class	\\
+\code{clear\_cached\_params}	& clear cached parameters	\\
 \code{copy}	& duplicate the object	\\
 \code{display}	& displays the object	\\
 \code{display\_soln}	& displays solution values	\\
@@ -6723,6 +6737,7 @@ \subsubsection*{New Features}
 \begin{itemize}
 \item New \code{fix\_integer} option for \code{miqps\_master()} and \code{mp.opt\_model.solve()}. Set to true to fix any integer variables to their initial values, as specified in \code{x0} or \code{opt.x0}.
 \item Add \code{relax\_integer} option to \code{miqps\_master()} and move the implementation from \code{mp.opt\_model.solve()}.
+\item Add \code{clear\_cached\_params()} method to \code{mp.set\_manager\_opt\_model} and \code{mp.opt\_model}, to clear aggregated parameters cached by the \code{params()} method.
 \item Support for the new HiPO interior point LP solver in the \highs{} optimizer.
 \item Support for the new PDHG LP solver in \gurobi{}.
 \item New functions:

lib/+mp/opt_model.m

@@ -31,6 +31,7 @@
 %   * copy - make a duplicate of the object
 %   * to_struct - convert object data *to* a struct
 %   * from_struct - copy object data *from* a struct
+%   * clear_cached_params - clears parameters cached by set type objects
 %   * get_idx - return ``idx`` struct for vars, constraints, costs
 %   * get_userdata - used to retrieve values of user data
 %   * problem_type - return string identifying type of mathematical program
@@ -256,6 +257,24 @@
             end
         end
 
+        function clear_cached_params(obj)
+            % Clear cached parameters.
+            % ::
+            %
+            %   mm.clear_cached_params()
+            %
+            % Clears any parameters that were cached by set types in each of
+            % the  :attr:`var`, :attr:`lin`, :attr:`qcn` and :attr:`qdc`
+            % properties by calling the 
+            % :meth:`clear_cached_params() <mp.set_manager_opt_model.clear_cached_params>`
+            % method on each.
+
+            obj.lin.clear_cached_params();
+            obj.var.clear_cached_params();
+            obj.qcn.clear_cached_params();
+            obj.qdc.clear_cached_params();
+        end
+
         function varargout = get_idx(mm, varargin)
             % Return ``idx`` struct for vars, constraints, costs.
             % ::

lib/+mp/set_manager_opt_model.m

@@ -13,6 +13,7 @@
 % mp.set_manager_opt_model Methods:
 %   * set_manager_opt_model - constructor
 %   * params - *(abstract)* return set-type-specific parameter data
+%   * clear_cached_params - clears parameters cached by params() method
 %   * set_params - *(abstract)* modify set-type-specific parameter data
 %   * display_soln - display solution values
 %   * has_parsed_soln - return true if parsed solution is available
@@ -68,6 +69,21 @@
             % See also mp.set_manager.add, set_params.
         end
 
+        function clear_cached_params(obj)
+            % Clear cached parameters.
+            % ::
+            %
+            %   sm.clear_cached_params()
+            %
+            % For subclasses that cache aggregated parameters in the
+            % :attr:`cache` property, this  method clears that cache, forcing
+            % a rebuild on the next call to params().
+
+            try
+                obj.cache = [];
+            end
+        end
+
         function obj = set_params(obj, name, idx, params, vals)
             % Modify parameter data.
             % ::

lib/+mp/sm_lin_constraint.m

@@ -205,7 +205,7 @@
                 obj.data.vs = subsasgn(obj.data.vs, sc, vs);
             end
             if ~isempty(obj.cache)  %% clear cache of aggregated params
-                obj.cache = [];
+                obj.clear_cached_params();
             end
         end
 
@@ -579,7 +579,7 @@
             end
 
             %% clear cached parameters
-            obj.cache = [];
+            obj.clear_cached_params();
 
             %% update dimensions and indexing, if necessary
             dN = N - N0;

lib/+mp/sm_quad_constraint.m

@@ -264,7 +264,7 @@
                 obj.data.vs = subsasgn(obj.data.vs, sc, vs);
             end
             if ~isempty(obj.cache)  %% clear cache of aggregated params
-                obj.cache = [];
+                obj.clear_cached_params();
             end
         end
 
@@ -588,7 +588,7 @@
             end
 
             %% clear cached parameters
-            obj.cache = [];
+            obj.clear_cached_params();
 
             %% update dimensions and indexing, if necessary
             dMB = MB - MB0;

lib/+mp/sm_quad_cost.m

@@ -255,7 +255,7 @@
                 obj.data.vs = subsasgn(obj.data.vs, sc, vs);
             end
             if ~isempty(obj.cache)  %% clear cache of aggregated params
-                obj.cache = [];
+                obj.clear_cached_params();
             end
         end
 
@@ -599,7 +599,7 @@
             end
 
             %% clear cached parameters
-            obj.cache = [];
+            obj.clear_cached_params();
 
             %% update dimensions and indexing, if necessary
             dN = N - N0;

lib/+mp/sm_quad_cost_legacy.m

@@ -238,7 +238,7 @@
                 obj.data.vs = subsasgn(obj.data.vs, sc, vs);
             end
             if ~isempty(obj.cache)  %% clear cache of aggregated params
-                obj.cache = [];
+                obj.clear_cached_params();
             end
         end
 
@@ -590,7 +590,7 @@
             end
 
             %% clear cached parameters
-            obj.cache = [];
+            obj.clear_cached_params();
 
             %% update dimensions and indexing, if necessary
             dN = N - N0;

lib/+mp/sm_variable.m

@@ -174,7 +174,7 @@
                 obj.data.vt = subsasgn(obj.data.vt, sc, vt);    %% variable type
             end
             if ~isempty(obj.cache)  %% clear cache of aggregated params
-                obj.cache = [];
+                obj.clear_cached_params();
             end
         end
 
@@ -465,7 +465,7 @@
             end
 
             %% clear cached parameters
-            obj.cache = [];
+            obj.clear_cached_params();
 
             %% update dimensions and indexing, if necessary
             dN = N - N0;

lib/mpomver.m

@@ -26,7 +26,7 @@
 v = struct( 'Name',     'MP-Opt-Model', ...
             'Version',  '5.1-dev', ...
             'Release',  '', ...
-            'Date',     '10-Dec-2025' );
+            'Date',     '11-Dec-2025' );
 if nargout > 0
     if nargin > 0
         rv = v;