Mercurial > octave
view libinterp/octave-value/ov-null-mat.cc @ 29937:da7210e30f3e
move some utility functions inside octave namespace
* lo-utils.h, lo-utils.cc (is_one_or_zero): Rename from
xis_one_or_zero and move inside octave namespace. Change all uses.
(is_zero): Rename from xis_zero and move inside octave namespace.
Change all uses.
(is_int_or_inf_or_nan): Rename from xis_int_or_inf_or_nan and move
inside octave namespace. Change all uses.
(too_large_for_float): Rename from xtoo_large_for_float and move
inside octave namespace. Change all uses.
(too_large_for_float): Rename from xtoo_large_for_float and move
inside octave namespace. Change all uses.
(is_int_or_inf_or_nan): Rename from xis_int_or_inf_or_nan and move
inside octave namespace. Change all uses.
(fgets): Rename from octave_fgets and move inside octave namespace.
Change all uses.
(fgetl): Rename from octave_fgetl and move inside octave namespace.
Change all uses.
(any_all_test, strsave): Move inside octave namespace. Tag uses with
octave:: prefix as needed.
* lo-utils.h: Provide deprecated templates and inline functions to
preserve old names in global namespace.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 03 Aug 2021 12:34:52 -0400 |
parents | 0a5b15007766 |
children | 32c3a5805893 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2008-2021 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // 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 // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "ov-null-mat.h" #include "ops.h" #include "defun.h" DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_null_matrix, "null_matrix", "double"); const octave_value octave_null_matrix::instance (new octave_null_matrix ()); static octave_base_value * default_null_matrix_numeric_conversion_function (const octave_base_value& a) { // The cast is not necessary? // const octave_null_matrix& v = dynamic_cast<const octave_null_matrix&> (a); return a.empty_clone (); } octave_base_value::type_conv_info octave_null_matrix::numeric_conversion_function (void) const { return octave_base_value::type_conv_info (default_null_matrix_numeric_conversion_function, octave_matrix::static_type_id ()); } DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_null_str, "null_string", "char"); const octave_value octave_null_str::instance (new octave_null_str ()); static octave_base_value * default_null_str_numeric_conversion_function (const octave_base_value& a) { // The cast is not necessary? // const octave_null_str& v = dynamic_cast<const octave_null_str&> (a); return a.empty_clone (); } octave_base_value::type_conv_info octave_null_str::numeric_conversion_function (void) const { return octave_base_value::type_conv_info (default_null_str_numeric_conversion_function, octave_char_matrix_str::static_type_id ()); } DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_null_sq_str, "null_sq_string", "char"); const octave_value octave_null_sq_str::instance (new octave_null_sq_str ()); static octave_base_value * default_null_sq_str_numeric_conversion_function (const octave_base_value& a) { // The cast is not necessary? // const octave_null_sq_str& v = dynamic_cast<const octave_null_sq_str&> (a); return a.empty_clone (); } octave_base_value::type_conv_info octave_null_sq_str::numeric_conversion_function (void) const { return octave_base_value::type_conv_info (default_null_sq_str_numeric_conversion_function, octave_char_matrix_sq_str::static_type_id ()); } DEFUN (isnull, args, , doc: /* -*- texinfo -*- @deftypefn {} {} isnull (@var{x}) Return true if @var{x} is a special null matrix, string, or single quoted string. Indexed assignment with such a null value on the right-hand side should delete array elements. This function is used in place of @code{isempty} when overloading the indexed assignment method (@code{subsasgn}) for user-defined classes. @code{isnull} is used to distinguish between these two cases: @code{@var{A}(@var{I}) = []} and @code{@var{X} = []; @var{A}(@var{I}) = @var{X}} In the first assignment, the right-hand side is @code{[]} which is a special null value. As long as the index @var{I} is not empty, this code should delete elements from @var{A} rather than perform assignment. In the second assignment, the right-hand side is empty (because @var{X} is @code{[]}), but it is @strong{not} null. This code should assign the empty value to elements in @var{A}. An example from Octave's built-in char class demonstrates the interpreter behavior when @code{isnull} is used correctly. @example @group str = "Hello World"; nm = "Wally"; str(7:end) = nm # indexed assignment @result{} str = Hello Wally str(7:end) = "" # indexed deletion @result{} str = Hello @end group @end example @seealso{isempty, isindex} @end deftypefn */) { if (args.length () != 1) print_usage (); return ovl (args(0).isnull ()); } /* %!assert (isnull ([]), true) %!assert (isnull ([1]), false) %!assert (isnull (zeros (0,3)), false) %!assert (isnull (""), true) %!assert (isnull ("A"), false) %!assert (isnull (''), true) %!assert (isnull ('A'), false) %!test %! x = []; %! assert (isnull (x), false); */