oct-spparms.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1998-2023 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 (octave_oct_spparms_h)
#define octave_oct_spparms_h 1
 
#include "octave-config.h"
 
#include <iosfwd>
#include <string>
 
#include "Array-fwd.h"
#include "str-vec.h"
#include "dColVector.h"
 
#define OCTAVE_SPARSE_CONTROLS_SIZE 13
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
class OCTAVE_API sparse_params
{
protected:
 
  sparse_params (void)
    : m_params (OCTAVE_SPARSE_CONTROLS_SIZE),
      m_keys (OCTAVE_SPARSE_CONTROLS_SIZE)
  {
    init_keys ();
    do_defaults ();
  }
 
public:
 
  sparse_params (const sparse_params&) = default;
 
  sparse_params& operator = (const sparse_params&) = default;
 
  ~sparse_params (void) = default;
 
  static bool instance_ok (void);
 
  static void defaults (void);
 
  static void tight (void);
 
  static string_vector get_keys (void);
 
  static ColumnVector get_vals (void);
 
  static bool set_vals (const Array<double>& vals);
 
  static bool set_key (const std::string& key, const double& val);
 
  static double get_key (const std::string& key);
 
  static double get_bandden (void);
 
  static void print_info (std::ostream& os, const std::string& prefix);
 
private:
 
  ColumnVector m_params;
 
  string_vector m_keys;
 
  static sparse_params *s_instance;
 
  static void cleanup_instance (void)
  {
    delete s_instance;
    s_instance = nullptr;
  }
 
  void do_defaults (void);
 
  void do_tight (void);
 
  string_vector do_get_keys (void) const { return m_keys; }
 
  ColumnVector do_get_vals (void) const { return m_params; }
 
  bool do_set_vals (const Array<double>& vals);
 
  bool do_set_key (const std::string& key, const double& val);
 
  double do_get_key (const std::string& key);
 
  double do_get_bandden (void);
 
  void do_print_info (std::ostream& os, const std::string& prefix) const;
 
  void init_keys (void);
};
 
OCTAVE_END_NAMESPACE(octave)
 
#if defined (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS)
OCTAVE_DEPRECATED (7, "use 'octave::sparse_params' instead")
typedef octave::sparse_params octave_sparse_params;
#endif
 
#endif