Mercurial > octave-antonio
view libinterp/octave-value/ov-cx-mat.h @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 09ed6f7538dd |
children |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton Copyright (C) 2009-2010 VZLU Prague 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/>. */ #if !defined (octave_ov_cx_mat_h) #define octave_ov_cx_mat_h 1 #include <cstdlib> #include <iosfwd> #include <string> #include "mx-base.h" #include "str-vec.h" #include "error.h" #include "oct-stream.h" #include "ov-base.h" #include "ov-base-mat.h" #include "ov-typeinfo.h" #include "MatrixType.h" class octave_value_list; class tree_walker; // Complex matrix values. class OCTINTERP_API octave_complex_matrix : public octave_base_matrix<ComplexNDArray> { public: octave_complex_matrix (void) : octave_base_matrix<ComplexNDArray> () { } octave_complex_matrix (const ComplexNDArray& m) : octave_base_matrix<ComplexNDArray> (m) { } octave_complex_matrix (const ComplexMatrix& m) : octave_base_matrix<ComplexNDArray> (m) { } octave_complex_matrix (const ComplexMatrix& m, const MatrixType& t) : octave_base_matrix<ComplexNDArray> (m, t) { } octave_complex_matrix (const Array<Complex>& m) : octave_base_matrix<ComplexNDArray> (ComplexNDArray (m)) { } octave_complex_matrix (const ComplexDiagMatrix& d) : octave_base_matrix<ComplexNDArray> (ComplexMatrix (d)) { } octave_complex_matrix (const ComplexRowVector& v) : octave_base_matrix<ComplexNDArray> (ComplexMatrix (v)) { } octave_complex_matrix (const ComplexColumnVector& v) : octave_base_matrix<ComplexNDArray> (ComplexMatrix (v)) { } octave_complex_matrix (const octave_complex_matrix& cm) : octave_base_matrix<ComplexNDArray> (cm) { } ~octave_complex_matrix (void) { } octave_base_value *clone (void) const { return new octave_complex_matrix (*this); } octave_base_value *empty_clone (void) const { return new octave_complex_matrix (); } type_conv_info numeric_demotion_function (void) const; octave_base_value *try_narrowing_conversion (void); builtin_type_t builtin_type (void) const { return btyp_complex; } bool is_complex_matrix (void) const { return true; } bool is_complex_type (void) const { return true; } bool is_double_type (void) const { return true; } bool is_float_type (void) const { return true; } double double_value (bool = false) const; float float_value (bool = false) const; double scalar_value (bool frc_str_conv = false) const { return double_value (frc_str_conv); } float float_scalar_value (bool frc_str_conv = false) const { return float_value (frc_str_conv); } NDArray array_value (bool = false) const; Matrix matrix_value (bool = false) const; FloatMatrix float_matrix_value (bool = false) const; Complex complex_value (bool = false) const; FloatComplex float_complex_value (bool = false) const; ComplexMatrix complex_matrix_value (bool = false) const; FloatComplexMatrix float_complex_matrix_value (bool = false) const; ComplexNDArray complex_array_value (bool = false) const { return matrix; } FloatComplexNDArray float_complex_array_value (bool = false) const; boolNDArray bool_array_value (bool warn = false) const; charNDArray char_array_value (bool frc_str_conv = false) const; SparseMatrix sparse_matrix_value (bool = false) const; SparseComplexMatrix sparse_complex_matrix_value (bool = false) const; octave_value diag (octave_idx_type k = 0) const; octave_value diag (octave_idx_type m, octave_idx_type n) const; void increment (void) { matrix += Complex (1.0); } void decrement (void) { matrix -= Complex (1.0); } void changesign (void) { matrix.changesign (); } bool save_ascii (std::ostream& os); bool load_ascii (std::istream& is); bool save_binary (std::ostream& os, bool& save_as_floats); bool load_binary (std::istream& is, bool swap, oct_mach_info::float_format fmt); bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); bool load_hdf5 (octave_hdf5_id loc_id, const char *name); int write (octave_stream& os, int block_size, oct_data_conv::data_type output_type, int skip, oct_mach_info::float_format flt_fmt) const { // Yes, for compatibility, we drop the imaginary part here. return os.write (matrix_value (true), block_size, output_type, skip, flt_fmt); } void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; mxArray *as_mxArray (void) const; octave_value map (unary_mapper_t umap) const; private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; #endif