psc::TsDispersionResidual Class Reference

#include <psc_ts_dispersion_residual.hpp>

Inheritance diagram for psc::TsDispersionResidual:

Classes
struct	Params
struct	TsCurveParams
struct	TsCurveResult

Public Member Functions
	TsDispersionResidual (TsContainer &ts_container, const Params &params=Params())
virtual	~TsDispersionResidual ()
Params &	params ()
const Params &	params () const
TsContainer &	tsContainer ()
const TsContainer &	tsContainer () const
Public Member Functions inherited from AbstractResidual
double	operator() (const std::vector< double > &x) const

Protected Member Functions
virtual double	calc (const std::vector< double > &dt_vec) const
bool	get_ts_curve (const TsCurveParams &cp, TsCurveResult &cr) const
bool	get_ids_range (const int id, const int base_size, const std::pair< int, int > &full_ids_range, std::pair< int, int > &ids_range) const
virtual void	progress (const int cur, const int max) const

Protected Attributes
Params	m_params
TsContainer *	mp_ts_container

Detailed Description

Residual of dispersion

Constructor & Destructor Documentation

psc::TsDispersionResidual::TsDispersionResidual	(	TsContainer &	ts_container,
		const Params &	params = Params()
	)

Constructor with time shifts container and parameters provided.

virtual psc::TsDispersionResidual::~TsDispersionResidual ( )

virtual

Destructor.

Member Function Documentation

virtual double psc::TsDispersionResidual::calc ( const std::vector< double > &  dt_vec ) const

protectedvirtual

Calculates residual. dt_vec[0] - time shift.

Implements AbstractResidual.

bool psc::TsDispersionResidual::get_ts_curve ( const TsCurveParams &  cp, TsCurveResult &  cr  ) const

protected

Get time shifts curve for provided range of indexies.

Params& psc::TsDispersionResidual::params ( )

inline

Access to residual calculation parameters.

const Params& psc::TsDispersionResidual::params ( ) const

inline

Read only access to residual calculation parameters.

virtual void psc::TsDispersionResidual::progress ( const int  cur, const int  max  ) const

protectedvirtual

Progress of computation, can be reimplemented.

TsContainer& psc::TsDispersionResidual::tsContainer ( )

inline

Access to time shifts container.

const TsContainer& psc::TsDispersionResidual::tsContainer ( ) const

inline

Read only access to time shifts container.

Member Data Documentation

Params psc::TsDispersionResidual::m_params

protected

Time shifts container pointer.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/s2proc/psc_ts_dispersion_residual.hpp