Logo Search packages:      
Sourcecode: octave-nnet version File versions  Download package

isposint.m

## Copyright (C) 2005 Michel D. Schmid  <michaelschmid@users.sourceforge.net>
##
##
## This program is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2, or (at your option)
## any later version.
##
## This program 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.
##
## You should have received a copy of the GNU General Public License
## along with this program; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} @var{f} = isposint(@var{n})
## @code{isposint} returns true for positive integer values.
## 
## @example
##   isposint(1)   # this returns TRUE
##   isposint(0.5) # this returns FALSE
##   isposint(0)   # this also return FALSE
##   isposint(-1)  # this also returns FALSE
## @end example
##
## 
## @end deftypefn

## Author: Michel D. Schmid 

function f = isposint(n)

  ## check range of input arguments
  error(nargchk(1,1,nargin))
  
  ## check input arg
  if (length(n)>1)
    error("Input argument must not be a vector, only scalars are allowed!")
  endif

  f = 1;
  if ( (!isreal(n)) | (n<=0) | (round(n) != n) )
    f = 0;
  endif


endfunction

%!shared
%! disp("testing isposint")
%!assert(isposint(1)) # this should pass
%!assert(isposint(0.5),0) # should return zero
%!assert(isposint(-1),0) # should return zero
%!assert(isposint(-1.5),0) # should return zero
%!assert(isposint(0),0) # should return zero
%!fail("isposint([0 0])","Input argument must not be a vector, only scalars are allowed!")
%!fail("isposint('testString')","Input argument must not be a vector, only scalars are allowed!")


Generated by  Doxygen 1.6.0   Back to index