octave_packages/fixed-0.7.10/float.m

   1 ## Copyright (C) 2003  Motorola Inc
   2 ## Copyright (C) 2003  David Bateman
   3 ##
   4 ## This program is free software; you can redistribute it and/or modify
   5 ## it under the terms of the GNU General Public License as published by
   6 ## the Free Software Foundation; either version 2 of the License, or
   7 ## (at your option) any later version.
   8 ##
   9 ## This program is distributed in the hope that it will be useful,
  10 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 ## GNU General Public License for more details.
  13 ##
  14 ## You should have received a copy of the GNU General Public License
  15 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
  16
  17 ## -*- texinfo -*-
  18 ## @deftypefn {Function File} {@var{y} =} float (@var{x})
  19 ## Converts a fixed point object to the equivalent floating point object. This
  20 ## is equivalent to @code{@var{x}.x} if @code{isfixed(@var{x})} returns true,
  21 ## and returns @var{x} otherwise.
  22 ## @end deftypefn
  23
  24 function y = float (x)
  25
  26   if isfixed(x)
  27     y = x.x;
  28   else
  29     y = x;
  30   endif
  31
  32 endfunction