Home > matpower7.0 > lib > @opt_model > getv.m

getv

PURPOSE ^

GETV Returns initial value, lower bound and upper bound for opt variables.

SYNOPSIS ^

function varargout = getv(om, varargin)

DESCRIPTION ^

GETV  Returns initial value, lower bound and upper bound for opt variables.

   -----  DEPRECATED - Please use PARAMS_VAR instead  -----

   [V0, VL, VU] = OM.GETV()
   [V0, VL, VU] = OM.GETV(NAME)
   [V0, VL, VU] = OM.GETV(NAME, IDX)
   [V0, VL, VU, VT] = GETV(...)
   Returns the initial value V0, lower bound VL and upper bound VU for
   the full optimization variable vector, or for a specific named or named
   and indexed variable set. Optionally also returns a corresponding char
   vector VT of variable types, where 'C', 'I' and 'B' represent continuous
   integer and binary variables, respectively.

   Examples:
       [x, xmin, xmax] = om.getv();
       [Pg, Pmin, Pmax] = om.getv('Pg');
       [zij0, zijmin, zijmax, ztype] = om.getv('z', {i, j});
   
   See also OPT_MODEL, PARAMS_VAR.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function varargout = getv(om, varargin)
0002 %GETV  Returns initial value, lower bound and upper bound for opt variables.
0003 %
0004 %   -----  DEPRECATED - Please use PARAMS_VAR instead  -----
0005 %
0006 %   [V0, VL, VU] = OM.GETV()
0007 %   [V0, VL, VU] = OM.GETV(NAME)
0008 %   [V0, VL, VU] = OM.GETV(NAME, IDX)
0009 %   [V0, VL, VU, VT] = GETV(...)
0010 %   Returns the initial value V0, lower bound VL and upper bound VU for
0011 %   the full optimization variable vector, or for a specific named or named
0012 %   and indexed variable set. Optionally also returns a corresponding char
0013 %   vector VT of variable types, where 'C', 'I' and 'B' represent continuous
0014 %   integer and binary variables, respectively.
0015 %
0016 %   Examples:
0017 %       [x, xmin, xmax] = om.getv();
0018 %       [Pg, Pmin, Pmax] = om.getv('Pg');
0019 %       [zij0, zijmin, zijmax, ztype] = om.getv('z', {i, j});
0020 %
0021 %   See also OPT_MODEL, PARAMS_VAR.
0022 
0023 %   MATPOWER
0024 %   Copyright (c) 2008-2016, Power Systems Engineering Research Center (PSERC)
0025 %   by Ray Zimmerman, PSERC Cornell
0026 %
0027 %   This file is part of MATPOWER.
0028 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0029 %   See https://matpower.org for more info.
0030 
0031 [varargout{1:nargout}] = om.params_var(varargin{:});

Generated on Mon 24-Jun-2019 15:58:45 by m2html © 2005