mpoption_info_linprog

MPOPTION_INFO_LINPROG  Returns MATPOWER option info for LINPROG.

   DEFAULT_OPTS = MPOPTION_INFO_LINPROG('D')
   VALID_OPTS   = MPOPTION_INFO_LINPROG('V')
   EXCEPTIONS   = MPOPTION_INFO_LINPROG('E')

   Returns a structure for LINPROG options for MATPOWER containing ...
   (1) default options,
   (2) valid options, or
   (3) NESTED_STRUCT_COPY exceptions for setting options
   ... depending on the value of the input argument.

   This function is used by MPOPTION to set default options, check validity
   of option names or modify option setting/copying behavior for this
   subset of optional MATPOWER options.

   See also MPOPTION.

0001 function opt = mpoption_info_linprog(selector)
0002 %MPOPTION_INFO_LINPROG  Returns MATPOWER option info for LINPROG.
0003 %
0004 %   DEFAULT_OPTS = MPOPTION_INFO_LINPROG('D')
0005 %   VALID_OPTS   = MPOPTION_INFO_LINPROG('V')
0006 %   EXCEPTIONS   = MPOPTION_INFO_LINPROG('E')
0007 %
0008 %   Returns a structure for LINPROG options for MATPOWER containing ...
0009 %   (1) default options,
0010 %   (2) valid options, or
0011 %   (3) NESTED_STRUCT_COPY exceptions for setting options
0012 %   ... depending on the value of the input argument.
0013 %
0014 %   This function is used by MPOPTION to set default options, check validity
0015 %   of option names or modify option setting/copying behavior for this
0016 %   subset of optional MATPOWER options.
0017 %
0018 %   See also MPOPTION.
0019 
0020 %   MATPOWER
0021 %   $Id: mpoption_info_linprog.m 2434 2014-12-03 14:55:52Z ray $
0022 %   by Ray Zimmerman, PSERC Cornell
0023 %   Copyright (c) 2014 by Power System Engineering Research Center (PSERC)
0024 %
0025 %   This file is part of MATPOWER.
0026 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0027 %
0028 %   MATPOWER is free software: you can redistribute it and/or modify
0029 %   it under the terms of the GNU General Public License as published
0030 %   by the Free Software Foundation, either version 3 of the License,
0031 %   or (at your option) any later version.
0032 %
0033 %   MATPOWER is distributed in the hope that it will be useful,
0034 %   but WITHOUT ANY WARRANTY; without even the implied warranty of
0035 %   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0036 %   GNU General Public License for more details.
0037 %
0038 %   You should have received a copy of the GNU General Public License
0039 %   along with MATPOWER. If not, see <http://www.gnu.org/licenses/>.
0040 %
0041 %   Additional permission under GNU GPL version 3 section 7
0042 %
0043 %   If you modify MATPOWER, or any covered work, to interface with
0044 %   other modules (such as MATLAB code and MEX-files) available in a
0045 %   MATLAB(R) or comparable environment containing parts covered
0046 %   under other licensing terms, the licensors of MATPOWER grant
0047 %   you additional permission to convey the resulting work.
0048 
0049 if nargin < 1
0050     selector = 'D';
0051 end
0052 if have_fcn('linprog')
0053     switch upper(selector)
0054         case {'D', 'V'}     %% default and valid options
0055             opt = struct(...
0056                 'linprog',  [] ...
0057             );
0058         case 'E'            %% exceptions used by nested_struct_copy() for applying
0059             opt = struct(...
0060                 'name',         { 'linprog' }, ...
0061                 'check',        0, ...
0062                 'copy_mode',    { '' } ...
0063                 );
0064         otherwise
0065             error('mpoption_info_linprog: ''%s'' is not a valid input argument', selector);
0066     end
0067 else
0068     opt = struct([]);       %% LINPROG is not available
0069 end