MATLAB Central Newsreader - Using InputParse for boolean field

Using InputParse for boolean field

elgen — Fri, 27 Aug 2010 15:06:52 +0000

I am trying to add a flag called "debug" as an optional input parameter
to the function. The test function is listed below:

function untitled(a, varargin)
     p = inputParser;
     p.addRequired('a', @isnumeric);
     p.addOptional('debug', 0, @(x)strcmpi(x, 'debug'));
     p.parse(a, varargin{:})
     disp(p.Results)

If i type

>> untitled(3)

        a: 3
     debug: 0

If i type

>> untitled(3, 'debug')

        a: 3
     debug: 'debug'

I want Matlab to place 1 in the debug field, i.e.

>> untitled(3, 'debug')

        a: 3
     debug: 1

Is it possible? Do I need to play with the anonymous function handle?
FYI, matlab doc says that if the Boolean output is true, then MATLAB
accepts the input value. I want to work around this.

Thank you.

Re: Using InputParse for boolean field

Loren Shure — Mon, 30 Aug 2010 11:32:59 +0000

"elgen" <sket16@no.spam.hotmail.com> wrote in message
news:i58kar$hru$1@news.eternal-september.org...
> I am trying to add a flag called "debug" as an optional input parameter to
> the function. The test function is listed below:
>
> function untitled(a, varargin)
> p = inputParser;
> p.addRequired('a', @isnumeric);
> p.addOptional('debug', 0, @(x)strcmpi(x, 'debug'));
> p.parse(a, varargin{:})
> disp(p.Results)
>
>
> If i type
>
> >> untitled(3)
>
> a: 3
> debug: 0
>
>
> If i type
>
> >> untitled(3, 'debug')
>
> a: 3
> debug: 'debug'
>
> I want Matlab to place 1 in the debug field, i.e.
>
> >> untitled(3, 'debug')
>
> a: 3
> debug: 1
>
> Is it possible? Do I need to play with the anonymous function handle? FYI,
> matlab doc says that if the Boolean output is true, then MATLAB accepts
> the input value. I want to work around this.
>
> Thank you.
>
>

I think you're validator is checking for the string debug rather than
validating its value.

--
Loren
http://blogs.mathworks.com/loren/
http://matlabwiki.mathworks.com/MATLAB_FAQ

Re: Using InputParse for boolean field

rmc256 — Fri, 17 Jun 2011 14:38:04 +0000

I'd like to revive this thread, as I don't understand if the original question is possible or not.
Can I make an optional input to the inputParser (addOptional) that will return a 1 if the string is present in the function call, or a 0 if not? If so how? It seems Matlab will always take the string itself to be the value. I would have to pass a 1, but that's not very clear syntax.
If there is not a way to do this, I could do it as a parameter value pair (i.e. untitled(3,'debug',1) ). Seems unnecessary.

Michael

"Loren Shure" <loren.shure@mathworks.com> wrote in message <i5g4tb$j6p$1@fred.mathworks.com>...
>
> "elgen" <sket16@no.spam.hotmail.com> wrote in message
> news:i58kar$hru$1@news.eternal-september.org...
> > I am trying to add a flag called "debug" as an optional input parameter to
> > the function. The test function is listed below:
> >
> > function untitled(a, varargin)
> > p = inputParser;
> > p.addRequired('a', @isnumeric);
> > p.addOptional('debug', 0, @(x)strcmpi(x, 'debug'));
> > p.parse(a, varargin{:})
> > disp(p.Results)
> >
> >
> > If i type
> >
> > >> untitled(3)
> >
> > a: 3
> > debug: 0
> >
> >
> > If i type
> >
> > >> untitled(3, 'debug')
> >
> > a: 3
> > debug: 'debug'
> >
> > I want Matlab to place 1 in the debug field, i.e.
> >
> > >> untitled(3, 'debug')
> >
> > a: 3
> > debug: 1
> >
> > Is it possible? Do I need to play with the anonymous function handle? FYI,
> > matlab doc says that if the Boolean output is true, then MATLAB accepts
> > the input value. I want to work around this.
> >
> > Thank you.
> >
> >
>
>
> I think you're validator is checking for the string debug rather than
> validating its value.
>
> --
> Loren
> http://blogs.mathworks.com/loren/
> http://matlabwiki.mathworks.com/MATLAB_FAQ

Re: Using InputParse for boolean field

Maria — Mon, 23 Apr 2012 22:36:07 +0000

"rmc256" wrote in message <itfosc$phe$1@newscl01ah.mathworks.com>...
> I'd like to revive this thread, as I don't understand if the original question is possible or not.
> Can I make an optional input to the inputParser (addOptional) that will return a 1 if the string is present in the function call, or a 0 if not? If so how? It seems Matlab will always take the string itself to be the value. I would have to pass a 1, but that's not very clear syntax.
> If there is not a way to do this, I could do it as a parameter value pair (i.e. untitled(3,'debug',1) ). Seems unnecessary.
>
> Michael
>
>
> "Loren Shure" <loren.shure@mathworks.com> wrote in message <i5g4tb$j6p$1@fred.mathworks.com>...
> >
> > "elgen" <sket16@no.spam.hotmail.com> wrote in message
> > news:i58kar$hru$1@news.eternal-september.org...
> > > I am trying to add a flag called "debug" as an optional input parameter to
> > > the function. The test function is listed below:
> > >
> > > function untitled(a, varargin)
> > > p = inputParser;
> > > p.addRequired('a', @isnumeric);
> > > p.addOptional('debug', 0, @(x)strcmpi(x, 'debug'));
> > > p.parse(a, varargin{:})
> > > disp(p.Results)
> > >
> > >
> > > If i type
> > >
> > > >> untitled(3)
> > >
> > > a: 3
> > > debug: 0
> > >
> > >
> > > If i type
> > >
> > > >> untitled(3, 'debug')
> > >
> > > a: 3
> > > debug: 'debug'
> > >
> > > I want Matlab to place 1 in the debug field, i.e.
> > >
> > > >> untitled(3, 'debug')
> > >
> > > a: 3
> > > debug: 1
> > >
> > > Is it possible? Do I need to play with the anonymous function handle? FYI,
> > > matlab doc says that if the Boolean output is true, then MATLAB accepts
> > > the input value. I want to work around this.
> > >
> > > Thank you.
> > >
> > >
> >
> >
> > I think you're validator is checking for the string debug rather than
> > validating its value.
> >
> > --
> > Loren
> > http://blogs.mathworks.com/loren/
> > http://matlabwiki.mathworks.com/MATLAB_FAQ

If you want 'debug' to be a boolean variable, why not do this:

function untitled(a, varargin)
p = inputParser;
p.addRequired('a', @isnumeric);
p.addParamValue('debug',false,@islogical);
p.parse(a, varargin{:})
disp(p.Results)

Then
>> untitled(3)
        a: 3
    debug: 0

>> untitled(3,'debug',true)
        a: 3
    debug: 1