GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
oct-spparms.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 2004-2013 David Bateman
4 Copyright (C) 1998-2004 Andy Adler
5 
6 This file is part of Octave.
7 
8 Octave is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 3 of the License, or (at your
11 option) any later version.
12 
13 Octave is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
17 
18 You should have received a copy of the GNU General Public License
19 along with Octave; see the file COPYING. If not, see
20 <http://www.gnu.org/licenses/>.
21 
22 */
23 
24 #if !defined (octave_oct_spparms_h)
25 #define octave_oct_spparms_h 1
26 
27 #include <cassert>
28 #include <cstddef>
29 
30 #include <iosfwd>
31 
32 #include "str-vec.h"
33 #include "dColVector.h"
34 #include "dNDArray.h"
35 
36 #define OCTAVE_SPARSE_CONTROLS_SIZE 13
37 
38 class
39 OCTAVE_API
41 {
42 protected:
43 
45  : params (OCTAVE_SPARSE_CONTROLS_SIZE),
47  {
48  init_keys ();
49  do_defaults ();
50  }
51 
52 public:
53 
55  : params (a.params), keys (a.keys) { }
56 
58  {
59  if (&a != this)
60  {
61  params = a.params;
62  keys = a.keys;
63  }
64 
65  return *this;
66  }
67 
69 
70  static bool instance_ok (void);
71 
72  static void defaults (void);
73 
74  static void tight (void);
75 
76  static string_vector get_keys (void);
77 
78  static ColumnVector get_vals (void);
79 
80  static bool set_vals (const NDArray& vals);
81 
82  static bool set_key (const std::string& key, const double& val);
83 
84  static double get_key (const std::string& key);
85 
86  static double get_bandden (void);
87 
88  static void print_info (std::ostream& os, const std::string& prefix);
89 
90 private:
91 
93 
95 
97 
98  static void cleanup_instance (void) { delete instance; instance = 0; }
99 
100  void do_defaults (void);
101 
102  void do_tight (void);
103 
104  string_vector do_get_keys (void) const { return keys; }
105 
106  ColumnVector do_get_vals (void) const { return params; }
107 
108  bool do_set_vals (const NDArray& vals);
109 
110  bool do_set_key (const std::string& key, const double& val);
111 
112  double do_get_key (const std::string& key);
113 
114  double do_get_bandden (void);
115 
116  void do_print_info (std::ostream& os, const std::string& prefix) const;
117 
118  void init_keys (void);
119 };
120 
121 #endif