GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
LSODE_options Class Reference

#include "LSODE-opts.h"

Inheritance diagram for LSODE_options:
LSODE

Public Member Functions

 LSODE_options ()
 
 LSODE_options (const LSODE_options &opt)
 
 ~LSODE_options ()
 
Array< double > absolute_tolerance () const
 
void init ()
 
double initial_step_size () const
 
std::string integration_method () const
 
std::string jacobian_type () const
 
octave_idx_type lower_jacobian_subdiagonals () const
 
octave_idx_type maximum_order () const
 
double maximum_step_size () const
 
double minimum_step_size () const
 
LSODE_optionsoperator= (const LSODE_options &opt)
 
double relative_tolerance () const
 
void set_absolute_tolerance (const Array< double > &val)
 
void set_absolute_tolerance (double val)
 
void set_default_options ()
 
void set_initial_step_size (double val)
 
void set_integration_method (const std::string &val)
 
void set_jacobian_type (const std::string &val)
 
void set_lower_jacobian_subdiagonals (octave_idx_type val)
 
void set_maximum_order (octave_idx_type val)
 
void set_maximum_step_size (double val)
 
void set_minimum_step_size (double val)
 
void set_options (const LSODE_options &opt)
 
void set_relative_tolerance (double val)
 
void set_step_limit (octave_idx_type val)
 
void set_upper_jacobian_subdiagonals (octave_idx_type val)
 
octave_idx_type step_limit () const
 
octave_idx_type upper_jacobian_subdiagonals () const
 

Protected Attributes

bool m_reset
 

Detailed Description

Definition at line 14 of file LSODE-opts.h.

Constructor & Destructor Documentation

◆ LSODE_options() [1/2]

LSODE_options::LSODE_options ( )
inline

Definition at line 19 of file LSODE-opts.h.

◆ LSODE_options() [2/2]

LSODE_options::LSODE_options ( const LSODE_options opt)
inline

Definition at line 36 of file LSODE-opts.h.

◆ ~LSODE_options()

LSODE_options::~LSODE_options ( )
inline

Definition at line 72 of file LSODE-opts.h.

Member Function Documentation

◆ absolute_tolerance()

Array<double> LSODE_options::absolute_tolerance ( ) const
inline

Definition at line 164 of file LSODE-opts.h.

◆ init()

void LSODE_options::init ( )
inline

Definition at line 74 of file LSODE-opts.h.

◆ initial_step_size()

double LSODE_options::initial_step_size ( ) const
inline

Definition at line 173 of file LSODE-opts.h.

◆ integration_method()

std::string LSODE_options::integration_method ( ) const
inline

Definition at line 170 of file LSODE-opts.h.

◆ jacobian_type()

std::string LSODE_options::jacobian_type ( ) const
inline

Definition at line 188 of file LSODE-opts.h.

◆ lower_jacobian_subdiagonals()

octave_idx_type LSODE_options::lower_jacobian_subdiagonals ( ) const
inline

Definition at line 191 of file LSODE-opts.h.

◆ maximum_order()

octave_idx_type LSODE_options::maximum_order ( ) const
inline

Definition at line 176 of file LSODE-opts.h.

◆ maximum_step_size()

double LSODE_options::maximum_step_size ( ) const
inline

Definition at line 179 of file LSODE-opts.h.

◆ minimum_step_size()

double LSODE_options::minimum_step_size ( ) const
inline

Definition at line 182 of file LSODE-opts.h.

◆ operator=()

LSODE_options& LSODE_options::operator= ( const LSODE_options opt)
inline

Definition at line 51 of file LSODE-opts.h.

References m_reset.

◆ relative_tolerance()

double LSODE_options::relative_tolerance ( ) const
inline

Definition at line 167 of file LSODE-opts.h.

◆ set_absolute_tolerance() [1/2]

void LSODE_options::set_absolute_tolerance ( const Array< double > &  val)
inline

Definition at line 116 of file LSODE-opts.h.

◆ set_absolute_tolerance() [2/2]

void LSODE_options::set_absolute_tolerance ( double  val)
inline

Definition at line 109 of file LSODE-opts.h.

◆ set_default_options()

void LSODE_options::set_default_options ( )
inline

Definition at line 107 of file LSODE-opts.h.

◆ set_initial_step_size()

void LSODE_options::set_initial_step_size ( double  val)
inline

Definition at line 134 of file LSODE-opts.h.

◆ set_integration_method()

void LSODE_options::set_integration_method ( const std::string &  val)
inline

Definition at line 122 of file LSODE-opts.h.

References current_liboctave_error_handler.

◆ set_jacobian_type()

void LSODE_options::set_jacobian_type ( const std::string &  val)
inline

Definition at line 149 of file LSODE-opts.h.

References current_liboctave_error_handler.

◆ set_lower_jacobian_subdiagonals()

void LSODE_options::set_lower_jacobian_subdiagonals ( octave_idx_type  val)
inline

Definition at line 159 of file LSODE-opts.h.

◆ set_maximum_order()

void LSODE_options::set_maximum_order ( octave_idx_type  val)
inline

Definition at line 137 of file LSODE-opts.h.

◆ set_maximum_step_size()

void LSODE_options::set_maximum_step_size ( double  val)
inline

Definition at line 140 of file LSODE-opts.h.

◆ set_minimum_step_size()

void LSODE_options::set_minimum_step_size ( double  val)
inline

Definition at line 143 of file LSODE-opts.h.

◆ set_options()

void LSODE_options::set_options ( const LSODE_options opt)
inline

Definition at line 91 of file LSODE-opts.h.

References m_reset.

◆ set_relative_tolerance()

void LSODE_options::set_relative_tolerance ( double  val)
inline

Definition at line 119 of file LSODE-opts.h.

◆ set_step_limit()

void LSODE_options::set_step_limit ( octave_idx_type  val)
inline

Definition at line 146 of file LSODE-opts.h.

◆ set_upper_jacobian_subdiagonals()

void LSODE_options::set_upper_jacobian_subdiagonals ( octave_idx_type  val)
inline

Definition at line 162 of file LSODE-opts.h.

◆ step_limit()

octave_idx_type LSODE_options::step_limit ( ) const
inline

Definition at line 185 of file LSODE-opts.h.

◆ upper_jacobian_subdiagonals()

octave_idx_type LSODE_options::upper_jacobian_subdiagonals ( ) const
inline

Definition at line 194 of file LSODE-opts.h.

Member Data Documentation

◆ m_reset

bool LSODE_options::m_reset
protected

Definition at line 213 of file LSODE-opts.h.

Referenced by operator=(), and set_options().


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