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

#include "DAERTFunc.h"

Inheritance diagram for DAERTFunc:
Collaboration diagram for DAERTFunc:

Public Types

typedef Matrix(* DAEJacFunc) (const ColumnVector &x, const ColumnVector &xdot, double t, double cj)
 
typedef ColumnVector(* DAERHSFunc) (const ColumnVector &x, const ColumnVector &xdot, double t, octave_idx_type &ires)
 
typedef ColumnVector(* DAERTConstrFunc) (const ColumnVector &x, double t)
 

Public Member Functions

 DAERTFunc (const DAERTFunc &a)
 
 DAERTFunc (DAERHSFunc f)
 
 DAERTFunc (DAERHSFunc f, DAEJacFunc j)
 
 DAERTFunc (DAERHSFunc f, DAERTConstrFunc cf)
 
 DAERTFunc (DAERHSFunc f, DAERTConstrFunc cf, DAEJacFunc j)
 
 DAERTFunc (void)
 
virtual ~DAERTFunc (void)=default
 
DAERTConstrFunc constraint_function (void) const
 
DAERHSFunc function (void) const
 
DAEJacFunc jacobian_function (void) const
 
DAERTFuncoperator= (const DAERTFunc &a)
 
DAERTFuncset_constraint_function (DAERTConstrFunc cf)
 
DAEFuncset_function (DAERHSFunc f)
 
DAEFuncset_jacobian_function (DAEJacFunc j)
 

Protected Attributes

DAERTConstrFunc m_constr
 
DAERHSFunc m_fcn
 
DAEJacFunc m_jac
 
bool m_reset
 

Detailed Description

Definition at line 33 of file DAERTFunc.h.

Member Typedef Documentation

◆ DAEJacFunc

typedef Matrix(* DAEFunc::DAEJacFunc) (const ColumnVector &x, const ColumnVector &xdot, double t, double cj)
inherited

Definition at line 46 of file DAEFunc.h.

◆ DAERHSFunc

typedef ColumnVector(* DAEFunc::DAERHSFunc) (const ColumnVector &x, const ColumnVector &xdot, double t, octave_idx_type &ires)
inherited

Definition at line 38 of file DAEFunc.h.

◆ DAERTConstrFunc

typedef ColumnVector(* DAERTFunc::DAERTConstrFunc) (const ColumnVector &x, double t)

Definition at line 38 of file DAERTFunc.h.

Constructor & Destructor Documentation

◆ DAERTFunc() [1/6]

DAERTFunc::DAERTFunc ( void  )
inline

Definition at line 40 of file DAERTFunc.h.

◆ DAERTFunc() [2/6]

DAERTFunc::DAERTFunc ( DAERHSFunc  f)
inline

Definition at line 43 of file DAERTFunc.h.

◆ DAERTFunc() [3/6]

DAERTFunc::DAERTFunc ( DAERHSFunc  f,
DAEJacFunc  j 
)
inline

Definition at line 46 of file DAERTFunc.h.

◆ DAERTFunc() [4/6]

DAERTFunc::DAERTFunc ( DAERHSFunc  f,
DAERTConstrFunc  cf 
)
inline

Definition at line 49 of file DAERTFunc.h.

◆ DAERTFunc() [5/6]

DAERTFunc::DAERTFunc ( DAERHSFunc  f,
DAERTConstrFunc  cf,
DAEJacFunc  j 
)
inline

Definition at line 52 of file DAERTFunc.h.

◆ DAERTFunc() [6/6]

DAERTFunc::DAERTFunc ( const DAERTFunc a)
inline

Definition at line 55 of file DAERTFunc.h.

◆ ~DAERTFunc()

virtual DAERTFunc::~DAERTFunc ( void  )
virtualdefault

Member Function Documentation

◆ constraint_function()

DAERTConstrFunc DAERTFunc::constraint_function ( void  ) const
inline

Definition at line 71 of file DAERTFunc.h.

Referenced by DASRT::integrate().

◆ function()

DAERHSFunc DAEFunc::function ( void  ) const
inlineinherited

Definition at line 75 of file DAEFunc.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), and DASRT::integrate().

◆ jacobian_function()

DAEJacFunc DAEFunc::jacobian_function ( void  ) const
inlineinherited

Definition at line 84 of file DAEFunc.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), and DASRT::integrate().

◆ operator=()

DAERTFunc& DAERTFunc::operator= ( const DAERTFunc a)
inline

Definition at line 58 of file DAERTFunc.h.

References m_constr, m_reset, and DAEFunc::operator=().

Referenced by DAERT::operator=().

◆ set_constraint_function()

DAERTFunc& DAERTFunc::set_constraint_function ( DAERTConstrFunc  cf)
inline

Definition at line 73 of file DAERTFunc.h.

Referenced by DEFMETHOD().

◆ set_function()

DAEFunc& DAEFunc::set_function ( DAERHSFunc  f)
inlineinherited

Definition at line 77 of file DAEFunc.h.

References f.

◆ set_jacobian_function()

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc  j)
inlineinherited

Definition at line 86 of file DAEFunc.h.

Referenced by DEFMETHOD().

Member Data Documentation

◆ m_constr

DAERTConstrFunc DAERTFunc::m_constr
protected

Definition at line 82 of file DAERTFunc.h.

Referenced by operator=().

◆ m_fcn

DAERHSFunc DAEFunc::m_fcn
protectedinherited

Definition at line 95 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ m_jac

DAEJacFunc DAEFunc::m_jac
protectedinherited

Definition at line 96 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ m_reset

bool DAERTFunc::m_reset
protected

Definition at line 89 of file DAERTFunc.h.

Referenced by DASRT::integrate(), and operator=().


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