annotate libinterp/octave-value/ov-int64.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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
1 /*
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
2
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 15215
diff changeset
3 Copyright (C) 2004-2013 John W. Eaton
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
4
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
6
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
10 option) any later version.
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
11
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
15 for more details.
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
16
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
19 <http://www.gnu.org/licenses/>.
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
20
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
21 */
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
22
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
23 #ifdef HAVE_CONFIG_H
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
24 #include <config.h>
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
25 #endif
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
26
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
27 #include <iostream>
15215
9020dddc925a use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
28 #include <limits>
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
29
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
30 #include "lo-ieee.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
31 #include "lo-utils.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
32 #include "mx-base.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
33 #include "quit.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
34
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
35 #include "defun.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
36 #include "gripes.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
37 #include "oct-obj.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
38 #include "oct-lvalue.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
39 #include "ops.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
40 #include "ov-base.h"
4917
f69e95587ba3 [project @ 2004-07-27 14:03:03 by jwe]
jwe
parents: 4901
diff changeset
41
f69e95587ba3 [project @ 2004-07-27 14:03:03 by jwe]
jwe
parents: 4901
diff changeset
42 #ifdef HAVE_HDF5
f69e95587ba3 [project @ 2004-07-27 14:03:03 by jwe]
jwe
parents: 4901
diff changeset
43 #define HDF5_SAVE_TYPE H5T_NATIVE_INT64
f69e95587ba3 [project @ 2004-07-27 14:03:03 by jwe]
jwe
parents: 4901
diff changeset
44 #endif
f69e95587ba3 [project @ 2004-07-27 14:03:03 by jwe]
jwe
parents: 4901
diff changeset
45
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
46 #include "ov-base-int.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
47 #include "ov-base-int.cc"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
48 #include "ov-int64.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
49 #include "ov-type-conv.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
50 #include "pr-output.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
51 #include "variables.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
52
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
53 #include "byte-swap.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
54 #include "ls-oct-ascii.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
55 #include "ls-utils.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
56 #include "ls-hdf5.h"
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
57
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
58 template class octave_base_matrix<int64NDArray>;
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
59
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
60 template class octave_base_int_matrix<int64NDArray>;
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
61
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
62 DEFINE_OCTAVE_ALLOCATOR (octave_int64_matrix);
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
63
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
64 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_int64_matrix,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
65 "int64 matrix", "int64");
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
66
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
67 template class octave_base_scalar<octave_int64>;
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
68
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
69 template class octave_base_int_scalar<octave_int64>;
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
70
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
71 DEFINE_OCTAVE_ALLOCATOR (octave_int64_scalar);
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
72
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
73 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_int64_scalar,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
74 "int64 scalar", "int64");
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
75
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
76 DEFUN (int64, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
77 "-*- texinfo -*-\n\
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
78 @deftypefn {Built-in Function} {} int64 (@var{x})\n\
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
79 Convert @var{x} to 64-bit integer type.\n\
18533
ea0d4dea1a17 doc: Update documentation for functions in octave-value dir.
Rik <rik@octave.org>
parents: 17787
diff changeset
80 @seealso{int8, uint8, int16, uint16, int32, uint32, uint64}\n\
4901
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
81 @end deftypefn")
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
82 {
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
83 OCTAVE_TYPE_CONV_BODY (int64);
35bfb4e0b96b [project @ 2004-06-14 18:33:02 by jwe]
jwe
parents:
diff changeset
84 }
12808
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
85
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
86 /*
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
87 %!assert (class (int64 (1)), "int64")
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
88 %!assert (int64 (1.25), int64 (1))
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
89 %!assert (int64 (1.5), int64 (2))
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
90 %!assert (int64 (-1.5), int64 (-2))
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
91 %!assert (int64 (2^65), int64 (2^64-1))
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
92 %!assert (int64 (-2^65), int64 (-2^64))
1a3cdafcb2a5 codesprint: Tests for [u]int[8,16,32,64] functions
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
93 */