Home > src > validateProbability.m

# validateProbability

## PURPOSE

- helper function to validate that a string represents a probability

## SYNOPSIS

function flag = validateProbability(strNum,errmsg,errtitle)

## DESCRIPTION

     - helper function to validate that a string represents a probability

     copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut

        This file is part of SOS

        SOS is free software: you can redistribute it and/or modify
        it for academic and non-commercial purposes
        under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.  For commercial or for-profit
        uses, please contact the authors (sos@cnbc.cmu.edu).

        SOS is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

## CROSS-REFERENCE INFORMATION

This function calls:

This function is called by:

- create2samplettest_Dialog - create 2-sample t-test dialog
- createMatchCorrelztest_Dialog - create correlation-matching z-test dialog
- createMatchUniformkstest_Dialog - create uniformity ks-test dialog
- createsinglesamplettest_Dialog - create single sample t-test dialog
- expAnneal_Dialog - create expAnneal dialog
- numSteps_Dialog dialog used to calculate the nubmer of temperature-lowering steps

## SOURCE CODE

    0001 % - helper function to validate that a string represents a probability
    0002 %
    0003 % copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut
    0004 %
    0005 %    This file is part of SOS
    0006 %
    0007 %    SOS is free software: you can redistribute it and/or modify
    0008 %    it for academic and non-commercial purposes
    0009 %    under the terms of the GNU General Public License as published by
    0010 %    the Free Software Foundation, either version 3 of the License, or
    0011 %    (at your option) any later version.  For commercial or for-profit
    0012 %    uses, please contact the authors (sos@cnbc.cmu.edu).
    0013 %
    0014 %    SOS is distributed in the hope that it will be useful,
    0015 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
    0016 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    0017 %    GNU General Public License for more details.
    0018
    0019 %    You should have received a copy of the GNU General Public License
    0020 %    along with SOS (see COPYING.txt).
    0021 %    If not, see <http://www.gnu.org/licenses/>.
    0022
    0023
    0024 function flag = validateProbability(strNum,errmsg,errtitle)
    0025     % validates that the string represents a propability
    0026
    0027     valid = regexp(strNum,'^[0]?[\.][0-9]+$', 'once');
    0028
    0029
    0030     if isempty(valid)
    0031         % name is not currently valid, tell the user.
    0032         msgbox(errmsg,...
    0033                 errtitle);
    0034        flag = false;
    0035     else
    0036         flag = true;
    0037     end
    0038
    0039
    0040
    0041 end
    0042