Mercurial > octave-nkf
view libinterp/octave-value/ov-int16.cc @ 18533:ea0d4dea1a17 stable
doc: Update documentation for functions in octave-value dir.
* ov-bool-mat.cc (Flogical): Document that input must be numeric.
Document incompatibility with Matlab regarding complex inputs.
* ov-cell.cc (Fcell): Add seealso references.
* ov-cell.cc (Fcellstr): Document that trailing spaces are trimmed.
Add seealso references.
* ov-cell.cc (Fstruct2cell): Use lowercase names in @var references.
* ov-class.cc (Fismethod): Add seealso reference to isprop.
* ov-class.cc (Fsuperiorto): Add seealso reference to inferiorto.
* ov-class.cc (Finferiorto): Add seealso reference to superiorto.
* ov-fcn-handle.cc (Ffunctions): Add table to documentation describing return
values.
* ov-fcn-handle.cc (Ffunc2str): Add seealso links to str2func, functions.
* ov-fcn-handle.cc (Fstr2func): Add seealso links to func2str, inline.
* ov-fcn-handle.cc (Fis_function_handle): Add seealso links to functions.
* ov-fcn-inline.cc (Finline): Add note that the use of inline is discouraged.
Add seealso link to str2func.
* ov-int16.cc (Fint16): Add seealso links to docstring.
* ov-int32.cc (Fint32): Add seealso links to docstring.
* ov-int64.cc (Fint64): Add seealso links to docstring.
* ov-int8.cc (Fint8): Add seealso links to docstring.
* ov-oncleanup.cc (FonCleanup): clarify docstring by using "function" rather
than "action" for what gets called when onCleanup object is destroyed.
* ov-struct.cc (Fstruct): Add additional calling forms. Add seealso links.
* ov-struct.cc (Fisfield): Add additional calling forms. Add seealso link.
* ov-struct.cc (Fnfields): Add seealso link.
* ov-struct.cc (Fcell2struct): Add additional calling forms. Add seealso link.
* ov-struct.cc (Frmfield): Emphasize that a copy of the struct is returned.
Add seealso link.
* ov-struct.cc (Fstruct_levels_to_print): Add seealso link to
print_struct_array_contents.
* ov-struct.cc (Fprint_struct_array_contents): Add seealso link to
struct_levels_to_print.
* ov-typeinfo.cc (Ftypeinfo): Add seealso links to class, isa.
* ov-uint16.cc (Fuint16): Add seealso links to docstring.
* ov-uint32.cc (Fuint32): Add seealso links to docstring.
* ov-uint64.cc (Fuint64): Add seealso links to docstring.
* ov-uint8.cc (Fuint8): Add seealso links to docstring.
* ov-usr-fcn.cc (Fnargin): Add example based on 'union' function.
* ov-usr-fcn.cc (Fnargout): Add example based on 'imread' function.
* ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring.
* ov.cc (Fsubsref): Rephrase one sentence.
* fieldnames.m: Add more functions to seealso links.
* getfield.m: Re-order seealso links.
* setfield.m: Re-order seealso links.
* isprop.m Add ismethod, isobject to seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 01 Mar 2014 21:50:13 -0800 |
parents | 175b392e91fe |
children | 76478d2da117 |
line wrap: on
line source
/* Copyright (C) 2004-2013 John W. Eaton This file is part of Octave. Octave 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 3 of the License, or (at your option) any later version. Octave 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 Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include <iostream> #include <limits> #include "lo-ieee.h" #include "lo-utils.h" #include "mx-base.h" #include "quit.h" #include "defun.h" #include "gripes.h" #include "oct-obj.h" #include "oct-lvalue.h" #include "ops.h" #include "ov-base.h" #ifdef HAVE_HDF5 #define HDF5_SAVE_TYPE H5T_NATIVE_INT16 #endif #include "ov-base-int.h" #include "ov-base-int.cc" #include "ov-int16.h" #include "ov-type-conv.h" #include "pr-output.h" #include "variables.h" #include "byte-swap.h" #include "ls-oct-ascii.h" #include "ls-utils.h" #include "ls-hdf5.h" template class octave_base_matrix<int16NDArray>; template class octave_base_int_matrix<int16NDArray>; DEFINE_OCTAVE_ALLOCATOR (octave_int16_matrix); DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_int16_matrix, "int16 matrix", "int16"); template class octave_base_scalar<octave_int16>; template class octave_base_int_scalar<octave_int16>; DEFINE_OCTAVE_ALLOCATOR (octave_int16_scalar); DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_int16_scalar, "int16 scalar", "int16"); DEFUN (int16, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} int16 (@var{x})\n\ Convert @var{x} to 16-bit integer type.\n\ @seealso{int8, uint8, uint16, int32, uint32, int64, uint64}\n\ @end deftypefn") { OCTAVE_TYPE_CONV_BODY (int16); } /* %!assert (class (int16 (1)), "int16") %!assert (int16 (1.25), int16 (1)) %!assert (int16 (1.5), int16 (2)) %!assert (int16 (-1.5), int16 (-2)) %!assert (int16 (2^17), int16 (2^16-1)) %!assert (int16 (-2^17), int16 (-2^16)) */