octave: liboctave/numeric/oct-spparms.h annotate

annotate liboctave/numeric/oct-spparms.h @ 29358:0a5b15007766 stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021.

author	John W. Eaton <jwe@octave.org>
date	Wed, 10 Feb 2021 09:52:15 -0500
parents	bd51beb6205e
children	df2cdf42a909

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	3 // Copyright (C) 1998-2021 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_oct_spparms_h)
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	27 #define octave_oct_spparms_h 1
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	30
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	31 #include <iosfwd>
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23220 diff changeset	32 #include <string>
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	33
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	34 #include "str-vec.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	35 #include "dColVector.h"
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23220 diff changeset	36
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23220 diff changeset	37 class NDArray;
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	38
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7017 diff changeset	39 #define OCTAVE_SPARSE_CONTROLS_SIZE 13
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	40
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	41 class
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5893 diff changeset	42 OCTAVE_API
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	43 octave_sparse_params
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	44 {
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	45 protected:
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	46
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	47 octave_sparse_params (void)
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	48 : params (OCTAVE_SPARSE_CONTROLS_SIZE),
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	49 keys (OCTAVE_SPARSE_CONTROLS_SIZE)
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	50 {
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	51 init_keys ();
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	52 do_defaults ();
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	53 }
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	54
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	55 public:
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	56
6482 7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	57 octave_sparse_params (const octave_sparse_params& a)
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	58 : params (a.params), keys (a.keys) { }
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	59
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	60 octave_sparse_params& operator = (const octave_sparse_params& a)
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	61 {
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	62 if (&a != this)
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	63 {
10312 cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	64 params = a.params;
cbc402e64d83 untabify liboctave header files John W. Eaton <jwe@octave.org> parents: 10158 diff changeset	65 keys = a.keys;
6482 7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	66 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	67
6482 7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	68 return *this;
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	69 }
7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	70
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	71 ~octave_sparse_params (void) = default;
6482 7e958a1532c6 [project @ 2007-04-04 02:37:07 by jwe] jwe parents: 6460 diff changeset	72
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	73 static bool instance_ok (void);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	74
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	75 static void defaults (void);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	76
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	77 static void tight (void);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	79 static string_vector get_keys (void);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	80
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	81 static ColumnVector get_vals (void);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	82
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	83 static bool set_vals (const NDArray& vals);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	84
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	85 static bool set_key (const std::string& key, const double& val);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	86
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	87 static double get_key (const std::string& key);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	88
6460 fa6312d93730 [project @ 2007-03-26 21:23:00 by dbateman] dbateman parents: 6108 diff changeset	89 static double get_bandden (void);
fa6312d93730 [project @ 2007-03-26 21:23:00 by dbateman] dbateman parents: 6108 diff changeset	90
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	91 static void print_info (std::ostream& os, const std::string& prefix);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	92
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	93 private:
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	94
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	95 ColumnVector params;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	96
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	97 string_vector keys;
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	98
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	99 static octave_sparse_params *instance;
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	100
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23475 diff changeset	101 static void cleanup_instance (void) { delete instance; instance = nullptr; }
13983 7dd7cccf0757 clean up memory allocated for singletons before exit John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	102
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	103 void do_defaults (void);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	104
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	105 void do_tight (void);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	106
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	107 string_vector do_get_keys (void) const { return keys; }
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	108
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	109 ColumnVector do_get_vals (void) const { return params; }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	110
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	111 bool do_set_vals (const NDArray& vals);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	112
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	113 bool do_set_key (const std::string& key, const double& val);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	114
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	115 double do_get_key (const std::string& key);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	116
6460 fa6312d93730 [project @ 2007-03-26 21:23:00 by dbateman] dbateman parents: 6108 diff changeset	117 double do_get_bandden (void);
fa6312d93730 [project @ 2007-03-26 21:23:00 by dbateman] dbateman parents: 6108 diff changeset	118
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	119 void do_print_info (std::ostream& os, const std::string& prefix) const;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	120
5893 d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	121 void init_keys (void);
d73ffe42f2c8 [project @ 2006-07-16 07:48:19 by jwe] jwe parents: 5307 diff changeset	122 };
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	123
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	124 #endif

Mercurial > octave

annotate liboctave/numeric/oct-spparms.h @ 29358:0a5b15007766 stable