Mercurial > octave-antonio
view libinterp/octave-value/ov-null-mat.h @ 20163:075a5e2e1ba5 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value,
libinterp/parse-tree directories.
* build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc,
libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc,
libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll,
libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc:
doc: Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 21:52:42 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
/* Copyright (C) 2008-2015 Jaroslav Hajek 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_null_mat_h) #define octave_ov_null_mat_h 1 #include "ov.h" #include "ov-re-mat.h" #include "ov-str-mat.h" // Design rationale: // The constructors are hidden. There is only one null matrix (or null string) // object, that can have shallow copies. Cloning the object returns just a // normal empty matrix, so all the shallow copies are, in fact, read-only. This // conveniently ensures that any attempt to fiddle with the null matrix // destroys its special status. // The special [] value. class OCTINTERP_API octave_null_matrix : public octave_matrix { octave_null_matrix (void) : octave_matrix () { } public: static const octave_value instance; bool is_null_value (void) const { return true; } type_conv_info numeric_conversion_function (void) const; private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; // The special "" value class OCTINTERP_API octave_null_str : public octave_char_matrix_str { octave_null_str (void) : octave_char_matrix_str () { } public: static const octave_value instance; bool is_null_value (void) const { return true; } type_conv_info numeric_conversion_function (void) const; private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; // The special '' value class OCTINTERP_API octave_null_sq_str : public octave_char_matrix_sq_str { octave_null_sq_str (void) : octave_char_matrix_sq_str () { } public: static const octave_value instance; bool is_null_value (void) const { return true; } type_conv_info numeric_conversion_function (void) const; private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; #endif