octave_sparse_params Class Reference

#include "oct-spparms.h"

Collaboration diagram for octave_sparse_params:

Public Member Functions
	octave_sparse_params (const octave_sparse_params &a)
	~octave_sparse_params (void)=default
octave_sparse_params &	operator= (const octave_sparse_params &a)

Static Public Member Functions
static void	defaults (void)
static double	get_bandden (void)
static double	get_key (const std::string &key)
static string_vector	get_keys (void)
static ColumnVector	get_vals (void)
static bool	instance_ok (void)
static void	print_info (std::ostream &os, const std::string &prefix)
static bool	set_key (const std::string &key, const double &val)
static bool	set_vals (const NDArray &vals)
static void	tight (void)

Protected Member Functions
	octave_sparse_params (void)

Private Member Functions
void	do_defaults (void)
double	do_get_bandden (void)
double	do_get_key (const std::string &key)
string_vector	do_get_keys (void) const
ColumnVector	do_get_vals (void) const
void	do_print_info (std::ostream &os, const std::string &prefix) const
bool	do_set_key (const std::string &key, const double &val)
bool	do_set_vals (const NDArray &vals)
void	do_tight (void)
void	init_keys (void)

Static Private Member Functions
static void	cleanup_instance (void)

Private Attributes
string_vector	keys
ColumnVector	params

Static Private Attributes
static octave_sparse_params *	instance = nullptr

Detailed Description

Definition at line 41 of file oct-spparms.h.

Constructor & Destructor Documentation

octave_sparse_params() [1/2]

octave_sparse_params::octave_sparse_params ( void  )

inlineprotected

Definition at line 47 of file oct-spparms.h.

Referenced by instance_ok().

octave_sparse_params() [2/2]

octave_sparse_params::octave_sparse_params ( const octave_sparse_params &  a )

inline

Definition at line 57 of file oct-spparms.h.

~octave_sparse_params()

octave_sparse_params::~octave_sparse_params ( void  )

default

Member Function Documentation

cleanup_instance()

static void octave_sparse_params::cleanup_instance ( void  )

inlinestaticprivate

Definition at line 101 of file oct-spparms.h.

Referenced by instance_ok().

defaults()

void octave_sparse_params::defaults ( void  )

static

Definition at line 55 of file oct-spparms.cc.

References do_defaults(), instance, and instance_ok().

Referenced by Fspparms().

do_defaults()

void octave_sparse_params::do_defaults ( void  )

private

Definition at line 113 of file oct-spparms.cc.

References params.

Referenced by defaults().

do_get_bandden()

double octave_sparse_params::do_get_bandden ( void  )

private

Definition at line 167 of file oct-spparms.cc.

References params.

Referenced by get_bandden().

do_get_key()

double octave_sparse_params::do_get_key ( const std::string &  key )

private

Definition at line 203 of file oct-spparms.cc.

References keys, NaN, OCTAVE_SPARSE_CONTROLS_SIZE, and params.

Referenced by get_key().

do_get_keys()

string_vector octave_sparse_params::do_get_keys ( void  ) const

inlineprivate

Definition at line 107 of file oct-spparms.h.

Referenced by get_keys().

do_get_vals()

ColumnVector octave_sparse_params::do_get_vals ( void  ) const

inlineprivate

Definition at line 109 of file oct-spparms.h.

Referenced by get_vals().

do_print_info()

void octave_sparse_params::do_print_info ( std::ostream &  os, const std::string &  prefix  ) const

private

Definition at line 215 of file oct-spparms.cc.

References keys, OCTAVE_SPARSE_CONTROLS_SIZE, and params.

Referenced by print_info().

do_set_key()

bool octave_sparse_params::do_set_key ( const std::string &  key, const double &  val  )

private

Definition at line 188 of file oct-spparms.cc.

References keys, OCTAVE_SPARSE_CONTROLS_SIZE, and params.

Referenced by set_key().

do_set_vals()

bool octave_sparse_params::do_set_vals ( const NDArray &  vals )

private

Definition at line 173 of file oct-spparms.cc.

References len, Array< T >::numel(), OCTAVE_SPARSE_CONTROLS_SIZE, and params.

Referenced by set_vals().

do_tight()

void octave_sparse_params::do_tight ( void  )

private

Definition at line 131 of file oct-spparms.cc.

References params.

Referenced by tight().

get_bandden()

double octave_sparse_params::get_bandden ( void  )

static

Definition at line 100 of file oct-spparms.cc.

References do_get_bandden(), instance, and instance_ok().

Referenced by MatrixType::MatrixType(), and MatrixType::type().

get_key()

double octave_sparse_params::get_key ( const std::string &  key )

static

Definition at line 93 of file oct-spparms.cc.

References do_get_key(), instance, instance_ok(), and NaN.

Referenced by MatrixType::MatrixType(), octave::math::sparse_lu< lu_type >::sparse_lu(), SparseComplexMatrix::determinant(), SparseMatrix::determinant(), SparseComplexMatrix::factorize(), SparseMatrix::factorize(), SparseComplexMatrix::fsolve(), SparseMatrix::fsolve(), Fspparms(), Fsymbfact(), MatrixType::info(), octave::math::sparse_chol< chol_type >::sparse_chol_rep< chol_type >::init(), and MatrixType::type().

get_keys()

string_vector octave_sparse_params::get_keys ( void  )

static

Definition at line 69 of file oct-spparms.cc.

References do_get_keys(), instance, and instance_ok().

Referenced by Fspparms().

get_vals()

ColumnVector octave_sparse_params::get_vals ( void  )

static

Definition at line 75 of file oct-spparms.cc.

References do_get_vals(), instance, and instance_ok().

Referenced by Fspparms().

init_keys()

void octave_sparse_params::init_keys ( void  )

private

Definition at line 149 of file oct-spparms.cc.

References keys.

instance_ok()

bool octave_sparse_params::instance_ok ( void  )

static

Definition at line 41 of file oct-spparms.cc.

References octave_sparse_params(), singleton_cleanup_list::add(), cleanup_instance(), instance, and retval.

Referenced by defaults(), get_bandden(), get_key(), get_keys(), get_vals(), print_info(), set_key(), set_vals(), and tight().

operator=()

octave_sparse_params& octave_sparse_params::operator= ( const octave_sparse_params &  a )

inline

Definition at line 60 of file oct-spparms.h.

References keys, and params.

print_info()

void octave_sparse_params::print_info ( std::ostream &  os, const std::string &  prefix  )

static

Definition at line 106 of file oct-spparms.cc.

References do_print_info(), instance, and instance_ok().

Referenced by Fspparms().

set_key()

bool octave_sparse_params::set_key ( const std::string &  key, const double &  val  )

static

Definition at line 87 of file oct-spparms.cc.

References do_set_key(), instance, and instance_ok().

Referenced by Fspparms().

set_vals()

bool octave_sparse_params::set_vals ( const NDArray &  vals )

static

Definition at line 81 of file oct-spparms.cc.

References do_set_vals(), instance, and instance_ok().

Referenced by Fspparms().

tight()

void octave_sparse_params::tight ( void  )

static

Definition at line 62 of file oct-spparms.cc.

References do_tight(), instance, and instance_ok().

Referenced by Fspparms().

Member Data Documentation

instance

octave_sparse_params * octave_sparse_params::instance = nullptr

staticprivate

Definition at line 99 of file oct-spparms.h.

Referenced by defaults(), get_bandden(), get_key(), get_keys(), get_vals(), instance_ok(), print_info(), set_key(), set_vals(), and tight().

keys

string_vector octave_sparse_params::keys

private

Definition at line 97 of file oct-spparms.h.

Referenced by do_get_key(), do_print_info(), do_set_key(), init_keys(), and operator=().

params

ColumnVector octave_sparse_params::params

private

Definition at line 95 of file oct-spparms.h.

Referenced by do_defaults(), do_get_bandden(), do_get_key(), do_print_info(), do_set_key(), do_set_vals(), do_tight(), and operator=().

---

The documentation for this class was generated from the following files:

• liboctave/numeric/oct-spparms.h
• liboctave/numeric/oct-spparms.cc